WaitForRoutingEventsCommand Object


Description:

Wait for routing events to complete.

Can be used with Command Sequencer: Yes

GUI Command Name: Routing: Wait For Routing Events

Parents: Sequencer, StcSystem

WaitForRoutingEventsCommand Writable Attributes

Attribute Description
Common Writable Attributes ProgressCancelled
PortList

List of port handles.

Type: handle

Default: 0

WaitMode

Type of wait mode.

Type: enum

Default: WAIT_FOR_ALL_ROUTING

Possible Values:

Value Description
WAIT_FOR_ALL_ROUTING

Wait for routing to complete.

WAIT_FOR_PORTS

Wait for ports to complete.

WaitTimeout

Max time to wait (in seconds) for command to complete.

Type: u32

Default: 30

WaitForRoutingEventsCommand Read-Only Attributes

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