FlapSetupCommand Object


Description:

Sets up a series of commands to flap in the sequencer.

Can be used with Command Sequencer: No

Parents: Sequencer, StcSystem

FlapSetupCommand Writable Attributes

Attribute Description
Common Writable Attributes ProgressCancelled
CreateSequence

Create the sequence.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Create the sequence.

FALSE

Do not create the sequence.

DevicesToFlap

Devices to flap up/flap down.

Type: handle

Default: 0

EnableWaitTimeout

Whether a Wait Event is added to the sequencer.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Enable wait timeout.

FALSE

Disable wait timeout.

FlapDownClassIdList

List of the flap down command class IDs.

Type: s32

Default: 0

FlapDownFirst

Enable flap devices down first.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Enable flap devices down first.

FALSE

Flap devices up first.

IterationCount

Number of iterations to flap up/down.

Type: u32

Default: 1

WaitFlapTimeout

Maximum time to wait for wait for flap up/down events to complete.

Type: s32

Default: 30

WaitForFlap

Enable wait for flap up/down to complete.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable wait for flap up/down to complete.

FALSE

Disable wait for flap up/down to complete.

WaitTimeout

Maximum time to wait for flap up/down events to complete.

Type: s32

Default: 30

FlapSetupCommand Read-Only Attributes

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

Root loop command handle.

Type: handle

Default: 0