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

The SENC Builder callback interface. This interface is used to get the SENC builder processing reports. Defined in datalayer/inc/senc_builder/senc_builder_interface.h. More...

#include <senc_builder_interface.h>

Inheritance diagram for ISENCBuilderCallback:
ISDKComponent

Public Types

enum  MessageLevel
 The S-57 to SENC converter message notifier. More...
 

Public Member Functions

virtual SDKResult SDK_CALLTYPE OnProgress (const SENCBuilderStage &stage, const SDKUInt32 &curr_stage, const SDKUInt32 &total_stages, const SDKUInt32 &percentage_completed, bool &abort_operation)=0 throw ()
 Notifies a client about the SENC builder processing progress. More...
 
virtual SDKResult SDK_CALLTYPE OnSENCBuilderMessage (const SDKResult &sse_result, const SDKString &cell_name)=0 throw ()
 The SENC Builder message notifier. More...
 
virtual SDKResult SDK_CALLTYPE OnMakeSENCToolMessage (const bool &is_error, const SDKString &message)=0 throw ()
 The Make SENC tool message notifier. 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

The SENC Builder callback interface. This interface is used to get the SENC builder processing reports. Defined in datalayer/inc/senc_builder/senc_builder_interface.h.

Member Enumeration Documentation

◆ MessageLevel

The S-57 to SENC converter message notifier.

Parameters
[in]message_levelAn error level indicator. 0 - INFO, 1 - ERROR, 2 - WARNING
[in]messageThe message.

Member Function Documentation

◆ OnProgress()

virtual SDKResult SDK_CALLTYPE OnProgress ( const SENCBuilderStage &  stage,
const SDKUInt32 &  curr_stage,
const SDKUInt32 &  total_stages,
const SDKUInt32 &  percentage_completed,
bool &  abort_operation 
)
throw (
)
pure virtual

Notifies a client about the SENC builder processing progress.

Parameters
[in]stageThe current processing stage.
[in]curr_stageThe current stage index in the processing sequence.
[in]total_stagesThe number of the processing stages.
[in]percentage_completedThe complete percentage.
[out]abort_operationThe address of a variable that receives the abort signal from the client.
Returns
Not applicable

◆ OnSENCBuilderMessage()

virtual SDKResult SDK_CALLTYPE OnSENCBuilderMessage ( const SDKResult &  sse_result,
const SDKString &  cell_name 
)
throw (
)
pure virtual

The SENC Builder message notifier.

Parameters
[in]sse_resultSSE error message code.
[in]cell_nameThe cell name.

◆ OnMakeSENCToolMessage()

virtual SDKResult SDK_CALLTYPE OnMakeSENCToolMessage ( const bool &  is_error,
const SDKString &  message 
)
throw (
)
pure virtual

The Make SENC tool message notifier.

Parameters
[in]is_errorAn error indicator. If it is true the message is an error message.
[in]messageThe message.

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