Class MESSAGE

Namespace

L5Sharp.Types.Predefined

Assembly

L5Sharp.dll

A predefined or built in data type used with message instructions. Note that the members of this type resemble those observed from exported L5X, and not that of the predefined data type.

public sealed class MESSAGE : StructureType, ILogixSerializable

Inheritance

object

LogixType

StructureType

MESSAGE

Implements

ILogixSerializable

Inherited Members

StructureType.Name

StructureType.Family

StructureType.Members

LogixType.DataChanged

LogixType.As<TLogixType>()

LogixType.Clone()

LogixType.Equals(object)

LogixType.GetHashCode()

LogixType.Member(string)

LogixType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

MESSAGE()

Creates a new MESSAGE data type instance.

public MESSAGE()

MESSAGE(XElement)

Creates a new StructureType initialized from the provided XElement data.

public MESSAGE(XElement element)

Parameters

element XElement

The element to parse as the new member object.

Exceptions

ArgumentNullException

element is null.

InvalidOperationException

element does not have required attributes or child elements.

Properties

AttributeNumber

Gets the AttributeNumber value of the MESSAGE parameters.

public INT AttributeNumber { get; set; }

Property Value

INT

CacheConnections

Gets the CacheConnections value of the MESSAGE parameters.

public BOOL CacheConnections { get; set; }

Property Value

BOOL

Class

The class (atomic, predefined, user-defined) that the type belongs to.

public override DataTypeClass Class { get; }

Property Value

DataTypeClass

A DataTypeClass option representing the class type.

CommTypeCode

Gets the CommTypeCode value of the MESSAGE parameters.

public INT CommTypeCode { get; set; }

Property Value

INT

ConnectedFlag

Gets the ConnectedFlag value of the MESSAGE parameters.

public INT ConnectedFlag { get; set; }

Property Value

INT

ConnectionPath

Gets the ConnectionPath value of the MESSAGE parameters.

public STRING ConnectionPath { get; set; }

Property Value

STRING

DestinationTag

Gets the DestinationTag value of the MESSAGE parameters.

public STRING DestinationTag { get; set; }

Property Value

STRING

LargePacketUsage

Gets the LargePacketUsage value of the MESSAGE parameters.

public BOOL LargePacketUsage { get; set; }

Property Value

BOOL

LocalIndex

Gets the LocalIndex value of the MESSAGE parameters.

public INT LocalIndex { get; set; }

Property Value

INT

MessageType

Gets the MessageType value of the MESSAGE parameters.

public STRING MessageType { get; set; }

Property Value

STRING

ObjectType

Gets the ObjectType value of the MESSAGE parameters.

public INT ObjectType { get; set; }

Property Value

INT

RequestedLength

Gets the RequestedLength value of the MESSAGE parameters.

public INT RequestedLength { get; set; }

Property Value

INT

ServiceCode

Gets the ServiceCode value of the MESSAGE parameters.

public INT ServiceCode { get; set; }

Property Value

INT

TargetObject

Gets the TargetObject value of the MESSAGE parameters.

public INT TargetObject { get; set; }

Property Value

INT

Methods

Serialize()

Returns a XElement representing the serialized L5X data for a given object.

public override XElement Serialize()

Returns

XElement

A XElement containing the XML data.