NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
Public Member Functions
IS63CellPermitsReaderWriter Class Referenceabstract
Data Layer » S63 Database » Cell Permits

Interface for reading/writing S63 cell permit files. More...

#include <s63_cell_permits_reader_writer_interface.h>

Inheritance diagram for IS63CellPermitsReaderWriter:
ISDKNamedProperties IS63CellPermitsReaderWriterUtils

Public Member Functions

virtual SDKResult SDK_CALLTYPE LoadCellPermits (const sdk::base::SDKStreamSP &stream, const sdk::crypt::CryptoKeySP &crypto_key, const sdk::crypt::BaseCryptorSP &cryptor, sdk::s63::S63CellPermitsStorageSP &storage, SDKTime &permits_date, S63CellPermitsFileFormat &file_format) const =0 throw ()
 Loads the cell permits list from a specified stream and creates an S63CellPermitsStorageSP instance. More...
 
virtual SDKResult SDK_CALLTYPE LoadCellPermitsLazy (const sdk::base::SDKStreamSP &stream, const sdk::crypt::CryptoKeySP &crypto_key, const sdk::crypt::BaseCryptorSP &cryptor, sdk::s63::S63CellPermitsStorageSP &storage, SDKTime &permits_date, S63CellPermitsFileFormat &file_format) const =0 throw ()
 Lazy-loads the cell permits list from a specified stream and creates an S63CellPermitsStorageSP instance. Does not decrypt all of permits at once, decrypts them by call only.
 
virtual SDKResult SDK_CALLTYPE SaveCellPermits (const sdk::s63::S63CellPermitsStorageSP &storage, const sdk::crypt::CryptoKeySP &crypto_key, const sdk::crypt::BaseCryptorSP &cryptor, const SDKTime &permits_date_time, const S63CellPermitsFileFormat &file_format, const sdk::base::SDKStreamSP &stream) const =0 throw ()
 Saves the cell permits data to a specified stream, encodes them using the new crypto key.
 
virtual SDKResult SDK_CALLTYPE SaveOriginalCellPermits (const sdk::s63::S63CellPermitsStorageSP &storage, const sdk::base::SDKStreamSP &stream) const =0 throw ()
 Saves the cell permits data to a specified stream without decoding/encoding them, just stores the original strings from the original permit file. (The permits storage should implement the kS63CellPermitsStorageProp_PermitsDateTime kS63CellPermitsStorageProp_PermitsFileVersion kS63CellPermitsStorageProp_OfficialPermitsStringsIterator kS63CellPermitsStorageProp_NonOfficialPermitsStringsIterator properties).
 
- Public Member Functions inherited from ISDKNamedProperties
virtual SDKResult SDK_CALLTYPE SetProperty (const SDKString &id, const SDKAny &value)=0 throw ()
 Sets a property value.
 
virtual SDKResult SDK_CALLTYPE GetProperty (const SDKString &id, SDKAny &value) const =0 throw ()
 Retrieves a property value.
 

Detailed Description

Interface for reading/writing S63 cell permit files.

Member Function Documentation

◆ LoadCellPermits()

virtual SDKResult SDK_CALLTYPE LoadCellPermits ( const sdk::base::SDKStreamSP &  stream,
const sdk::crypt::CryptoKeySP &  crypto_key,
const sdk::crypt::BaseCryptorSP &  cryptor,
sdk::s63::S63CellPermitsStorageSP &  storage,
SDKTime &  permits_date,
S63CellPermitsFileFormat &  file_format 
) const
throw (
)
pure virtual

Loads the cell permits list from a specified stream and creates an S63CellPermitsStorageSP instance.

All of permit entries will be decrypted and checked during this call, in case of any corrupted permits, the appropriate SSE error will be returned, no permits storage will be produced in this case.

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