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

Utilities interface of S-63 cell permits file reader/writer. More...

#include <s63_cell_permits_reader_writer_interface.h>

Inheritance diagram for IS63CellPermitsReaderWriterUtils:
IS63CellPermitsReaderWriter ISDKNamedProperties

Public Member Functions

virtual SDKResult FindPermitsFile (const SDKString &folder_path, const HW_ID &hw_id, SDKString &permits_file_path) const =0 throw ()
 Finds a proper permits file in a filesystem folder using a known HW_ID.
 
virtual SDKResult FindPermitsInStorage (const base::SDKResourceStorageSP &storage, const HW_ID &hw_id, base::SDKResourceSP &permits_resource) const =0 throw ()
 Finds proper permits in a specified storage using a specified HW_ID. More...
 
- Public Member Functions inherited from IS63CellPermitsReaderWriter
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

Utilities interface of S-63 cell permits file reader/writer.

Member Function Documentation

◆ FindPermitsInStorage()

virtual SDKResult FindPermitsInStorage ( const base::SDKResourceStorageSP &  storage,
const HW_ID &  hw_id,
base::SDKResourceSP &  permits_resource 
) const
throw (
)
pure virtual

Finds proper permits in a specified storage using a specified HW_ID.

Parameters
storage[in] Up level storage
hw_id[in] HW_ID
permits_resource[out] permits resource
Returns
kSDKResult_Succeeded
S63 errors
The documentation for this class was generated from the following file: