NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
ILWEMessage Class Referenceabstract

Provides access to messages sent or received via the LWE interface. More...

#include <lwe_interface.h>

Inheritance diagram for ILWEMessage:
ILWEMultiTextMessage

Public Member Functions

virtual SDKUInt32 SDK_CALLTYPE GetType () const =0 throw ()
 Gets the message type (see enum LWEMessageType) More...
 
virtual SDKResult SDK_CALLTYPE GetSourceID (SDKString &id) const =0 throw ()
 Source id (SFI used as a source identificator) More...
 
virtual SDKResult SDK_CALLTYPE GetDestinationID (SDKAny &id) const =0 throw ()
 Destination id (can be string or strings collection if more than once destination SFI is used) More...
 
virtual SDKResult SDK_CALLTYPE GetData (SDKAny &data) const =0 throw ()
 Mesage data (for text messages - nmea strings, for binary - pure binary data) More...
 

Detailed Description

Provides access to messages sent or received via the LWE interface.

Member Function Documentation

◆ GetType()

virtual SDKUInt32 SDK_CALLTYPE GetType ( ) const
throw (
)
pure virtual

Gets the message type (see enum LWEMessageType)

Returns
message type (see enum LWEMessageType)

◆ GetSourceID()

virtual SDKResult SDK_CALLTYPE GetSourceID ( SDKString &  id) const
throw (
)
pure virtual

Source id (SFI used as a source identificator)

Parameters
[out]idSource SFI
Returns
SDKResult_Succeeded or an error if fails

◆ GetDestinationID()

virtual SDKResult SDK_CALLTYPE GetDestinationID ( SDKAny &  id) const
throw (
)
pure virtual

Destination id (can be string or strings collection if more than once destination SFI is used)

Parameters
[out]idDestination SFI or SFIs (string or strings enum)
Returns
SDKResult_Succeeded or an error if fails

◆ GetData()

virtual SDKResult SDK_CALLTYPE GetData ( SDKAny &  data) const
throw (
)
pure virtual

Mesage data (for text messages - nmea strings, for binary - pure binary data)

[out] data Can be string or arrays

Returns
SDKResult_Succeeded or an error if fails

The documentation for this class was generated from the following file: