Class TcoSequence

Inheritance

System.Object

TcoObject

TcoStateBase

TcoStateExtendible

TcoSequencerBase

TcoSequence

_internals_TcoSequence

Inherited Members

TcoSequencerBase.CheckStepId(Object, Object, Object)

TcoSequencerBase.i_Close()

TcoSequencerBase.i_CompleteSequence()

TcoSequencerBase.i_CompleteStep()

TcoSequencerBase.i_Open()

TcoSequencerBase.i_RequestStep(Object)

TcoSequencerBase.i_Step(Object, Object, Object)

TcoSequencerBase.i_StepCompleteWhen(Object)

TcoSequencerBase.IsStepIdUnique(Object)

TcoSequencerBase.OnlineChange()

TcoSequencerBase.OnRestore()

TcoSequencerBase.OnSequenceCompleted()

TcoSequencerBase.OnSequencerError(Object)

TcoSequencerBase.OnStepCompleted()

TcoSequencerBase.Restore()

TcoSequencerBase.StepChanged(Object)

TcoSequencerBase.StepInternal(Object, Object, Object)

TcoSequencerBase.CurrentStep

TcoSequencerBase.IsFreshState

TcoSequencerBase.ModeController

TcoSequencerBase.Observer

TcoSequencerBase.MinStepID

TcoSequencerBase.MaxStepID

TcoSequencerBase.RESTORE_STEP_ID

TcoSequencerBase._currentStep

TcoSequencerBase._sequencerHasError

TcoSequencerBase._sequencerErrorId

TcoSequencerBase._modeController

TcoSequencerBase._SequenceElapsedTime

TcoSequencerBase._StepElapsedTime

TcoSequencerBase._LastCycleTime

TcoSequencerBase._observer

TcoStateExtendible.OnStateChange(Object, Object)

TcoStateBase.AutoRestore()

TcoStateBase.ChangeStateProtected(Object)

TcoStateBase.CheckIfAutoRestoreEnabledByParent()

TcoStateBase.CheckIfCalledCyclically()

TcoStateBase.RestoreObject(Object)

TcoStateBase.AutoRestorable

TcoStateBase.Context

TcoStateBase.Identity

TcoStateBase.IsAutoRestoreEnabled

TcoStateBase.LastStateChangeCycle

TcoStateBase.State

TcoStateBase._State

TcoObject.EqualsTo(Object)

TcoObject.Messenger

TcoObject._Identity

TcoObject._messenger

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: PlcDocu.TcoCore

Assembly: TcoCoreConnector.dll

Syntax

public abstract class TcoSequence : TcoSequencerBase

Constructors

TcoSequence()

Prevents creating instance of this class via public constructor

Declaration

public TcoSequence()

Fields

_openingClosingErrorMessenger

Declaration

public TcoMessenger _openingClosingErrorMessenger

Field Value

Type	Description
TcoMessenger

Methods

Close()

In this TcoSequence implementation this method must be called after the last step of the sequence.

Declaration

[IgnoreReflection]
public void Close()

CompleteSequence()

Completes the sequencer, and return the sequencer pointer to the first step in the seuqence. Method is typically called inside the last step of the sequence.

Declaration

[IgnoreReflection]
public void CompleteSequence()

CompleteStep()

Completes the execution of the current step and moves the sequencer pointer to the next step in order of execution. The call returns ITcoObjectRestorer that allows to restore object upon step completition.

Declaration

[IgnoreReflection]
public dynamic CompleteStep()

Returns

Type	Description
System.Object

Main()

Main method of the sequener. Custom code needs to be placed here. The sequencer is executed by call of Instance.Run() method. This method is abstract, and it must be overridden in derived block.

Declaration

[IgnoreReflection]
protected dynamic Main()

Returns

Type	Description
System.Object	Plc type BOOL; Twin type: Vortex.Connector.ValueTypes.OnlinerBool

Open()

In this TcoSequence implementation this method must be called prior to first step call of the sequence.

Declaration

[IgnoreReflection]
public void Open()

RequestStep(Object)

Terminates the currently executed step and set the sequencer's pointer to the step with Id that corresponds to inRequestedStepID parameter. When the order of the requested step is higher than the order of the currently finished step (the requested step is "after" the current one) the requested step is started in the same context cycle. When the order of the requested step is lower than the order of the currently finished step (the requested step is "before" the current one) the requested step is started in the next context cycle. If the requested step is not found even in the next context cycle, the sequencer enters error state StepWithRequestedIdDoesNotExists.

See for detailed description.

Declaration

[IgnoreReflection]
public dynamic RequestStep(dynamic inRequestedStepID)

Parameters

Type	Name	Description
System.Object	inRequestedStepID	Plc type : INT [VAR_INPUT]; Twin type : Vortex.Connector.ValueTypes.OnlinerInt StepId of the step to be executed.

Returns

Type	Description
System.Object	Plc type ITcoSequencer; Twin type:

Run()

Ensures calling the Open(), Main() and Close() methods in the desired order. This method is final, so it cannot be overloaded. The **Instance.Run()** needs to be called cyclically inside the appropriate context.

Declaration

[IgnoreReflection]
public void Run()

StepCompleteWhen(Object)

Completes the actually running step, when the inCondition parameter is TRUE. Method is typically called inside a step as the transition method.

Declaration

[IgnoreReflection]
public void StepCompleteWhen(dynamic inCondition)

Parameters

Type	Name	Description
System.Object	inCondition	Plc type : BOOL [VAR_INPUT]; Twin type : Vortex.Connector.ValueTypes.OnlinerBool The condition under which the step is completed.