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

Provides access to members that manage a message. More...

#include <message_interface.h>

Inheritance diagram for IMessage:
ISDKProperties

Public Member Functions

virtual MessageID SDK_CALLTYPE GetMessageID () const =0 throw ()
 Returns the value of the specified parameter. More...
 
virtual SDKResult SDK_CALLTYPE GetSenderID (MessageSenderID &sender_id) const =0 throw ()
 Returns the message sender identifier. More...
 
virtual SDKResult SDK_CALLTYPE GetSenderName (SDKString &sender_name) const =0 throw ()
 Returns the message sender name. More...
 
- Public Member Functions inherited from ISDKProperties
virtual SDKResult SDK_CALLTYPE SetProperty (const SDKPropertyID &id, const SDKAny &value)=0 throw ()
 Sets a property value.
 
virtual SDKResult SDK_CALLTYPE GetProperty (const SDKPropertyID &id, SDKAny &value) const =0 throw ()
 Retrieves a property value.
 

Detailed Description

Provides access to members that manage a message.

Member Function Documentation

◆ GetMessageID()

virtual MessageID SDK_CALLTYPE GetMessageID ( ) const
throw (
)
pure virtual

Returns the value of the specified parameter.

Returns
A message identifier

◆ GetSenderID()

virtual SDKResult SDK_CALLTYPE GetSenderID ( MessageSenderID &  sender_id) const
throw (
)
pure virtual

Returns the message sender identifier.

Parameters
[out]sender_idA sender string identifier.
Returns
kSDKResult_Succedded
kSDKResult_NotExist

◆ GetSenderName()

virtual SDKResult SDK_CALLTYPE GetSenderName ( SDKString &  sender_name) const
throw (
)
pure virtual

Returns the message sender name.

Parameters
[out]sender_nameAn address of a variable that receives the sender name.
Returns
kSDKResult_Succeded
kSDKResult_NotExist

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