Class TcoMessage

Complete message details including time stamp, message text, message category, identity of the message provider, context cycle in which the message was posted.

Inheritance
System.Object
TcoMessage
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 \"\" }", "TcoMessage", "TcoCore", TypeComplexityEnum.Complex)]
public class TcoMessage : IVortexObject, ITwinObject, IVortexElement, ITcoMessage, IShadowTcoMessage, IVortexOnlineObject, IVortexShadowObject

Constructors

| Improve this Doc View Source

TcoMessage()

Declaration
public TcoMessage()
| Improve this Doc View Source

TcoMessage(IVortexObject, String, String)

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

_Category

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

_context

Declaration
IsTcoContext _context
Field Value
Type Description
IsTcoContext
| Improve this Doc View Source

_Cycle

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

_ExpectDequeing

Declaration
OnlinerBool _ExpectDequeing
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

_Identity

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

_indentityPersistence

Declaration
IVortexObject _indentityPersistence
Field Value
Type Description
Vortex.Connector.IVortexObject
| Improve this Doc View Source

_MessageDigest

Declaration
OnlinerDWord _MessageDigest
Field Value
Type Description
Vortex.Connector.ValueTypes.OnlinerDWord
| Improve this Doc View Source

_parentObject

Declaration
IsTcoObject _parentObject
Field Value
Type Description
IsTcoObject
| Improve this Doc View Source

_PerCycleCount

Declaration
OnlinerByte _PerCycleCount
Field Value
Type Description
Vortex.Connector.ValueTypes.OnlinerByte
| Improve this Doc View Source

_Pinned

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

_Text

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

_TimeStamp

Declaration
OnlinerDateTime _TimeStamp
Field Value
Type Description
Vortex.Connector.ValueTypes.OnlinerDateTime
| Improve this Doc View Source

_translatorPersistence

Declaration
ITranslator _translatorPersistence
Field Value
Type Description
Vortex.Localizations.Abstractions.ITranslator
| Improve this Doc View Source

mutex

Declaration
volatile object mutex
Field Value
Type Description
System.Object

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

Category

Message category of this message. See eMessageCategory for detailed informations.

Declaration
[EnumeratorDiscriminator(typeof(eMessageCategory))]
public OnlinerInt Category { get; }
Property Value
Type Description
Vortex.Connector.ValueTypes.OnlinerInt
| 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

Cycle

Context cycle in which the message was posted.

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

ExpectDequeing

Indicates that the message is expected to be dequeed from the buffer.

Declaration
public OnlinerBool ExpectDequeing { 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

Identity

Identity of the TcoObject that posted this message.

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

IndentityPersistence

Declaration
[IgnoreReflection]
IVortexObject IndentityPersistence { }
Property Value
Type Description
Vortex.Connector.IVortexObject
| Improve this Doc View Source

IsActive

Gets whether this TcoMessage is active. The message is active when the Cycle value is equal to LastStartCycleCount

Declaration
public bool IsActive { get; }
Property Value
Type Description
System.Boolean
| 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

LastKnownPlain

Gets the last known message content in plain .net type system (aka POCO object) with object retieved by identity.

Declaration
[IgnoreReflection]
public PlainTcoMessage LastKnownPlain { get; }
Property Value
Type Description
PlainTcoMessage
| Improve this Doc View Source

MessageDigest

Stores message digest of this message text.

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

OrphanedMessageContext

Gets or sets context for orphaned messages that do not have a context.

important

Orphaned object messages should not exist in the TcOpen application. There must be only one context in the PLC application and this single context can be set to this property.

Declaration
[IgnoreReflection]
[Obsolete("Used only for backward compatibility. TcOpen application should not have orphaned messages when structured properly.")]
public static IsTcoContext OrphanedMessageContext { get; set; }
Property Value
Type Description
IsTcoContext
| Improve this Doc View Source

Parent

Declaration
protected IVortexObject Parent { get; set; }
Property Value
Type Description
Vortex.Connector.IVortexObject
| Improve this Doc View Source

PerCycleCount

Count of messages of the object in the current cycle.

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

Pinned

Indicates that the message must be persisted in the alarm view until acknowledged.

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

PlainMessage

Gets the message in plain .net type system (aka POCO object).

Declaration
[IgnoreReflection]
public PlainTcoMessage PlainMessage { get; }
Property Value
Type Description
PlainTcoMessage
| 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

Text

Text of the message.

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

TimeStamp

Time when the message was posted.

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

TranslatorPersistence

Declaration
[IgnoreReflection]
ITranslator TranslatorPersistence { }
Property Value
Type Description
Vortex.Localizations.Abstractions.ITranslator
| 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(PlainTcoMessage)

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

CreatePlainerType()

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

CreatePlainerType(PlainTcoMessage)

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

FlushOnlineToPlain(PlainTcoMessage)

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

FlushOnlineToShadow()

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

FlushPlainToOnline(PlainTcoMessage)

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

GetContext()

Declaration
IsTcoContext GetContext()
Returns
Type Description
IsTcoContext
| 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()
| Improve this Doc View Source

Translate(String, IVortexObject)

Declaration
string Translate(string text, IVortexObject sender)
Parameters
Type Name Description
System.String text
Vortex.Connector.IVortexObject sender
Returns
Type Description
System.String

Explicit Interface Implementations

| Improve this Doc View Source

IShadowTcoMessage.Category

Declaration
[EnumeratorDiscriminator(typeof(eMessageCategory))]
IShadowInt IShadowTcoMessage.Category { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Shadows.IShadowInt
| Improve this Doc View Source

IShadowTcoMessage.Cycle

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

IShadowTcoMessage.ExpectDequeing

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

IShadowTcoMessage.Identity

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

IShadowTcoMessage.MessageDigest

Declaration
IShadowDWord IShadowTcoMessage.MessageDigest { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Shadows.IShadowDWord
| Improve this Doc View Source

IShadowTcoMessage.PerCycleCount

Declaration
[ReadOnly]
IShadowByte IShadowTcoMessage.PerCycleCount { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Shadows.IShadowByte
| Improve this Doc View Source

IShadowTcoMessage.Pinned

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

IShadowTcoMessage.Text

Declaration
[ReadOnly]
IShadowString IShadowTcoMessage.Text { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Shadows.IShadowString
| Improve this Doc View Source

IShadowTcoMessage.TimeStamp

Declaration
[ReadOnly]
IShadowDateTime IShadowTcoMessage.TimeStamp { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Shadows.IShadowDateTime
| Improve this Doc View Source

ITcoMessage.Category

Declaration
[EnumeratorDiscriminator(typeof(eMessageCategory))]
IOnlineInt ITcoMessage.Category { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Online.IOnlineInt
| Improve this Doc View Source

ITcoMessage.Cycle

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

ITcoMessage.ExpectDequeing

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

ITcoMessage.Identity

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

ITcoMessage.MessageDigest

Declaration
IOnlineDWord ITcoMessage.MessageDigest { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Online.IOnlineDWord
| Improve this Doc View Source

ITcoMessage.PerCycleCount

Declaration
[ReadOnly]
IOnlineByte ITcoMessage.PerCycleCount { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Online.IOnlineByte
| Improve this Doc View Source

ITcoMessage.Pinned

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

ITcoMessage.Text

Declaration
[ReadOnly]
IOnlineString ITcoMessage.Text { get; }
Returns
Type Description
Vortex.Connector.ValueTypes.Online.IOnlineString
| Improve this Doc View Source

ITcoMessage.TimeStamp

Declaration
[ReadOnly]
IOnlineDateTime ITcoMessage.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