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

S-63 cell permits storage. More...

#include <s63_cell_permits_interface.h>

Inherits ISDKComponent.

Public Member Functions

virtual SDKResult SDK_CALLTYPE GetIterator (S63CellPermitsIteratorSP &iterator) const =0 throw ()
 Returns the cell permits iterator.
 
virtual SDKResult SDK_CALLTYPE GetCellPermits (const CellName &cell_name, const DataServerID &dataserver_id, S63CellPermitsIteratorSP &iterator) const =0 throw ()
 Returns a cell permit by the cell name and the dataserver ID. In case several permits with the specified cell name exist, the enumerator returns them all. More...
 
virtual SDKResult SDK_CALLTYPE FindPermits (const CellName &cell_name, const DataServerID &dataserver_id) const =0 throw ()
 Checks, if a cell permit entry exists and is valid. More...
 

Detailed Description

S-63 cell permits storage.

Member Function Documentation

◆ GetCellPermits()

virtual SDKResult SDK_CALLTYPE GetCellPermits ( const CellName &  cell_name,
const DataServerID &  dataserver_id,
S63CellPermitsIteratorSP &  iterator 
) const
throw (
)
pure virtual

Returns a cell permit by the cell name and the dataserver ID. In case several permits with the specified cell name exist, the enumerator returns them all.

Permits in the enumerator are sorted by dataserver ID, i.e. if the dataserver ID is PM, permits with the PM dataserver ID will be first and permits with an unknown dataserver ID will be last in the iterator. It is allowed passing an unknown dataserver ID to the method: in this case, the method returns all available permits for the specified cell.

◆ FindPermits()

virtual SDKResult SDK_CALLTYPE FindPermits ( const CellName &  cell_name,
const DataServerID &  dataserver_id 
) const
throw (
)
pure virtual

Checks, if a cell permit entry exists and is valid.

Parameters
[in]cell_nameThe cell name.
[in]dataserver_idThe Dataserver ID.
Returns
kSDKResult_Succeeded if the record was found.
kSDKResult_NotFound if the record was not found or is not valid.

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