Class TcoMessenger

Provides mechanism for delivering static messages to the supervising applications (SCADA/HMI).

important

Each messenger has a single placeholder for the message; it stores the most important message from the last context cycle. If there are more messages in a single cycle for the same messenger then less important messages are discarded and replaced by the message with the category of higher severity.

important

Messenger can send the data to context logger. There is a maximum limit of 10 different messages per messenger in 2 consecutive context cycles. The messages that exceed this limit won't be logged when `OnEventRisen` logging is set. Take this behaviour into account when designing your system.

Inheritance
System.Object
TcoMessenger
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: TcoCore
Assembly: TcoCoreConnector.dll
Syntax
[TypeMetaDescriptor("{attribute addProperty Name \"\" }", "TcoMessenger", "TcoCore", TypeComplexityEnum.Complex)]
public class TcoMessenger : IVortexObject, ITwinObject, IVortexElement, ITcoMessenger, IShadowTcoMessenger, IVortexOnlineObject, IVortexShadowObject

Constructors

| Improve this Doc View Source

TcoMessenger()

Declaration
public TcoMessenger()
| Improve this Doc View Source

TcoMessenger(IVortexObject, String, String)

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

__constMDS_MAX_INDEX

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

__contextIdentity

Declaration
OnlinerULInt __contextIdentity
Field Value
Type Description
Vortex.Connector.ValueTypes.OnlinerULInt
| Improve this Doc View Source

__mime

Declaration
TcoMessage __mime
Field Value
Type Description
TcoMessage
| Improve this Doc View Source

_humanReadable

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

_MDS_MAX_INDEX

Declaration
OnlinerInt _MDS_MAX_INDEX
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

_contextIdentity

Declaration
[ReadOnly]
public OnlinerULInt _contextIdentity { get; }
Property Value
Type Description
Vortex.Connector.ValueTypes.OnlinerULInt
| Improve this Doc View Source

_mime

Most important message of this instance of messenger; stores the most important message from the last context cycle. If there are more messages in a single cycle for the same messenger then less important messages are discarded and replaced by the message with the category of higher severity.

Declaration
public TcoMessage _mime { get; }
Property Value
Type Description
TcoMessage
| 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

HumanReadable

Declaration
public string HumanReadable { get; protected set; }
Property Value
Type Description
System.String
| 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

MDS_MAX_INDEX

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

Parent

Declaration
protected IVortexObject Parent { get; set; }
Property Value
Type Description
Vortex.Connector.IVortexObject
| 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

Clear()

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

CopyPlainToShadow(PlainTcoMessenger)

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

CreatePlainerType()

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

CreatePlainerType(PlainTcoMessenger)

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

FlushOnlineToPlain(PlainTcoMessenger)

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

FlushOnlineToShadow()

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

FlushPlainToOnline(PlainTcoMessenger)

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

IShadowTcoMessenger._contextIdentity

Declaration
[ReadOnly]
IShadowULInt IShadowTcoMessenger._contextIdentity { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Shadows.IShadowULInt
| Improve this Doc View Source

IShadowTcoMessenger._mime

Declaration
IShadowTcoMessage IShadowTcoMessenger._mime { get; }
Returns
Type Description
IShadowTcoMessage
| Improve this Doc View Source

ITcoMessenger._contextIdentity

Declaration
[ReadOnly]
IOnlineULInt ITcoMessenger._contextIdentity { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Online.IOnlineULInt
| Improve this Doc View Source

ITcoMessenger._mime

Declaration
ITcoMessage ITcoMessenger._mime { get; }
Returns
Type Description
ITcoMessage

Implements

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

See Also