Messages

Messages. More...

Data Structures
class	ILWEMessage
	Provides access to messages sent or received via the LWE interface. More...
class	ILWETextMessageEdit
	Provides access to members for editing text messages. More...
class	ILWEMultiTextMessage
	Provides access to members of multi-sentence messages (MSM) More...
class	ILWEMultiTextMessageEdit
	Provides access to members that enumerate through editable multi sentence messages (MSM) More...
class	ILWEBinaryMessageEdit
	Provides access to members for editing binary messages. More...

Enumerations
enum	LWEMessageType { kLWEMessageType_Text, kLWEMessageType_MultiText, kLWEMessageType_Binary, kLWEMessageType_BinaryRetransmitted }
	LWE message type. More...
enum	LWEMessageProperties {   kLWEMessageProperties_SourceID, kLWEMessageProperties_DestinationID, kLWEMessageProperties_Data, kLWEMessageProperties_Host,   kLWEMessageProperties_Port, kLWEMessageProperties_Time }
	Common message properties. More...
enum	LWETextMessageProperties {   kLWETextMessageProperties_SourceID = kLWEMessageProperties_SourceID, kLWETextMessageProperties_DestinationID = kLWEMessageProperties_DestinationID, kLWETextMessageProperties_Data = kLWEMessageProperties_Data, kLWETextMessageProperties_Host = kLWEMessageProperties_Host,   kLWETextMessageProperties_Port = kLWEMessageProperties_Port, kLWETextMessageProperties_PosixTime = kLWEMessageProperties_Time, kLWETextMessageProperties_GroupID = 0x100, kLWETextMessageProperties_LineNum,   kLWETextMessageProperties_Text, kLWETextMessageProperties_RelativeTime, kLWETextMessageProperties_Authentication, kLWETextMessageProperties_UnknownTags }
	Text message properties. More...
enum	LWEMultiTextMessageProperties {   kLWEMultiTextMessageProperties_SourceID = kLWETextMessageProperties_SourceID, kLWEMultiTextMessageProperties_DestinationID = kLWETextMessageProperties_DestinationID, kLWEMultiTextMessageProperties_Data = kLWETextMessageProperties_Data, kLWEMultiTextMessageProperties_Host = kLWETextMessageProperties_Host,   kLWEMultiTextMessageProperties_Port = kLWETextMessageProperties_Port, kLWEMultiTextMessageProperties_PosixTime = kLWEMessageProperties_Time, kLWEMultiTextMessageProperties_GroupID = kLWETextMessageProperties_GroupID, kLWEMultiTextMessageProperties_Text = kLWETextMessageProperties_Text,   kLWEMultiTextMessageProperties_RelativeTime = kLWETextMessageProperties_RelativeTime, kLWEMultiTextMessageProperties_Authentication = kLWETextMessageProperties_Authentication, kLWEMultiTextMessageProperties_UnknownTags = kLWETextMessageProperties_UnknownTags, kLWEMultiTextMessageProperties_TotalNum = 0x200,   kLWEMultiTextMessageProperties_GetDataAsEnum }
	Multitext message properties. More...
enum	LWEBinaryMessageProperties {   kLWEBinaryMessageProperties_SourceID = kLWEMessageProperties_SourceID, kLWEBinaryMessageProperties_DestinationID = kLWEMessageProperties_DestinationID, kLWEBinaryMessageProperties_Data = kLWEMessageProperties_Data, kLWEBinaryMessageProperties_Host = kLWEMessageProperties_Host,   kLWEBinaryMessageProperties_Port = kLWEMessageProperties_Port, kLWEBinaryMessageProperties_Time = kLWEMessageProperties_Time, kLWEBinaryMessageProperties_Version = 0x300, kLWEBinaryMessageProperties_Status,   kLWEBinaryMessageProperties_Device, kLWEBinaryMessageProperties_Channel, kLWEBinaryMessageProperties_Info, kLWEBinaryMessageProperties_Type,   kLWEBinaryMessageProperties_Length, kLWEBinaryMessageProperties_ID, kLWEBinaryMessageProperties_AckPort, kLWEBinaryMessageProperties_TimeDiff }
	Binary message properties. More...
enum	LWEBinaryMessageVersion { kLWEBinaryMessageVersion_Unknown = 0, kLWEBinaryMessageVersion_1 = 1, kLWEBinaryMessageVersion_2 = 2 }
	Binary message types. More...

Detailed Description

Messages.

Enumeration Type Documentation

LWEMessageType

enum LWEMessageType

LWE message type.

Enumerator
kLWEMessageType_Text	Text message (aka SBM)
kLWEMessageType_MultiText	Multitext message (aka MSM)
kLWEMessageType_Binary	Simple binary message without retransmitting.
kLWEMessageType_BinaryRetransmitted	Retransmitted binary message.

LWEMessageProperties

enum LWEMessageProperties

Common message properties.

