Class TcoInspectorData

Defines data commonly used accross different types of inspectors.

Inheritance
System.Object
TcoInspectorData
TcoAnalogueInspectorData
TcoDataInspectorData
TcoDigitalInspectorData
Implements
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: TcoInspectors
Assembly: TcoInspectorsConnector.dll
Syntax
[TypeMetaDescriptor("{attribute addProperty Name \"\" }", "TcoInspectorData", "TcoInspectors", TypeComplexityEnum.Complex)]
public class TcoInspectorData : IVortexObject, ITwinObject, IVortexElement, ITcoInspectorData, IShadowTcoInspectorData, IVortexOnlineObject, IVortexShadowObject

Constructors

| Improve this Doc View Source

TcoInspectorData()

Declaration
public TcoInspectorData()
| Improve this Doc View Source

TcoInspectorData(IVortexObject, String, String)

Declaration
public TcoInspectorData(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

_ErrorCode

Declaration
OnlinerString _ErrorCode
Field Value
Type Description
Vortex.Connector.ValueTypes.OnlinerString
| Improve this Doc View Source

_FailTime

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

_FailureDescription

Declaration
OnlinerString _FailureDescription
Field Value
Type Description
Vortex.Connector.ValueTypes.OnlinerString
| Improve this Doc View Source

_humanReadable

Declaration
protected string _humanReadable
Field Value
Type Description
System.String
| Improve this Doc View Source

_IsByPassed

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

_IsExcluded

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

_NumberOfAllowedRetries

Declaration
OnlinerUInt _NumberOfAllowedRetries
Field Value
Type Description
Vortex.Connector.ValueTypes.OnlinerUInt
| Improve this Doc View Source

_PassTime

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

_Result

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

_RetryAttemptsCount

Declaration
OnlinerUInt _RetryAttemptsCount
Field Value
Type Description
Vortex.Connector.ValueTypes.OnlinerUInt
| Improve this Doc View Source

_TimeStamp

Declaration
OnlinerDateTime _TimeStamp
Field Value
Type Description
Vortex.Connector.ValueTypes.OnlinerDateTime

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

ErrorCode

Error code.

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

FailTime

Fail time. Is the maximum test duration (or timeout). If the condition for the successul test is not met within this time, the test fails.

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

FailureDescription

Verbatim description of the failure.

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

HumanReadable

Declaration
public string HumanReadable { get; protected set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

IsByPassed

Test is bypassed, no eveluation occurs.
Evaluation of excluded test should be handled by user code.

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

IsExcluded

Test is excluded from evaluation. If TRUE the check is excluded, the test will run and provide detected value. Evaluation of excluded test should be handled by user code.

Declaration
public OnlinerBool IsExcluded { get; }
Property Value
Type Description
Vortex.Connector.ValueTypes.OnlinerBool
| 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

NumberOfAllowedRetries

Counter of allowed inspections.

Declaration
public OnlinerUInt NumberOfAllowedRetries { 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

PassTime

Pass time, elapses when the measured value has required value (see ReuiredStatus). The signal must have required value continuosly for this time span for the check to pass.

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

Result

Test result.

Declaration
[RenderIgnore(new string[]{"Control", "ShadowControl"})]
[EnumeratorDiscriminator(typeof(eInspectorResult))]
public OnlinerInt Result { get; }
Property Value
Type Description
Vortex.Connector.ValueTypes.OnlinerInt
| Improve this Doc View Source

RetryAttemptsCount

Counter inspections.

Declaration
public OnlinerUInt RetryAttemptsCount { get; }
Property Value
Type Description
Vortex.Connector.ValueTypes.OnlinerUInt
| 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

TimeStamp

Inspection timestamp.

Declaration
[RenderIgnore(new string[]{"Control", "ShadowControl"})]
public OnlinerDateTime TimeStamp { get; }
Property Value
Type Description
Vortex.Connector.ValueTypes.OnlinerDateTime
| 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(PlainTcoInspectorData)

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

CreatePlainerType()

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

CreatePlainerType(PlainTcoInspectorData)

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

FlushOnlineToPlain(PlainTcoInspectorData)

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

FlushOnlineToShadow()

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

FlushPlainToOnline(PlainTcoInspectorData)

Declaration
public void FlushPlainToOnline(PlainTcoInspectorData source)
Parameters
Type Name Description
PlainTcoInspectorData 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

IShadowTcoInspectorData.ErrorCode

Declaration
IShadowString IShadowTcoInspectorData.ErrorCode { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Shadows.IShadowString
| Improve this Doc View Source

IShadowTcoInspectorData.FailTime

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

IShadowTcoInspectorData.FailureDescription

Declaration
IShadowString IShadowTcoInspectorData.FailureDescription { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Shadows.IShadowString
| Improve this Doc View Source

IShadowTcoInspectorData.IsByPassed

Declaration
IShadowBool IShadowTcoInspectorData.IsByPassed { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Shadows.IShadowBool
| Improve this Doc View Source

IShadowTcoInspectorData.IsExcluded

Declaration
IShadowBool IShadowTcoInspectorData.IsExcluded { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Shadows.IShadowBool
| Improve this Doc View Source

IShadowTcoInspectorData.NumberOfAllowedRetries

Declaration
IShadowUInt IShadowTcoInspectorData.NumberOfAllowedRetries { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Shadows.IShadowUInt
| Improve this Doc View Source

IShadowTcoInspectorData.PassTime

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

IShadowTcoInspectorData.Result

Declaration
[RenderIgnore(new string[]{"Control", "ShadowControl"})]
[EnumeratorDiscriminator(typeof(eInspectorResult))]
IShadowInt IShadowTcoInspectorData.Result { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Shadows.IShadowInt
| Improve this Doc View Source

IShadowTcoInspectorData.RetryAttemptsCount

Declaration
IShadowUInt IShadowTcoInspectorData.RetryAttemptsCount { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Shadows.IShadowUInt
| Improve this Doc View Source

IShadowTcoInspectorData.TimeStamp

Declaration
[RenderIgnore(new string[]{"Control", "ShadowControl"})]
IShadowDateTime IShadowTcoInspectorData.TimeStamp { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Shadows.IShadowDateTime
| Improve this Doc View Source

ITcoInspectorData.ErrorCode

Declaration
IOnlineString ITcoInspectorData.ErrorCode { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Online.IOnlineString
| Improve this Doc View Source

ITcoInspectorData.FailTime

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

ITcoInspectorData.FailureDescription

Declaration
IOnlineString ITcoInspectorData.FailureDescription { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Online.IOnlineString
| Improve this Doc View Source

ITcoInspectorData.IsByPassed

Declaration
IOnlineBool ITcoInspectorData.IsByPassed { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Online.IOnlineBool
| Improve this Doc View Source

ITcoInspectorData.IsExcluded

Declaration
IOnlineBool ITcoInspectorData.IsExcluded { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Online.IOnlineBool
| Improve this Doc View Source

ITcoInspectorData.NumberOfAllowedRetries

Declaration
IOnlineUInt ITcoInspectorData.NumberOfAllowedRetries { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Online.IOnlineUInt
| Improve this Doc View Source

ITcoInspectorData.PassTime

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

ITcoInspectorData.Result

Declaration
[RenderIgnore(new string[]{"Control", "ShadowControl"})]
[EnumeratorDiscriminator(typeof(eInspectorResult))]
IOnlineInt ITcoInspectorData.Result { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Online.IOnlineInt
| Improve this Doc View Source

ITcoInspectorData.RetryAttemptsCount

Declaration
IOnlineUInt ITcoInspectorData.RetryAttemptsCount { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Online.IOnlineUInt
| Improve this Doc View Source

ITcoInspectorData.TimeStamp

Declaration
[RenderIgnore(new string[]{"Control", "ShadowControl"})]
IOnlineDateTime ITcoInspectorData.TimeStamp { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Online.IOnlineDateTime

Implements

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

See Also