ProtoTwin API
    Preparing search index...

    Class AwaitSignalSequenceOperation

    Await signal operation.

    Instructs the sequence to wait until the specified signal reports the specified value.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Accessors

    sequence signal timeout value

    Methods

    execute label

    Constructors

    Accessors

    • get sequence(): null | SequenceManager

      The sequence to which the operation has been assigned.

      Returns null | SequenceManager

      If the sequence is null then the operation hasn't been added to a program.

    • set sequence(value: null | SequenceManager): void

      Parameters

      • value: null | SequenceManager

      Returns void

    • get signal(): string

      The signal name.

      Returns string

    • set signal(value: string): void

      Parameters

      • value: string

      Returns void

    • get timeout(): number

      Wait timeout in seconds.

      Returns number

      The operation will complete if the timeout is exceeded, regardless of whether the value was seen. Set to zero to disable the timeout.

    • set timeout(value: number): void

      Parameters

      • value: number

      Returns void

    Methods

    • Executes the operation.

      Parameters

      • component: SequenceComponent

        The sequence component on which the operation is to be executed.

      Returns Future<any>

      The future that is resolved once the operation has been executed.

      This function is called by the sequence when it commands it to execute.

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods