RunState Subproperties

TestStand 2019 Help

Edition Date: May 2019

Part Number: 370052AA-01

»View Product Info
Download Help (Windows Only)

The RunState property object contains properties that describe the state of execution in the sequence invocation.

Sequence Context Subproperty Description
Engine Engine object in which the sequence invocation executes.
Root Sequence context for the root sequence invocation. When you initiate an execution using a process model entry point, the property is the sequence context for the entry point. For example, when you use an entry point from the default TestStand process model, the Root property is the sequence context of the Test UUTs or the Single Pass sequence. When you initiate an execution on a sequence without using a Process Model entry point, the Root property object is the sequence context for the sequence you run.
Main Sequence context for the least-nested sequence that is not in a process model. When you initiate an execution using the default process model entry point, the Main property is the sequence context of the Main sequence. When you initiate an execution on a sequence without using a process model entry point, the Main property object is the sequence context for whichever sequence you run.
ThisContext Reference to the current sequence context. You usually use this property to pass the entire sequence context as an argument to another sequence or a code module.
Caller Sequence context for the sequence that called the current sequence. This property does not exist in the root sequence context.
CallingStep Run-time copy of the Step object for the step that called the current sequence. This property does not exist in the root sequence context. Any changes to property values in this object only modify the execution version of the object.
InitialSelection Contains references to properties, steps, sequences, sequence files, and executions that are selected or active when you start an execution. When the Sequence File window is active, the InitialSelection property contains non-execution versions of the selected objects. When an Execution window is active, the InitialSelection property contains execution versions of the selected steps, properties, and sequences as well as non-execution versions of the selected sequence file.

You usually use this property in custom Tools menu commands to operate on the selected objects in a sequence file.

Note  Whenever you make changes to subproperty values in non-execution versions of a PropertyObject, Step, Sequence, or SequenceFile object the InitialSelection property contains, you modify the non-execution version of the object. TestStand saves the modifications when you save the selected sequence file. Whenever you modify the selected file or the objects it contains from a code module, you must increment the SelectedFile.ChangeCount subproperty of InitialSelection.
Report Report object for the execution.
Execution Execution object in which the sequence invocation runs.
Thread Thread object in which the sequence invocation executes.
TestSockets Container that holds the number of test sockets the user has configured to execute, as well as a test socket index unique to each test socket.
SequenceFile The SequenceFile object for the sequence invocation. Refer to SequenceFile Object Subproperties for the contents of the SequenceFile property.
Note  TestStand saves any changes you make to property values of a SequenceFile object when you save the sequence file.
Sequence Run-time copy of the Sequence object for the sequence invocation. The Sequence object contains the parameters, local variables, and steps for the sequence. Any changes you make to property values in this object only modify the execution version of the object. Refer to Sequence Object Subproperties for the contents of the Sequence property.
Note  Built-in properties of sequences are flagged to be shared at run time. Changes to built-in properties within the run-time copy of the sequence also edit the original Sequence object in the sequence file.
PreviousStep Run-time copy of the Step object for the previously executed step in the sequence invocation. The property exists only after the first step in a step group executes. Changes to property values in this object only modify the execution version of the object.
Note  Built-in properties of steps are flagged to be shared at run time. Changes to built-in properties within the run-time copy of the step also edit the original Step object in the sequence file.
Step Run-time copy of the Step object for the currently executing step. This property does not exist when the execution pauses between steps, for example, at a breakpoint. Changes to property values in this object only modify the execution version of the object.
Note  Built-in properties of steps are flagged to be shared at run time. Changes to built-in properties within the run-time copy of the step also edit the original Step object in the sequence file.
NextStep Run-time copy of the Step object for the step that follows the currently executing step in the sequence. This property does not exist during and after the execution of the last step in a sequence step group. Changes to property values in this object only modify the execution version of the object.
Note  Built-in properties of steps are flagged to be shared at run time. Changes to built-in properties within the run-time copy of the step also edit the original Step object in the sequence file.
SequenceError Container that holds the error code, message, and occurred flag to report to the step that calls the sequence.
ErrorReported Indicates whether TestStand sent a BREAK ON RTE message to the user interface for the error the SequenceError property stores. Typically, a user interface launches a Run-Time Error dialog box when it receives a BREAK ON RTE message. When a sequence with an error returns, TestStand transfers the value of ErrorReported to the context of the calling sequence. This prevents the calling sequence from generating a duplicate BREAK ON RTE message for the error the subsequence returns.
IsProcessModel Indicates whether the sequence invocation is a sequence in the process model.
Tracing Indicates whether tracing is active for the sequence invocation.
SequenceFailed Indicates whether the current status of the sequence invocation is Failed.
Note Note  Setting this property to True causes the sequence to fail, but the execution does not go to the Cleanup step group when the sequence or the station options specify to immediately go to cleanup on sequence failure. Set the value of RunState.GotoCleanup to True to force a sequence to go to the Cleanup step group.
GotoCleanup Indicates whether the execution proceeds to the Cleanup step group after completing the currently executing step.
Note  Changes to property values in this object only modify the execution version of the object.
StepGroup Contains the name of the step group—Main, Setup, or Cleanup—the sequence invocation is executing. By modifying the value of this property, you can specify the step group TestStand executes next.
Note  Changes to property values in this object only modify the execution version of the object.
CallStackDepth Zero-based index of the currently executing sequence in the call stack. For example, when the call stack contains three sequence invocations, CallStackDepth is 2. The sequence call stack includes calls to process model sequences, including calls to entry points.
PreviousStepIndex Zero-based index of the previously executed step in the step group. TestStand sets the property value to -1 before executing the first step in a sequence step group.
Note  This property exists only for steps other than the first step of each step group.
StepIndex Zero-based index of the currently executing step in the step group. TestStand sets the property value to -1 when the execution is between steps, such as at a breakpoint.
NextStepIndex Zero-based index of the step that follows the currently executing step in the step group. TestStand sets the property value to -1 when executing the last step in a sequence step group. By modifying the value of this property, you can specify the step TestStand executes next.
Note  Changes you make to this property do not immediately affect the value of the RunState.NextStep property object.
LoopIndex Loop index for the active step in the sequence invocation. By default, steps you configure to loop use this property to store the loop index. The value of the loop index depends on the looping construct you choose to use for the step.
NumStepsExecuted Number of steps that executed in the sequence invocation.
LoopNumPassed Number of iterations a looping step completes with a status of Passed or Done.
LoopNumFailed Number of iterations a looping step completes with a status of Failed.
LoopNumIterations Number of iterations a looping step completes.
ProcessModelClient The SequenceFile object for the client sequence file of the process model. This property exists only for executions you initiate through a process model entry point.
Note  When you save the sequence file, TestStand saves any changes you make to property values in the SequenceFile object.
IsEditor Indicates whether the current graphical user interface (GUI) is a sequence editor.

See Also

InitialSelection Subproperties

Engine Class

Execution Class

Report Class

Run-Time Error dialog box

Sequence Class

Sequence Object Subproperties

SequenceFile Class

SequenceFile Object Subproperties

Step Class

Thread Class

WAS THIS ARTICLE HELPFUL?

Not Helpful