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

Provides methods for permit dongle. More...

#include <arcs_interface.h>

Inheritance diagram for IARCSDongle:
ISDKComponent

Public Member Functions

virtual SDKResult SDK_CALLTYPE Initialize (const SDKString &dongle_data)=0 throw ()
 Initialize the dongle. More...
 
virtual SDKResult SDK_CALLTYPE GetHexString (ARCSDongleData param, SDKString &out_str) const =0 throw ()
 Get the dongle content in hex. More...
 
virtual SDKResult SDK_CALLTYPE Get (ARCSDongleData param, SDKUInt8 *data, SDKUInt32 &data_size) const =0 throw ()
 Get the dongle content in binary. More...
 
- Public Member Functions inherited from ISDKComponent
virtual SDKAtomicRefCount SDK_CALLTYPE AddRef () const =0 throw ()
 Increments the reference count for an interface on a component.

 
virtual SDKAtomicRefCount SDK_CALLTYPE Release () const =0 throw ()
 Decrements the reference count for an interface on a component.
 
virtual SDKResult SDK_CALLTYPE GetInterface (const InterfaceId &id, void **obj_ptr)=0 throw ()
 Returns pointers to the supported interfaces on a component.
 
template<typename _Itf >
SDKResult GetInterface (_Itf **obj_ptr) throw ()
 Returns pointers to the supported interfaces on a component.
 

Detailed Description

Provides methods for permit dongle.

Member Function Documentation

◆ Initialize()

virtual SDKResult SDK_CALLTYPE Initialize ( const SDKString &  dongle_data)
throw (
)
pure virtual

Initialize the dongle.

Parameters
dongle_data[in] Dongle data string.
Returns
kSDKResult_Succeeded
kSDKResult_NotImplemented

◆ GetHexString()

virtual SDKResult SDK_CALLTYPE GetHexString ( ARCSDongleData  param,
SDKString &  out_str 
) const
throw (
)
pure virtual

Get the dongle content in hex.

Parameters
param[in] Parameter.
out_str[out] Dongle content in hex.
Returns
kSDKResult_Succeeded
kSDKResult_NotImplemented

◆ Get()

virtual SDKResult SDK_CALLTYPE Get ( ARCSDongleData  param,
SDKUInt8 *  data,
SDKUInt32 &  data_size 
) const
throw (
)
pure virtual

Get the dongle content in binary.

Parameters
param[in] Parameter.
data[out] Address of a variable that receives the dongle content.
data_size[out] Address of a variable that receives the dongle content size.
Returns
kSDKResult_Succeeded
kSDKResult_NotImplemented

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