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

Provides methods for permit management. More...

#include <arcs_interface.h>

Inheritance diagram for IARCSPermits:
ISDKProperties

Public Member Functions

virtual SDKResult SDK_CALLTYPE SetDongle (const IARCSDongleSP &dongle)=0 throw ()
 Set the dongle. More...
 
virtual SDKResult SDK_CALLTYPE SetPermits (const SDKString &permit_path)=0 throw ()
 Set permits from the path. More...
 
virtual SDKResult SDK_CALLTYPE EnumPermits (SDK_NAMESPACE::IEnumSDKComponentSP &permits) const =0 throw ()
 Enumerates the chart permits. 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 methods for permit management.

Member Function Documentation

◆ SetDongle()

virtual SDKResult SDK_CALLTYPE SetDongle ( const IARCSDongleSP &  dongle)
throw (
)
pure virtual

Set the dongle.

Parameters
dongle[in] The dongle.
Returns
kSDKResult_Succeeded
kSDKResult_NotImplemented

◆ SetPermits()

virtual SDKResult SDK_CALLTYPE SetPermits ( const SDKString &  permit_path)
throw (
)
pure virtual

Set permits from the path.

Parameters
permit_path[in] Path to the permit file.
Returns
kSDKResult_Succeeded
kSDKResult_NotImplemented

◆ EnumPermits()

virtual SDKResult SDK_CALLTYPE EnumPermits ( SDK_NAMESPACE::IEnumSDKComponentSP &  permits) const
throw (
)
pure virtual

Enumerates the chart permits.

Parameters
permits[out] Address of a variable that receives the pointer to the chart permits enumerator.
Returns
kSDKResult_Succeeded
kSDKResult_NotImplemented

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