Class StepDetails

Describes the status of a step of the sequencer.

Inheritance

System.Object

StepDetails

Implements

Vortex.Connector.IVortexObject

Vortex.Connector.ITwinObject

Vortex.Connector.IVortexElement

IStepDetails

IShadowStepDetails

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 \"\" }", "StepDetails", "TcoCore", TypeComplexityEnum.Complex)]
public class StepDetails : IVortexObject, ITwinObject, IVortexElement, IStepDetails, IShadowStepDetails, IVortexOnlineObject, IVortexShadowObject

Constructors

| Improve this Doc View Source

StepDetails()

Declaration

public StepDetails()

| Improve this Doc View Source

StepDetails(IVortexObject, String, String)

Declaration

public StepDetails(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

_Description

Declaration

OnlinerString _Description

Field Value

Type	Description
Vortex.Connector.ValueTypes.OnlinerString

| Improve this Doc View Source

_Duration

Declaration

OnlinerTime _Duration

Field Value

Type	Description
Vortex.Connector.ValueTypes.OnlinerTime

| Improve this Doc View Source

_Enabled

Declaration

OnlinerBool _Enabled

Field Value

Type	Description
Vortex.Connector.ValueTypes.OnlinerBool

| Improve this Doc View Source

_humanReadable

Declaration

protected string _humanReadable

Field Value

Type	Description
System.String

| Improve this Doc View Source

_ID

Declaration

OnlinerInt _ID

Field Value

Type	Description
Vortex.Connector.ValueTypes.OnlinerInt

| Improve this Doc View Source

_Order

Declaration

OnlinerUInt _Order

Field Value

Type	Description
Vortex.Connector.ValueTypes.OnlinerUInt

| Improve this Doc View Source

_Status

Declaration

OnlinerInt _Status

Field Value

Type	Description
Vortex.Connector.ValueTypes.OnlinerInt

Properties

| Improve this Doc View Source

_AttributeName

Declaration

string _AttributeName { }

Property Value

Type	Description
System.String

| Improve this Doc View Source

AttributeName

Declaration

public string AttributeName { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

Children

Declaration

List<IVortexObject> Children { }

Property Value

Type	Description
System.Collections.Generic.List<Vortex.Connector.IVortexObject>

| Improve this Doc View Source

Connector

Declaration

protected IConnector Connector { get; set; }

Property Value

Type	Description
Vortex.Connector.IConnector

| Improve this Doc View Source

Description

Step description text.

Declaration

public OnlinerString Description { get; }

Property Value

Type	Description
Vortex.Connector.ValueTypes.OnlinerString

| Improve this Doc View Source

Duration

Step duration time.

Declaration

public OnlinerTime Duration { get; }

Property Value

Type	Description
Vortex.Connector.ValueTypes.OnlinerTime

| Improve this Doc View Source

Enabled

If this value is false, step body is not executed and execution is moved to the next enabled step in the sequence.

Declaration

public OnlinerBool Enabled { get; }

Property Value

Type	Description
Vortex.Connector.ValueTypes.OnlinerBool

| Improve this Doc View Source

HumanReadable

Declaration

public string HumanReadable { get; protected set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

ID

Step identification number.

Declaration

public OnlinerInt ID { get; }

Property Value

Type	Description
Vortex.Connector.ValueTypes.OnlinerInt

Remarks

important

This number must be unique throughout the complete sequence. It is required to uniquely identify the step of the sequence.

The RequestStep(Object) method is using this number to jump to the required step.

| Improve this Doc View Source

Kids

Declaration

List<IVortexElement> Kids { }

Property Value

Type	Description
System.Collections.Generic.List<Vortex.Connector.IVortexElement>

| Improve this Doc View Source

Order

Order of the step in the sequence.

Declaration

public OnlinerUInt Order { get; }

Property Value

Type	Description
Vortex.Connector.ValueTypes.OnlinerUInt

| Improve this Doc View Source

Parent

Declaration

protected IVortexObject Parent { get; set; }

Property Value

Type	Description
Vortex.Connector.IVortexObject

| Improve this Doc View Source

Status

Describes step status.

Declaration

[EnumeratorDiscriminator(typeof(eStepStatus))]
public OnlinerInt Status { get; }

Property Value

Type	Description
Vortex.Connector.ValueTypes.OnlinerInt

Remarks

See eStepStatus for detailed description.

| Improve this Doc View Source

Symbol

Declaration

public string Symbol { get; protected set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

SymbolTail

Declaration

protected string SymbolTail { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

ValueTags

Declaration

List<IValueTag> ValueTags { }

Property Value

Type	Description
System.Collections.Generic.List<Vortex.Connector.IValueTag>

Methods

| Improve this Doc View Source

AddChild(IVortexObject)

Declaration

public void AddChild(IVortexObject vortexObject)

Parameters

Type	Name	Description
Vortex.Connector.IVortexObject	vortexObject

| Improve this Doc View Source

AddKid(IVortexElement)

Declaration

public void AddKid(IVortexElement vortexElement)

Parameters

Type	Name	Description
Vortex.Connector.IVortexElement	vortexElement

| Improve this Doc View Source

AddValueTag(IValueTag)

Declaration

public void AddValueTag(IValueTag valueTag)

Parameters

Type	Name	Description
Vortex.Connector.IValueTag	valueTag

| Improve this Doc View Source

CopyPlainToShadow(PlainStepDetails)

Declaration

public void CopyPlainToShadow(PlainStepDetails source)

Parameters

Type	Name	Description
PlainStepDetails	source

| Improve this Doc View Source

CreatePlainerType()

Declaration

public PlainStepDetails CreatePlainerType()

Returns

Type	Description
PlainStepDetails

| Improve this Doc View Source

CreatePlainerType(PlainStepDetails)

Declaration

protected PlainStepDetails CreatePlainerType(PlainStepDetails cloned)

Parameters

Type	Name	Description
PlainStepDetails	cloned

Returns

Type	Description
PlainStepDetails

| Improve this Doc View Source

FlushOnlineToPlain(PlainStepDetails)

Declaration

public void FlushOnlineToPlain(PlainStepDetails source)

Parameters

Type	Name	Description
PlainStepDetails	source

| Improve this Doc View Source

FlushOnlineToShadow()

Declaration

public void FlushOnlineToShadow()

| Improve this Doc View Source

FlushPlainToOnline(PlainStepDetails)

Declaration

public void FlushPlainToOnline(PlainStepDetails source)

Parameters

Type	Name	Description
PlainStepDetails	source

| Improve this Doc View Source

FlushShadowToOnline()

Declaration

public void FlushShadowToOnline()

| Improve this Doc View Source

GetChildren()

Declaration

public IEnumerable<IVortexObject> GetChildren()

Returns

Type	Description
System.Collections.Generic.IEnumerable<Vortex.Connector.IVortexObject>

| Improve this Doc View Source

GetConnector()

Declaration

public IConnector GetConnector()

Returns

Type	Description
Vortex.Connector.IConnector

| Improve this Doc View Source

GetKids()

Declaration

public IEnumerable<IVortexElement> GetKids()

Returns

Type	Description
System.Collections.Generic.IEnumerable<Vortex.Connector.IVortexElement>

| Improve this Doc View Source

GetParent()

Declaration

public IVortexObject GetParent()

Returns

Type	Description
Vortex.Connector.IVortexObject

| Improve this Doc View Source

GetSymbolTail()

Declaration

public string GetSymbolTail()

Returns

Type	Description
System.String

| Improve this Doc View Source

GetValueTags()

Declaration

public IEnumerable<IValueTag> GetValueTags()

Returns

Type	Description
System.Collections.Generic.IEnumerable<Vortex.Connector.IValueTag>

| 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

IShadowStepDetails.Description

Declaration

IShadowString IShadowStepDetails.Description { get; }

Returns

Type	Description
Vortex.Connector.ValueTypes.Shadows.IShadowString

| Improve this Doc View Source

IShadowStepDetails.Duration

Declaration

IShadowTime IShadowStepDetails.Duration { get; }

Returns

Type	Description
Vortex.Connector.ValueTypes.Shadows.IShadowTime

| Improve this Doc View Source

IShadowStepDetails.Enabled

Declaration

IShadowBool IShadowStepDetails.Enabled { get; }

Returns

Type	Description
Vortex.Connector.ValueTypes.Shadows.IShadowBool

| Improve this Doc View Source

IShadowStepDetails.ID

Declaration

IShadowInt IShadowStepDetails.ID { get; }

Returns

Type	Description
Vortex.Connector.ValueTypes.Shadows.IShadowInt

| Improve this Doc View Source

IShadowStepDetails.Order

Declaration

IShadowUInt IShadowStepDetails.Order { get; }

Returns

Type	Description
Vortex.Connector.ValueTypes.Shadows.IShadowUInt

| Improve this Doc View Source

IShadowStepDetails.Status

Declaration

[EnumeratorDiscriminator(typeof(eStepStatus))]
IShadowInt IShadowStepDetails.Status { get; }

Returns

Type	Description
Vortex.Connector.ValueTypes.Shadows.IShadowInt

| Improve this Doc View Source

IStepDetails.Description

Declaration

IOnlineString IStepDetails.Description { get; }

Returns

Type	Description
Vortex.Connector.ValueTypes.Online.IOnlineString

| Improve this Doc View Source

IStepDetails.Duration

Declaration

IOnlineTime IStepDetails.Duration { get; }

Returns

Type	Description
Vortex.Connector.ValueTypes.Online.IOnlineTime

| Improve this Doc View Source

IStepDetails.Enabled

Declaration

IOnlineBool IStepDetails.Enabled { get; }

Returns

Type	Description
Vortex.Connector.ValueTypes.Online.IOnlineBool

| Improve this Doc View Source

IStepDetails.ID

Declaration

IOnlineInt IStepDetails.ID { get; }

Returns

Type	Description
Vortex.Connector.ValueTypes.Online.IOnlineInt

| Improve this Doc View Source

IStepDetails.Order

Declaration

IOnlineUInt IStepDetails.Order { get; }

Returns

Type	Description
Vortex.Connector.ValueTypes.Online.IOnlineUInt

| Improve this Doc View Source

IStepDetails.Status

Declaration

[EnumeratorDiscriminator(typeof(eStepStatus))]
IOnlineInt IStepDetails.Status { get; }

Returns

Type	Description
Vortex.Connector.ValueTypes.Online.IOnlineInt

Implements

Vortex.Connector.IVortexObject

Vortex.Connector.ITwinObject

Vortex.Connector.IVortexElement

IStepDetails

IShadowStepDetails

Vortex.Connector.IVortexOnlineObject

Vortex.Connector.IVortexShadowObject