Class PlainTcoMessage

This is POCO object for its respective onliner class. For documentation of this type see the onliner class.

Inheritance
System.Object
PlainTcoMessage
Implements
System.ComponentModel.INotifyPropertyChanged
Vortex.Connector.IPlain
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: TcoCore
Assembly: TcoCoreConnector.dll
Syntax
public class PlainTcoMessage : INotifyPropertyChanged, IPlain

Constructors

| Improve this Doc View Source

PlainTcoMessage()

Declaration
public PlainTcoMessage()

Fields

| Improve this Doc View Source

_Category

Declaration
short _Category
Field Value
Type Description
System.Int16
| Improve this Doc View Source

_Cycle

Declaration
ulong _Cycle
Field Value
Type Description
System.UInt64
| Improve this Doc View Source

_ExpectDequeing

Declaration
bool _ExpectDequeing
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

_Identity

Declaration
ulong _Identity
Field Value
Type Description
System.UInt64
| Improve this Doc View Source

_MessageDigest

Declaration
uint _MessageDigest
Field Value
Type Description
System.UInt32
| Improve this Doc View Source

_PerCycleCount

Declaration
byte _PerCycleCount
Field Value
Type Description
System.Byte
| Improve this Doc View Source

_Pinned

Declaration
bool _Pinned
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

_Text

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

_TimeStamp

Declaration
DateTime _TimeStamp
Field Value
Type Description
System.DateTime
| Improve this Doc View Source

location

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

OnlinerMessage

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

parentsHumanReadable

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

parentsObjectSymbol

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

raw

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

source

Declaration
string source
Field Value
Type Description
System.String

Properties

| Improve this Doc View Source

Category

Declaration
public short Category { get; set; }
Property Value
Type Description
System.Int16
| Improve this Doc View Source

CategoryAsEnum

Gets category of this message.

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

Cycle

Declaration
public ulong Cycle { get; set; }
Property Value
Type Description
System.UInt64
| Improve this Doc View Source

ExpectDequeing

Declaration
public bool ExpectDequeing { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Identity

Declaration
public ulong Identity { get; set; }
Property Value
Type Description
System.UInt64
| Improve this Doc View Source

Location

Gets location of the object retrieved from the identity of the object that produced this message (typically human readable path of the object).

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

MessageDigest

Declaration
public uint MessageDigest { get; set; }
Property Value
Type Description
System.UInt32
| Improve this Doc View Source

ParentsHumanReadable

Gets Vortex.Connector.IVortexElement.HumanReadable of the parent TcoObject that own this message.

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

ParentsObjectSymbol

Gets symbol of the parent TcoObject that own this message.

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

PerCycleCount

Declaration
public byte PerCycleCount { get; set; }
Property Value
Type Description
System.Byte
| Improve this Doc View Source

Pinned

Declaration
public bool Pinned { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Raw

Gets or sets raw text of this message (no translation, no interpolation).

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

Source

Gets source object of the message retrieved from the identity of the object that produced this message (typically the symbol of the PLC program).

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

SubCategory

Get subcategory of this message.

Declaration
public short SubCategory { get; }
Property Value
Type Description
System.Int16
| Improve this Doc View Source

Text

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

TimeStamp

Declaration
public DateTime TimeStamp { get; set; }
Property Value
Type Description
System.DateTime

Methods

| Improve this Doc View Source

CopyCyclicToPlain(ITcoMessage)

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

CopyCyclicToPlain(TcoMessage)

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

CopyPlainToCyclic(ITcoMessage)

Declaration
public void CopyPlainToCyclic(ITcoMessage target)
Parameters
Type Name Description
ITcoMessage target
| Improve this Doc View Source

CopyPlainToCyclic(TcoMessage)

Declaration
public void CopyPlainToCyclic(TcoMessage target)
Parameters
Type Name Description
TcoMessage target
| Improve this Doc View Source

CopyPlainToShadow(IShadowTcoMessage)

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

CopyPlainToShadow(TcoMessage)

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

CopyShadowToPlain(IShadowTcoMessage)

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

CopyShadowToPlain(TcoMessage)

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

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj
Returns
Type Description
System.Boolean
Overrides
System.Object.Equals(System.Object)
| Improve this Doc View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32
Overrides
System.Object.GetHashCode()
| Improve this Doc View Source

SetOnlinerMessage(TcoMessage)

Declaration
void SetOnlinerMessage(TcoMessage message)
Parameters
Type Name Description
TcoMessage message
| Improve this Doc View Source

ShallowClone()

Gets memberwise clone of this PlainTcoMessage

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

ToString()

Get this message in string format.

Declaration
public override string ToString()
Returns
Type Description
System.String

Formatted message
Overrides
System.Object.ToString()

Events

| Improve this Doc View Source

PropertyChanged

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type Description
System.ComponentModel.PropertyChangedEventHandler

Implements

System.ComponentModel.INotifyPropertyChanged
Vortex.Connector.IPlain