SequencerStopCommand Object


Description:

Stops the sequencer execution when the currently executing command has completed.

Can be used with Command Sequencer: Yes

GUI Command Name: Basic: Stop Command Sequencer

Parents: Sequencer, StcSystem

SequencerStopCommand Writable Attributes

Attribute Description
Common Writable Attributes ProgressCancelled
SequencerTestState

Sets the sequencer TestState property once the sequencer has been stopped.

Type: enum

Default: CHANGE_TO_PASSED

Possible Values:

Value Description
NO_CHANGE

Does not set the sequencer TestState property.

CHANGE_TO_PASSED

Sets the sequencer TestState property to PASSED.

CHANGE_TO_FAILED

Sets the sequencer TestState property to FAILED.

StoppedReason

Why the sequencer was stopped.

Type: string

Default: "" (empty string)

SequencerStopCommand Read-Only Attributes

Read-Only Attribute Description
Common Read-Only Attributes ElapsedTime, EndTime, ProgressCurrentStep, ProgressCurrentStepName, ProgressCurrentValue, ProgressDisplayCounter, ProgressMaxValue, ProgressStepsCount, StartTime, State, Status