Program attributes
- Last UpdatedJul 20, 2024
- 4 minute read
The following table lists the Sequencer object attributes associated with the Sequencer program at run time:
|
Attribute |
Description |
Run-time 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 run time 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 attribute references that are mapped to the Sequencer Object Aliases. The array is in the same sequence as the Alias names array. |
Read-Only |
|
.PrgSeqConfig |
|
Supervisory, User |
|
.PrgSeqConfigCmd |
Set at run time 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 except that the data is coming from PrgSeqConfig attribute instead of a file. Run time: Performs configuration operations and reflects the result in the attribute PrgSeqConfigStatus. 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.
|
Read-Only |
|
.PrgSeqConfigStatus.Code |
Shows the result of the Save/Load/Update initiated by the PrgSeqConfigCmd Possible values:
|
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 run time or when reset. |
Read-Only |
|
.PrgStepInitialCmd |
Allows run-time modification of the initial step name. Run time: Replaces initial step name in the Sequencer step program attribute and updates
PrgStepInitial. |
Supervisory, User |
|
.PrgStepFinal |
Allows run-time modification of the final step name. |
Read-Only |
|
.PrgStepFinalCmd |
Allows run-time modification of the final step name. Run time: Replaces final step name in the Sequencer step program attribute and updates
PrgStepFinal. |
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 |