Build_Job Commands Reference

The following commands are supported in Build_Job, Click on any command for additional information.

DECLARE same as DEFINE
DEFINE for Build_Job a new module
DELETE an existing module
DICTIONARY specify a dictionary file
DROP same as DELETE
EXIT write output and end session
HELP online help command
LINK specify or add module(s) to the executable list
MODIFY an existing module definition
QUIT DO NOT write output and end session
REMOVE a module(s) from the executable list
SEQUENCE rearrange module link order
SET an attribute of Build_Job
SHOW current settings
USE same as LINK
WRITE output to specified file name

may be used to define a new Module for inclusion into the list of known Modules for this Build_Job session. All attributes of a Module (its entrypoints, histograms used etc.) may be specified by this Command. Having specified the Module Name and some attributes via Qualifiers, the Module Entrypoint Name Menu will be displayed (unless the /DECLARE Qualifier was specified) and you must setup the Module Entrypoint Names as desired. Note that an already existing Module may be modified using the MODIFY Command.

Format:

DEFINE[/Qualifiers] Module_Name[/Qualifiers]

Parameter:

Module_Name

Specifies the Name of the new Module to be defined. The Module Name may be up to 16 characters long by default. However if the then, within ANALYSIS_CONTROL the command

SPAWN <Module_Name>

will cause the ANALYSIS_CONTROL program to spawn a subprocess that executes the command "Text".

/STANDARD

The presence of this Qualifier indicates that the Module adheres to the standard naming conventions for Entrypoint Names, whereby each Entrypoint is derived automatically from the first two characters of the Module Name. Thus the Entrypoint Name Menu will be displayed with defaults based on the Module Name.

DELETE

deletes an existing Module or Modules. If the Module or Modules exist on the Executable List they will be removed from it.

Format:

DELETE Module_Name(s)

DELETE/Qualifiers

where either Module Names or Qualifiers may be specified, not both.

Parameter:

Module_Name(s)

Specifies the Name of the Module or Modules to be deleted. Multiple Module Names should be separated by spaces or commas. Module Names may be truncated as long as they remain unambiguous.

Qualifiers:

/ALL: Delete all existing Modules. All Module Families will also be deleted.
/FAMILY[=Name]: Indicates that all Modules in the specified Module Family should be deleted. This is the default Family if the Qualifier has no associated Value. The Family Name will also be deleted (except the default Family). Family Names may be truncated as long as they remain unambiguous.
/INPUT: Delete all Input Modules.
/BANK_SELECT: Delete all Bank Select Modules
/NORMAL: Delete all Normal (not Input, Bank Select or Output) Modules.
/OUTPUT: Delete all Output Modules.

DICTIONARY

specifies a new Module Dictionary containing the definitions of Modules or partial Build_Job sessions.

Format:

DICTIONARY Filename

Note that a Dictionary may be generated automatically from a Build_Job session by enabling "Learn" Mode with a response of the form:-

Build>{filename

where "filename" is the name of the file to be generated (default file type .UIC). This file will be closed automatically at the end of the Build_Job session, or by a response of the form:-

Build>}

Parameter:

Filename

Specifies the dictionary filename. On VAX/VMS systems the file name specification may contain logical names and the default file type is ".UIC" unless explicitly specified. On UNIX systems both VMS and UNIX formated file names are accepted however there are no defualt file types, so if you want to make your build_job command procedures machine independent it is best to always specify the extensions. For example:

DICT "C$DIC:LUMFLT_DICT.UIC"

is a machine independent specification. Whereas:

DICT "$C_DIC/lumbbc_dict.uic"

will be accepted on a UNIX machine but will not work on a VAX.

DROP

is a synonym of DELETE

EXIT

exits from Build_Job and builds any FORTRAN Code generated. Note that no code will be generated if the Executable List is empty. The Code will otherwise be written by default to file BUILD_JOB.CDF unless this default has been overridden by a prior SET FILENAME Command.

Format:

EXIT[/Qualifiers]

Qualifiers:

/[NO]CONTROL: Controls whether the Control Subprogram portion of the FORTRAN Source File is output. This portion contains the main setup Subprogram (ANSTUP) and the main Module Declaration Subprogram (ANMDEC). In the absence of this Qualifier, or if /CONTROL is specified, this portion will be written.
/[NO]MODULES: Controls whether the Module Subprograms portion of the FORTRAN Source File is output. This portion contains the individual Module Declaration Subprograms. In the absence of this Qualifier, or if /MODULES is specified, this portion will be written.
/[NO]OUTPUT: Controls whether the FORTRAN Source is Output. The presence of the /NOOUTPUT Qualifier overrides all other Qualifiers and will inhibit the generation of the Source File. EXIT/NOOUTPUT is thus equivalent to QUIT.

HELP

Help on a topic may be displayed by typing either of the following:-

       ?xxxx         or         Help xxxx

where "xxxx" is the desired topic. Following the Help Display you will be prompted for a new topic and (possibly) informed that there is more information available. Hitting RETURN just backs up one level in the Help tree (finally exitting), whereas Ctrl-Z exits Help completely without backing up the tree.

Additional Information on:

Type_Ahead
Indirect_Command_Files
Learning

Type_Ahead

In order to bypass the display of Menus, you may specify several responses in a single Command Line (separated by spaces). If an error is detected in such a Type Ahead, the remainder of the line is flushed and ignored. You will then be prompted to respond correctly to the Menu where the error was detected.

Indirect_Command_Files

A File of pre-built Operator responses is called an Indirect Command File. A Command File may be executed whilst BUILD_JOB is active by responding:-

@filename

where "filename" is the name of the file (which may be prefixed by a Directory specification in the normal manner). Your default directory is assumed by default if no Directory specification is given and File Type .UIC is also assumed by default.

Learning

An Indirect Command File may be built either by using an Editor, or by "learning" within BUILD_JOB. The response:-

