Class TcoSequencerBase

Provides basic sequential control, including step mode, which allows to run the sequence step-by-step, steping forward and steping backward.

Inheritance
System.Object
TcoObject
TcoStateBase
TcoStateExtendible
TcoSequencerBase
TcoSequence
TcoSequencer
Implements
Vortex.Connector.Identity.IVortexIdentity
Vortex.Connector.IVortexObject
Vortex.Connector.ITwinObject
Vortex.Connector.IVortexElement
Vortex.Connector.IVortexOnlineObject
Vortex.Connector.IVortexShadowObject
Inherited Members
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: TcoCore
Assembly: TcoCoreConnector.dll
Syntax
[TypeMetaDescriptor("{attribute addProperty Name \"\" }", "TcoSequencerBase", "TcoCore", TypeComplexityEnum.Complex)]
public class TcoSequencerBase : TcoStateExtendible, IVortexIdentity, IsTcoObject, IVortexObject, ITwinObject, IVortexElement, ITcoSequencerBase, ITcoStateExtendible, ITcoStateBase, ITcoObject, IShadowTcoSequencerBase, IShadowTcoStateExtendible, IShadowTcoStateBase, IShadowTcoObject, IVortexOnlineObject, IVortexShadowObject

Constructors

| Improve this Doc View Source

TcoSequencerBase()

Declaration
public TcoSequencerBase()
| Improve this Doc View Source

TcoSequencerBase(IVortexObject, String, String)

Declaration
public TcoSequencerBase(IVortexObject parent, string readableTail, string symbolTail)
Parameters
Type Name Description
Vortex.Connector.IVortexObject parent
System.String readableTail
System.String symbolTail

Fields

| Improve this Doc View Source

__constMaxStepID

Declaration
public const short __constMaxStepID = 32766
Field Value
Type Description
System.Int16
| Improve this Doc View Source

__constMinStepID

Declaration
public const short __constMinStepID = -32767
Field Value
Type Description
System.Int16
| Improve this Doc View Source

__constRESTORE_STEP_ID

Declaration
public const short __constRESTORE_STEP_ID = 32766
Field Value
Type Description
System.Int16
| Improve this Doc View Source

__currentStep

Declaration
StepDetails __currentStep
Field Value
Type Description
StepDetails
| Improve this Doc View Source

__LastCycleTime

Declaration
OnlinerTime __LastCycleTime
Field Value
Type Description
Vortex.Connector.ValueTypes.OnlinerTime
| Improve this Doc View Source

__modeController

Declaration
TcoSequencerModeController __modeController
Field Value
Type Description
TcoSequencerModeController
| Improve this Doc View Source

__SequenceElapsedTime

Declaration
OnlinerTime __SequenceElapsedTime
Field Value
Type Description
Vortex.Connector.ValueTypes.OnlinerTime
| Improve this Doc View Source

__sequencerErrorId

Declaration
OnlinerInt __sequencerErrorId
Field Value
Type Description
Vortex.Connector.ValueTypes.OnlinerInt
| Improve this Doc View Source

__sequencerHasError

Declaration
OnlinerBool __sequencerHasError
Field Value
Type Description
Vortex.Connector.ValueTypes.OnlinerBool
| Improve this Doc View Source

__StepElapsedTime

Declaration
OnlinerTime __StepElapsedTime
Field Value
Type Description
Vortex.Connector.ValueTypes.OnlinerTime
| Improve this Doc View Source

_MaxStepID

Declaration
OnlinerInt _MaxStepID
Field Value
Type Description
Vortex.Connector.ValueTypes.OnlinerInt
| Improve this Doc View Source

_MinStepID

Declaration
OnlinerInt _MinStepID
Field Value
Type Description
Vortex.Connector.ValueTypes.OnlinerInt
| Improve this Doc View Source

_RESTORE_STEP_ID

Declaration
OnlinerInt _RESTORE_STEP_ID
Field Value
Type Description
Vortex.Connector.ValueTypes.OnlinerInt

Properties

| Improve this Doc View Source

_currentStep

Holds the status information about current step.

Declaration
public StepDetails _currentStep { get; }
Property Value
Type Description
StepDetails
Remarks

