Description:
These attributes are repeated in many objects. Those objects link to this topic for descriptions of the common attributes.
| Attribute | Description | ||||||
|---|---|---|---|---|---|---|---|
| Active |
Determines whether this object will be active when you call the apply function. Type: bool Default: TRUE Possible Values:
|
||||||
| ErrorOnFailure |
Determines whether the command should error if it does not complete successfully. When a command errors, it causes the command sequencer to stop, or causes an exception to be thrown if the command is called in a script. Type: bool Default: FALSE Possible Values:
|
||||||
| Name |
A text name for the object. This attribute is required when you use stream block modifiers such as RangeModifier, RandomModifier, and TableModifier. See the description of the OffsetReference attribute for these modifier objects for more information. Type: string Default: "" (empty string) |
||||||
| ProgressCancelled |
Set this to TRUE to cancel the command. You can invoke this from a Cancel button in a progress bar dialog box that your script creates. The ProgressNnn attributes can be used to support and update a progress bar in a dialog box, if your script creates one. The progress bar can show the progress of the command as it executes. NOTE: Use the ProgressNnn attributes only when you use stc::perform to invoke the command. They do not work when you run a command with the sequencer. Type: bool Default: FALSE Possible Values:
|
| Read-Only Attribute | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ElapsedTime |
The command's elapsed time in milliseconds. Type: double Default: 0 |
||||||||||||||||||
| EndTime |
The time at which the command completed. EndTime minus StartTime gives the number of seconds elapsed for the command. Type: double Default: 0 |
||||||||||||||||||
| PassFailState |
Indicates how the command completed. Type: enum Default: NONE Possible Values:
|
||||||||||||||||||
| ProgressCurrentStep |
Contains the number of the step that the command is currently executing. Type: s32 Default: 1 |
||||||||||||||||||
| ProgressCurrentStepName |
The name of the step of the command that is currently being executed. If there is more than one step, there should be a different ProgressCurrentStepName value for each step, which you can display with the progress bar as the steps change. An example of command execution steps might be "Initializing", "Resolving addresses", and so on. See ProgressStepsCount below. Type: string Default: "" (empty string) |
||||||||||||||||||
| ProgressCurrentValue |
Indicates the progress of the command. By comparing this value to ProgressMaxValue you can get a percentage that your script can use to update a progress bar display. Type: s32 Default: 0 |
||||||||||||||||||
| ProgressDisplayCounter |
Whether the item counter should be displayed. If this is false then only the completion percentage will be displayed. Type: bool Default: TRUE Possible Values:
|
||||||||||||||||||
| ProgressMaxValue |
When the command has completed, this value is reached by the ProgressCurrentValue attribute. You can compare ProgressMaxValue to ProgressCurrentValue to get a percentage that your script can use update a progress bar display. Type: s32 Default: 0 |
||||||||||||||||||
| ProgressStepsCount |
The total number of steps in the execution of the command. If this value is more than 1, it can be used as in this example: Step 1 of 2: Initializing This is a string you might display above a progress bar. 1 is the value of the ProgressCurrentStep attribute. 2 is the value of ProgressStepsCount. Initializing is the value of ProgressCurrentStepName. Type: s32 Default: 1 |
||||||||||||||||||
| ResultState |
The state of the results Type: enum Default: NONE Possible Values:
|
||||||||||||||||||
| StartTime |
The time when the command started, expressed as the number of seconds since midnight GMT on 1/1/1970. Type: double Default: 0 |
||||||||||||||||||
| State |
The current state of the command Type: enum Default: INIT Possible Values:
|
||||||||||||||||||
| Status |
If there is an error, this will show what failed. Type: string Default: "" (empty string) |
||||||||||||||||||
| Successful |
Contains the handles of the objects that were in the correct state when the command completed. Type: handle Default: 0 |
||||||||||||||||||
| Unsuccessful |
Contains the handles of the objects that were not in the correct state when the command completed. Type: handle Default: 0 |