Enumerator
kLWEMessageProperties_SourceID	string. Source SFI
kLWEMessageProperties_DestinationID	string or strings enum component. Destination SFI
kLWEMessageProperties_Data	string or array. Data
kLWEMessageProperties_Host	string. Remote host that was used to send the message (read-only)
kLWEMessageProperties_Port	string. Remote port that was used to send the message (read-only)
kLWEMessageProperties_Time	SDKTime. User defined time (can be used for text and point-to-point messages)

LWETextMessageProperties

enum LWETextMessageProperties

Text message properties.

Enumerator
kLWETextMessageProperties_SourceID	string. Source SFI
kLWETextMessageProperties_DestinationID	string or strings enum component. Destination SFI
kLWETextMessageProperties_Data	string or array. Data
kLWETextMessageProperties_Host	string. Remote host that was used to send the message (read-only)
kLWETextMessageProperties_Port	string. Remote port that was used to send the message (read-only)
kLWETextMessageProperties_PosixTime	SDKTime. POSIX time (see tag c)
kLWETextMessageProperties_GroupID	SDKUint8. Group control number (see tag g)
kLWETextMessageProperties_LineNum	SDKUInt16. Line count number (see tag n)
kLWETextMessageProperties_Text	string. Proprietary data (see tag t)
kLWETextMessageProperties_RelativeTime	SDKTimeDelta. Relative time (see tag r)
kLWETextMessageProperties_Authentication	bool. Add authentication tag (see tag a)
kLWETextMessageProperties_UnknownTags	IEnumSDKProperty component. List of unknown (not defined in IEC 61162-40 ed.2) tags

LWEMultiTextMessageProperties

enum LWEMultiTextMessageProperties

Multitext message properties.

Enumerator
kLWEMultiTextMessageProperties_SourceID	string. Source SFI
kLWEMultiTextMessageProperties_DestinationID	string or strings enum component. Destination SFI
kLWEMultiTextMessageProperties_Data	string or array. Data
kLWEMultiTextMessageProperties_Host	string. Remote host that sent the message (read-only)
kLWEMultiTextMessageProperties_Port	string. Remote port that was used to send the message (read-only)
kLWEMultiTextMessageProperties_PosixTime	SDKTime. POSIX time (see tag c)
kLWEMultiTextMessageProperties_GroupID	SDKUint8. Group control number (see tag g)
kLWEMultiTextMessageProperties_Text	string. Proprietary data (see tag t)
kLWEMultiTextMessageProperties_RelativeTime	SDKTimeDelta. Relative time (see tag r)
kLWEMultiTextMessageProperties_Authentication	bool. Add authentication tag (see tag a)
kLWEMultiTextMessageProperties_UnknownTags	IEnumSDKProperty component. List of unknown (not defined in IEC 61162-40 ed.2) tags
kLWEMultiTextMessageProperties_TotalNum	SDKUInt32. Total number of messages in the group.
kLWEMultiTextMessageProperties_GetDataAsEnum	bool. Select data output format: true - string enum, false - string (by default)

LWEBinaryMessageProperties

enum LWEBinaryMessageProperties

Binary message properties.

Enumerator
kLWEBinaryMessageProperties_SourceID	string. Source SFI
kLWEBinaryMessageProperties_DestinationID	string or strings enum component. Destination SFI
kLWEBinaryMessageProperties_Data	string or array. Data
kLWEBinaryMessageProperties_Host	string. Remote host that sent the message (read-only)
kLWEBinaryMessageProperties_Port	string. Remote port that was used to send the message (read-only)
kLWEBinaryMessageProperties_Time	SDKTime. User defined time. (supported only by point-to-point messages)
kLWEBinaryMessageProperties_Version	SDKUInt16. Binary header version.
kLWEBinaryMessageProperties_Status	SDKUInt16. Status of acquisition for the data return (see iec61162-450)
kLWEBinaryMessageProperties_Device	SDKUInt8. Data source (device) as binary value (see iec61162-450)
kLWEBinaryMessageProperties_Channel	SDKUInt8. Subdivision according to the data source (device) (see iec61162-450)
kLWEBinaryMessageProperties_Info	string or strings enum. Status information (e.g. successful operation or error codes).
kLWEBinaryMessageProperties_Type	string. This string defines the data block encoding by assigning a MIME content type
kLWEBinaryMessageProperties_Length	SDKUInt32. Defines the length of the data content in bytes.
kLWEBinaryMessageProperties_ID	SDKUInt32. Defines the binary block id that was used to send this message.
kLWEBinaryMessageProperties_AckPort	SDKUInt32. Defines the port which used for answer with ACK messages.
kLWEBinaryMessageProperties_TimeDiff	SDKTimeDelta. Difference between user defined time and sending time. (supported only by point-to-point messages)

LWEBinaryMessageVersion

enum LWEBinaryMessageVersion

Binary message types.

Enumerator
kLWEBinaryMessageVersion_Unknown	Unknown binary version.
kLWEBinaryMessageVersion_1	Binary version 1 (IEC61162-450 ed.1)
kLWEBinaryMessageVersion_2	Binary version 2 (IEC61162-450 ed.2)