Program attributes

Attribute

Description

Runtime Access

.PrgAliasCnt

The total number of Aliases contained in the Sequencer program.

Read-Only

.PrgAliasNames

The string array list of the Sequencer Object Alias names.

Read-Only

.PrgComment

Stores an optional Sequencer program comment.

Read-Only

.PrgFileMatch

Set to False when the user has made a change to the program (step program, Alias configuration or settings) at runtime but the program has not been saved to a file. This flag is also set to False when loading an XML file that does not contain all 3 sections (step program, Alias configuration, settings) so that existing sections are preserved or when loading an XML file into sections that have locked attributes.

Read-Only

.PrgFileName

The file name and path of the most-recently (successfully) loaded or saved file name.

Read-Only

.PrgFileNameToLoadSave

Stores the file name that the user specifies for loading and saving.

Supervisory, User

.PrgName

Displays the optional Sequencer program name.

Read-Only

.PrgReferenceNames

The string array list of the attibute references that are mapped to the Sequencer Object Aliases. The array is in the same sequence as the Alias names array.

Read-Only

.PrgSeqConfig

1. Allows user to update PrgStepProgram, PrgAliasConfig or Settings or any combination of them by specifying the corresponding section in the XML data set to this attribute

2. The actual update takes place once PrgSeqConfigCmd is set to Update.

3. After Update is processed successfully, the value in the PrgSeqConfig is cleared.

Supervisory, User

.PrgSeqConfigCmd

Set at runtime to perform file IO or update the attribute PrgStepProgram, PrgAliasConfig or Settings or any combination of them. Feedback is provided by the PrgSeqConfigStatus attribute.

"Save" - save the Sequencer program XML configuration to the file which is specified in PrgFileNameToLoadSave (the filename from where it was loaded or where it was successfully saved to in a previous save as operation). This operation fails if PrgFileNameToLoadSave is empty or specifies an invalid or read only file.

"Load" - load the Sequencer XML data from the file specified in PrgFileNameToLoadSave. The Sequencer object loads whatever data is found in the XML file: Step Program data (steps and output values), Alias data (Alias names and attribute references) and Settings.

If any of these sections are missing, the corresponding currently active data section remains unchanged. This allows replacing individual sections only (like loading a step program without modifying the existing IO configuration).

"Update" - similar to Load except that the data is coming from the PrgSeqConfig attribute instead of a file.

Runtime: Performs configuration operations and reflects the result in the PrgSeqConfigStatus attribute. Rejects with an Operational Error any attempt to issue a PrgSeqConfigCmd while PrgSeqConfigStatus is other than Ready or Error.

Supervisory, User

.PrgSeqConfigStatus

Shows the result of the Save, Load or Update initiated by the PrgSeqConfigCmd.

• "Ready",

• "Error",

• "Loading",

• "Saving",

• "Updating",

Read-Only

.PrgSeqConfigStatus.Code

Shows the result of the Save/Load/Update initiated by the PrgSeqConfigCmd

Possible values:

• 0 - The action completed successfully, no problem was detected

• Severity 1000 (Warning) - reflects skipping update on some attributes due to lock during Load or Update

• Severity 2000 (Critical) - means error and the whole Load, Update or Save is rejected

Read-Only

.PrgSeqConfigStatus.Desc

Corresponds to PrgSeqConfigStatus.Code

Includes Step Name and Step # when relevant.

Includes Alias Name and # when relevant.

It is empty when PrgSeqConfigStatus.Code = 0

Read-Only

.PrgSeqConfigStatus.Error

Shows the result of the Save/Load/Update initiated by the PrgSeqConfigCmd

It is set to True when PrgSeqConfigStatus.Code>=2000

Read-Only

.PrgStepCnt

Shows the total number of steps contained in the Sequencer object.

Read-Only

.PrgStepInitial

Shows the starting step name of the Sequencer Object when deploying to runtime or when reset.

Read-Only

.PrgStepInitialCmd

Allows runtime modification of the initial step name.

Runtime: Replaces initial step name in the Sequencer step program attribute and updates PrgStepInitial.

The set is rejected with Operational error if PrgStepProgram attribute is locked.

Validates the string value. A valid initial step string value is either an empty string or any existing step name in the step program. If this initial step name is empty the Sequencer starts on the first step in the sequence.

Supervisory, User

.PrgStepFinal

Allows runtime modification of the final step name.

Read-Only

.PrgStepFinalCmd

Allows runtime modification of the final step name.

Runtime: Replaces final step name in the Sequencer step program attribute and updates PrgStepFinal.

The set is rejected with Operational error if PrgStepProgram attribute is locked.

Validates the string value. A valid final step string value is either an empty string or any existing step name in the step program.

Supervisory, User

.PrgStepNames

Shows the string array list of the Sequencer Object step names.

Read-Only

.ProgramError

TRUE: In case of an Program Error.

FALSE: No Program Error detected.

Read-Only

.ProgramErrorDesc

Description of the Program Error.

Read-Only