{filename

will save all subsequent Operator responses in the specified file until a "}" response is received. Unless prefixed by a Directory specification the generated file will reside in your default directory. File Type .UIC will be assumed by default.

LINK

links a Module (or Modules) to the Executable List. Each Module is added to the end of the List such that, unless this Command is followed by a subsequent SEQUENCE Command in order to resequence the List, this Module will be the last on to the Executed of its Module Type (Input, Normal, Bank Select or Output).

Format:

LINK Module_Name(s)

LINK/Qualifiers

Parameter:

Module_Name(s)

Specifies the Name of the Module or Modules to be added to the Executable List. Multiple Module Names should be separated by spaces or commas. Module Names may be truncated as long as they remain unambiguous.

Qualifiers:

/ALL: Links all existing Modules to the Executable List.
/FAMILY[=Name]: Link all Modules in the specified Module Family to the Executable List. This is the default Family if the Qualifier has no associated Value.
/INPUT: Links all Input Modules to the Executable List.
/BANK_SELECT: Links all Bank Select Modules to the Executable List
/NORMAL: Links all all Normal (not Input, Bank Select or Output) to the Executable List.
/OUTPUT: Links all Output Modules to the Executable List.

MODIFY

may be used to modify the attributes of an already existing Module. All attributes of a Module (its entrypoints, histograms used etc.) may be modified by this Command. Having specified the Module Name and some attributes via Qualifiers, the Module Entrypoint Name Menu will be displayed (unless the /DECLARE Qualifier was specified) and you must setup the Module Entrypoint Names as desired.

Format:

MODIFY[/Qualifiers] Module_Name[/Qualifiers]

Parameter:

Module_Name

Specifies the Name of the existing Module to be modified. This may be truncated as long as it remains unambiguous.

Qualifiers:

Qualifiers for the MODIFY Command may be attached either to the Command or the Module_Name

/DECLARE[=Name]

The presence of this Qualifier indicates that the complete specification already exists in an ANALYSIS_CONTROL Declaration Subprogram. Thus no further information (such as Entrypoint Names etc.) need be declared and the Module Entrypoint Menu will be bypassed.

/DEFAULT_BANKS[=List]

The presence of this Qualifier indicates the default list of Banks that are associated with the Module. This default list may be overridden at program execution time. The Bank List should consist of concatenated 4-character Bank Names with no embedded spaces (e.g. LRIDEVCLCEMD) up to a maximum of 64 banks.

/DESCRIPTION[=Name]

Specifies an alternative Descriptive Name for the Module. Note that a Descriptive Name that contains embedded spaces should be enclosed in quotes (either single or double). The Descriptive Name defaults to null if this Qualifier is present but has no associated value.

/FAMILY[=Name]

Specifies the Module Family to which this Module belongs. This is the default family (spaces) if this Qualifier is present but has no associated value.

/FILTER

Specifies that the module is a filter module. This means that it produces TAGB banks that can be used by ANALYSIS_CONTROL to do event filtering and event selection.

/HELP[=Help filename]

Specifies the name of a UIPACK help file for the module. If in ANALYSIS_CONTROL the user types

HELP/MODULE <Module_Name>

the program will pick up this help file and display the text associated with the command HELP.

/HISTOGRAMS[=n:m]

Specifies the Lower and Upper Bounds on the Histograms booked by this Module. The Module is assumed to book no Histograms if this Qualifier is present but has no associated value.

/INPUT_MODULE

Identifies the Module as an Input Module.

/BANK_SELECT

Identifies the Module as a Bank Select Module

/OUTPUT_MODULE

Idenfifies the Module as an Output Module.

/PARAMETER_SET[=n]

Identifies the Module as having several different sets of adjustable Parameters associated with it.

/PRODUCE_BANKS[=List]

The presence of this Qualifier indicates that the Module produces several YBOS Banks which need to be added to the list of Banks to be output at the completion of the event analysis. The Bank List should consist of concatenated 4-character Bank Names with no enbedded spaces (e.g. LRIDEVCLCEMD) up to a maximum of 64 banks.

/REQUIRE_BANKS[=List]

The presence of this Qualifier indicates that the Module requires several YBOS Banks to be present in the event record in order for the Module to function correctly. The Bank List should consist of concatenated 4-character Bank Names with no enbedded spaces (e.g. LRIDEVCLCEMD) up to a maximum of 64 banks.

/SPAWN[=DCL command to be spawned]

The presence of this Qualifier indicates that the Module has associated with it a command line that can be spawned within ANALYSIS_CONTROL. If the user in BUILD_JOB types

DEFINE <Module_Name>/SPAWN="Text"

then, within ANALYSIS_CONTROL the command

SPAWN <Module_Name>

will cause the ANALYSIS_CONTROL program to spawn a subprocess that executes the command "Text".

/STANDARD

QUIT

exits from BUILD_JOB without forming any Source File. Thus QUIT is equivalent to EXIT/NOOUTPUT

REMOVE

removes an existing Module or Modules from the Executable List.

Format:

REMOVE Module_Name(s)

REMOVE/Qualifiers

where either Module Names or Qualifiers may be specified, not both.

Parameter:

Module_Name(s)

Specifies the Name of the Module or Modules to be removed. Multiple Module Names should be separated by spaces or commas. Module Names may be truncated as long as they remain unambiguous.

Qualifiers:

/ALL: Remove all existing Modules from the Executable List.
/FAMILY[=Name]: Indicates that all Modules in the specified Module Family should be removed from the Executable List. This is the default Family if the Qualifier has no associated Value. Family Names may be truncated as long as they remain unambiguous.
/INPUT: Remove all Input Modules from the Executable List.
/BANK_SELECT: Remove all Bank Select Modules from the Executable List.
/NORMAL: Remove all Normal (not Input, Bank Select or Output) Modules from the Executable List.
/OUTPUT: Remove all Output Modules from the Executable List.

SEQUENCE

overrides the default sequence of the Executable List. The specified Module (or Modules) will be placed at the head of the List (being removed from the body of the List if necessary). Note that the List comprises four distinct sections (Input, Normal Bank Select and Output) and that Input Modules will always precede Normal Modules which will always preceed Bank Select and Output Modules.

Format:

SEQUENCE Module_Name(s)

SEQUENCE/DEFAULT

where either Module Names or /DEFAULT may be specified, not both.

Parameter:

Module_Name(s)

Specifies the Name of the Module or Modules to be resequenced. Multiple Module Names should be separated by spaces or commas. Module Names may be truncated as long as they remain unambiguous.

Qualifiers:

/DEFAULT: Restores the default sequencing of the List (being the sequence with which Modules were defined).

SET

Sets an attribute of the Build_Job Program

Format:

SET Attribute_Name

Parameters:

Attribute_Name

may be one of the following:

BANKS maximum number of bank names
DEFAULTS define different default array sizes
FILENAME change default output file name
NAMES set new maximum name lengths
SIZES define size of utility YBOS arrays
UTILITIES enable/disable possible utilities

BANKS

Sets new maximum allowed Ybos Bank Names for a subset of the available Utilities. This Command will be ignored unless AT LEAST one of the following Qualifiers is also specified.

Qualifiers:

/ANALYSIS_CONTROL[=Banks]: Sets up the maximum allowed Bank Names for the ANALYSIS_CONTROL Utility. Omitting the Qualifier Value will result in the current default being used. Banks are in INTEGER units.
/UIPACK[=Banks]: Sets up the maximum allowed Bank Names for the UIPACK Utility. Omitting the Qualifier Value will result in the current default being used. Banks are in INTEGER units.
/YBOS[=Banks]: Sets up the maximum allowed Bank Names for the Primary YBOS Array. Omitting the Qualifier Value will result in the current default being used. Banks are in INTEGER units.

DEFAULTS

Sets new defaults for Build_Job for the duration of the current session.

Format:

SET DEFAULTS Attribute[/Qualifiers]

Parameters:

Attribute defines what attribute should have the default overridden for the current Build_Job session. Valid attributes are:-

SIZES

Allows YBOS Array Sizes for standard Utilities to have have default sizes setup. Note: that this command will be ignored unless at least one Qualifier is attached to the SET DEFAULT SIZES Command.

Qualifiers:

/ANALYSIS_CONTROL[=Size]: Sets up the default YBOS Array Size for the ANALYSIS_CONTROL Utility. Omitting the Qualifier Value will result in the original Build_Job default being restored. Sizes are in INTEGER units.
/CALIBRATION[=Size]: Sets up the default YBOS Array Size for the Calibration Utility. Omitting the Qualifier Value will result in the original Build_Job default being restored. Sizes are in INTEGER units.
/UIPACK[=Size]: Sets up the default YBOS Array Size for the UIPACK Utility. Omitting the Qualifier Value will result in the original Build_Job default being restored. Sizes are in INTEGER units.
/YBOS[=Size]: Sets up the default Primary Array Size for YBOS (COMMON/BCS/). Omitting the Qualifier Value will result in the original Build_Job default being restored. Sizes are in INTEGER units.
/YHIST[=Size]: Sets up the default YBOS Array Size for the YHIST Utility (COMMON/HBCS/). Omitting the Qualifier Value will result in the original Build_Job default being restored. Sizes are in INTEGER units.
/HBOOK[=Size]: Sets up the default Blank COMMON Array Size for the HBOOK Utility. Omitting the Qualifier Value will result in the original Build_Job default being restored. Sizes are in INTEGER units.
/HBK4[=Size]: Sets up the default PAWC COMMON Array Size for the HBK4 Utility. Omitting the Qualifier Value will result in the original Build_Job default being restored. Sizes are in INTEGER units. If you use a PAWC global section, you must declare a size which is multiple 2048 for Alpha VMS machines and multiple of 128 for Vaxes. For more details, see the help on the "SET UTILITIES" command.

FILENAME

Sets up a new Output Filename for the EXIT Command. This filename is initialised by default to BUILD_JOB.CDF and may be modified through use of this Command.

Format:

SET FILENAME Filename

SET FILENAME/DEFAULT

Parameter:

Filename

specifies a new Filename to override that presently setup. On VMS systems the file type will default to .CDF unless explicitly specified. On UNIX systems the file type must be specified and the file name should be enclosed in "" to preserve case.

Qualifiers:

/DEFAULT: Restores the Output Filename to its original default (BUILD_JOB.CDF)

NAMES

Sets new maximum lengths for Module and Entrypoint Names.

Format:

SET NAMES[/Qualifiers]

where AT LEAST one Qualifier must be specified (or the Command will be ignored).

Qualifiers:

/DEFAULTS: Set Name Lengths to their Default Values.
/ENTRYPOINTS[=Length]: Set the maximum allowed length of Entrypoint Names to the specified number of characters. This will default to 6 characters if no associated value is present, and may be set to a maximum of 32.
/MODULES[=Length]: Sets the maximum allowed length of Module Names to the specified number of characters. This will default to 16 characters if no associated value is present, and may be set to a maximum of 32.

SIZES

Setup new Utility YBOS Array Sizes. This Command will be ignored unless AT LEAST one of the following Qualifiers is also specified.

Qualifiers:

/ANALYSIS_CONTROL[=Size]: Sets up the YBOS Array Size for the ANALYSIS_CONTROL Utility. Omitting the Qualifier Value will result in the current default being used. Sizes are in INTEGER units.
/CALIBRATION[=Size]: Sets up the YBOS Array Size for the Calibration Utility. Omitting the Qualifier Value will result in the current default being used. Sizes are in INTEGER units.
/UIPACK[=Size]: Sets up the YBOS Array Size for the UIPACK Utility. Omitting the Qualifier Value will result in the current default being used. Sizes are in INTEGER units.
/YBOS[=Size]: Sets up the Primary Array Size for YBOS (COMMON/BCS/). Omitting the Qualifier Value will result in the current default being used. Sizes are in INTEGER units.
/YHIST[=Size]: Sets up the YBOS Array Size for the YHIST Utility (COMMON/HBCS/). Omitting the Qualifier Value will result in the current default being used. Sizes are in INTEGER units.
/HBOOK[=Size]: Sets up the Blank COMMON Array Size for the HBOOK Utility. Omitting the Qualifier Value will result in the current default being used. Sizes are in INTEGER units.
/HBK4[=Size]: Sets up the PAWC COMMON Array Size for the HBK4 Utility. Omitting the Qualifier Value will result in the current default being used. Sizes are in INTEGER units. If you use a PAWC global section, you must declare a size which is multiple 2048 for Alpha/VMS machines and multiple of 128 for Vaxes. For more details, see the help on the "SET UTILITY" command.

UTILITIES

Enable or Disable Utilities. This Command will be ignored unless AT LEAST one of the following Qualifiers is also specified.

Qualifiers:

/ANALYSIS_CONTROL[=OnOff]

Enables (On) or Disables (Off) the ANALYSIS_CONTROL Utility. This Command is included for consistency only since this Utility MAY NOT be disabled.

/CALIBRATION[=On Off Write]

Initialises (On) or Disables (Off) or intialises for write access (WRITE) the CALIBRATION Database.

This Utility is initially ON.

/GEOMETRY[=On Off Write]

Initialises (On) or Disables (Off) or intialises for write access (WRITE) the GEOMETRY Database.

This Utility is initially OFF.

/RUN_CONDITIONS[=On Off Write]

Initialises (On) or Disables (Off) or intialises for write access (WRITE) the RUN_CONDITIONS Database.

This Utility is initially OFF.

/HIST_DISPLAY[=On Off]

Initialises (On) or Disables (Off) the initialisation of YHIST graphics.

This Utility is initially OFF.

/UIPACK[=OnOff]

Enables (On) or Disables (Off) the UIPACK Utility. This Command is included for consistency only since this Utility MAY NOT be disabled.

/YBOS[=OnOff]

Enables (On) or Disables (Off) the YBOS Utility. This Command is included for consistency only since this Utility MAY NOT be disabled.

/YHIST[=OnOff]

Enables (On) or Disables (Off) the YHIST Utility. Note that YHIST and HBOOK are presently incompatible in the same job and should therefore be enabled simultaneously. Build_Job does not perform any checking to avoid this situation.

The YHIST Utility is initially Enabled.

/HBOOK[=OnOff]

Enables (On) or Disables (Off) the HBOOK Utility. Note that YHIST and HBOOK are presently incompatible in the same job and should therefore be enabled simultaneously. Build_Job does not perform any checking to avoid this situation.

The HBOOK Utility is initially Disabled.

/HBK4[=On Off Global_Section]

Enables (On) or Disables (Off) the HBK4 Utility. For VMS only machines it is also possible to specify the name of a global section. Such name cannot be longer than 4 characters. In this way, a PAW global section with the name specified will be automatically initialized by A_C.

NOTE: The "SET SIZE" command must be used to set the size of the global section which must be a multiple of 2048 for Alpha VMS machines, while for VAXes can be a multiple of 128. While linking the job, in your option file you must include the line "PSECT=PAWC,PAGE" to "page align" the common which is in the global section.

Warning: YHIST, HBOOK and HBK4 are presently incompatible in the same job and should therefore NOT be enabled simultaneously. Build_Job does not perform any checking to avoid this situation.

The HBK4 Utility is initially Disabled.

SHOW

shows (displays) some attribute of the Build_Job Program.

Format:

SHOW Attribute_Name

Parameters:

Attribute_Name

may be one of the following:

BANKS show maximum number of bank names
FAMILIES show module families
FILENAME show current output file name
LINKED show linked module order
MODULES show defined modules
NAMES show maximum name sizes
SIZES show utility array sizes
UTILITIES show enabled/disabled utilites

BANKS

Displays a list of all the Utilities together with the setup maximum Bank Names.

FAMILIES

Displays a list of all the presently defined Module Families.

FILENAME

Displays the Output Filename that will be written to by the EXIT Command.

LINKED

Displays the Modules in the Executable List. The sequence with which these Modules are displayed will be the same as the default execution sequence.

MODULES

Displays a list of all known Modules. This Command may also be used to display the information about a particular Module by using the syntax:-

SHOW MODULE/NAME=<Module_Name>

where <Module_Name> is the name of a currently defined Module.

NAMES

Displays the currently setup maximum allowed lengths (in characters) for Module and Entrypoint Names.

SIZES

Displays the Utility YBOS Array Sizes.

UTILITIES

Displays the known Utilities, whether they are Enabled or Disabled and the corresponding Array sizes.

USE

is a synonym for LINK

WRITE

causes the FORTRAN Code corresponding to the current Executable List to be written to the specified File.

Format:

WRITE[/Qualifier] Filename

Parameter:

Filename

is the name of the File to which Output is to be directed. On VMS systems the file type will default to .CDF unless explicitly specified. On UNIX systems the file type must be specified and the file name should be enclosed in "" to preserve case.

Qualifiers:

/[NO]CONTROL: Controls whether the Control Subprogram portion of the FORTRAN Source File is output. This portion contains the main setup Subprogram (ANSTUP) and the main Module Declaration Subprogram (ANMDEC). In the absence of this Qualifier, or if /CONTROL is specified, this portion will be written.
/[NO]MODULES: Controls whether the Module Subprograms portion of the FORTRAN Source File is output. This portion contains the individual Module Declaration Subprograms. In the absence of this Qualifier, or if /MODULES is specified, this portion will be written.