See StepDetails for detailed description.

| Improve this Doc View Source

_LastCycleTime

Total time of the last sequence cycle.

Declaration
public OnlinerTime _LastCycleTime { get; }
Property Value
Type Description
Vortex.Connector.ValueTypes.OnlinerTime
| Improve this Doc View Source

_modeController

Handles changing the sequencer mode (Cyclic, Step).

Declaration
public TcoSequencerModeController _modeController { get; }
Property Value
Type Description
TcoSequencerModeController
| Improve this Doc View Source

_SequenceElapsedTime

Elapsed time of presently running sequence cycle.

Declaration
public OnlinerTime _SequenceElapsedTime { get; }
Property Value
Type Description
Vortex.Connector.ValueTypes.OnlinerTime
| Improve this Doc View Source

_sequencerErrorId

Describes cause of the sequencer error.

Declaration
[ReadOnly]
[EnumeratorDiscriminator(typeof(eSequencerError))]
public OnlinerInt _sequencerErrorId { get; }
Property Value
Type Description
Vortex.Connector.ValueTypes.OnlinerInt
Remarks

See eSequencerError for detailed description.

| Improve this Doc View Source

_sequencerHasError

True if an error occurs in the sequence. Detailed cause of this error is described by the _sequencerErrorId.

Declaration
[ReadOnly]
public OnlinerBool _sequencerHasError { get; }
Property Value
Type Description
Vortex.Connector.ValueTypes.OnlinerBool
Remarks

See for detailed description.

| Improve this Doc View Source

_StepElapsedTime

Elapsed time of the currently executing step.

Declaration
public OnlinerTime _StepElapsedTime { get; }
Property Value
Type Description
Vortex.Connector.ValueTypes.OnlinerTime
| Improve this Doc View Source

MaxStepID

Declaration
public OnlinerInt MaxStepID { get; }
Property Value
Type Description
Vortex.Connector.ValueTypes.OnlinerInt
| Improve this Doc View Source

MinStepID

Declaration
public OnlinerInt MinStepID { get; }
Property Value
Type Description
Vortex.Connector.ValueTypes.OnlinerInt
| Improve this Doc View Source

RESTORE_STEP_ID

Declaration
public OnlinerInt RESTORE_STEP_ID { get; }
Property Value
Type Description
Vortex.Connector.ValueTypes.OnlinerInt

Methods

| Improve this Doc View Source

CopyPlainToShadow(PlainTcoSequencerBase)

Declaration
public void CopyPlainToShadow(PlainTcoSequencerBase source)
Parameters
Type Name Description
PlainTcoSequencerBase source
| Improve this Doc View Source

CreatePlainerType()

Declaration
public PlainTcoSequencerBase CreatePlainerType()
Returns
Type Description
PlainTcoSequencerBase
| Improve this Doc View Source

CreatePlainerType(PlainTcoSequencerBase)

Declaration
protected PlainTcoSequencerBase CreatePlainerType(PlainTcoSequencerBase cloned)
Parameters
Type Name Description
PlainTcoSequencerBase cloned
Returns
Type Description
PlainTcoSequencerBase
| Improve this Doc View Source

FlushOnlineToPlain(PlainTcoSequencerBase)

Declaration
public void FlushOnlineToPlain(PlainTcoSequencerBase source)
Parameters
Type Name Description
PlainTcoSequencerBase source
| Improve this Doc View Source

FlushOnlineToShadow()

Declaration
public void FlushOnlineToShadow()
| Improve this Doc View Source

FlushPlainToOnline(PlainTcoSequencerBase)

Declaration
public void FlushPlainToOnline(PlainTcoSequencerBase source)
Parameters
Type Name Description
PlainTcoSequencerBase source
| Improve this Doc View Source

FlushShadowToOnline()

Declaration
public void FlushShadowToOnline()
| Improve this Doc View Source

LazyOnlineToShadow()

Declaration
public void LazyOnlineToShadow()
| Improve this Doc View Source

LazyShadowToOnline()

Declaration
public void LazyShadowToOnline()
| Improve this Doc View Source

PexConstructor(IVortexObject, String, String)

Declaration
void PexConstructor(IVortexObject parent, string readableTail, string symbolTail)
Parameters
Type Name Description
Vortex.Connector.IVortexObject parent
System.String readableTail
System.String symbolTail
| Improve this Doc View Source

PexConstructorParameterless()

Declaration
void PexConstructorParameterless()
| Improve this Doc View Source

PexPreConstructor(IVortexObject, String, String)

Declaration
void PexPreConstructor(IVortexObject parent, string readableTail, string symbolTail)
Parameters
Type Name Description
Vortex.Connector.IVortexObject parent
System.String readableTail
System.String symbolTail
| Improve this Doc View Source

PexPreConstructorParameterless()

Declaration
void PexPreConstructorParameterless()

Explicit Interface Implementations

| Improve this Doc View Source

IShadowTcoSequencerBase._currentStep

Declaration
IShadowStepDetails IShadowTcoSequencerBase._currentStep { get; }
Returns
Type Description
IShadowStepDetails
| Improve this Doc View Source

IShadowTcoSequencerBase._LastCycleTime

Declaration
IShadowTime IShadowTcoSequencerBase._LastCycleTime { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Shadows.IShadowTime
| Improve this Doc View Source

IShadowTcoSequencerBase._modeController

Declaration
IShadowTcoSequencerModeController IShadowTcoSequencerBase._modeController { get; }
Returns
Type Description
IShadowTcoSequencerModeController
| Improve this Doc View Source

IShadowTcoSequencerBase._SequenceElapsedTime

Declaration
IShadowTime IShadowTcoSequencerBase._SequenceElapsedTime { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Shadows.IShadowTime
| Improve this Doc View Source

IShadowTcoSequencerBase._sequencerErrorId

Declaration
[ReadOnly]
[EnumeratorDiscriminator(typeof(eSequencerError))]
IShadowInt IShadowTcoSequencerBase._sequencerErrorId { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Shadows.IShadowInt
| Improve this Doc View Source

IShadowTcoSequencerBase._sequencerHasError

Declaration
[ReadOnly]
IShadowBool IShadowTcoSequencerBase._sequencerHasError { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Shadows.IShadowBool
| Improve this Doc View Source

IShadowTcoSequencerBase._StepElapsedTime

Declaration
IShadowTime IShadowTcoSequencerBase._StepElapsedTime { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Shadows.IShadowTime
| Improve this Doc View Source

ITcoSequencerBase._currentStep

Declaration
IStepDetails ITcoSequencerBase._currentStep { get; }
Returns
Type Description
IStepDetails
| Improve this Doc View Source

ITcoSequencerBase._LastCycleTime

Declaration
IOnlineTime ITcoSequencerBase._LastCycleTime { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Online.IOnlineTime
| Improve this Doc View Source

ITcoSequencerBase._modeController

Declaration
ITcoSequencerModeController ITcoSequencerBase._modeController { get; }
Returns
Type Description
ITcoSequencerModeController
| Improve this Doc View Source

ITcoSequencerBase._SequenceElapsedTime

Declaration
IOnlineTime ITcoSequencerBase._SequenceElapsedTime { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Online.IOnlineTime
| Improve this Doc View Source

ITcoSequencerBase._sequencerErrorId

Declaration
[ReadOnly]
[EnumeratorDiscriminator(typeof(eSequencerError))]
IOnlineInt ITcoSequencerBase._sequencerErrorId { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Online.IOnlineInt
| Improve this Doc View Source

ITcoSequencerBase._sequencerHasError

Declaration
[ReadOnly]
IOnlineBool ITcoSequencerBase._sequencerHasError { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Online.IOnlineBool
| Improve this Doc View Source

ITcoSequencerBase._StepElapsedTime

Declaration
IOnlineTime ITcoSequencerBase._StepElapsedTime { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Online.IOnlineTime

Implements

Vortex.Connector.Identity.IVortexIdentity
Vortex.Connector.IVortexObject
Vortex.Connector.ITwinObject
Vortex.Connector.IVortexElement
Vortex.Connector.IVortexOnlineObject
Vortex.Connector.IVortexShadowObject

See Also