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

ECDIS server service callback interface. More...

#include <navbox_client_interfaces.h>

Inheritance diagram for IECDISServiceServerCallback:
ISDKComponent

Public Member Functions

virtual SDKResult SDK_CALLTYPE EnumSupportedRouteFormats (ICollectionSDKStringSP &formats) const =0 throw ()
 Returns list of route formats supported by ECDIS. More...
 
virtual SDKResult SDK_CALLTYPE EnumRoutes (INavBoxFileInfoListSP &routes) const =0 throw ()
 Returns list of ECDIS routes. More...
 
virtual SDKResult SDK_CALLTYPE LoadRoute (const SDKString &route_name, const SDKString &route_format, SDKArray &route_content) const =0 throw ()
 Load the content of the specified route. More...
 
virtual SDKResult SDK_CALLTYPE SaveRoute (const SDKString &route_name, const SDKString &route_format, const SDKArray &route_content) const =0 throw ()
 Save the content of the specified route. 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

ECDIS server service callback interface.

Member Function Documentation

◆ EnumSupportedRouteFormats()

virtual SDKResult SDK_CALLTYPE EnumSupportedRouteFormats ( ICollectionSDKStringSP &  formats) const
throw (
)
pure virtual

Returns list of route formats supported by ECDIS.

Parameters
formats[out] Address of a variable that receives the pointer to the collection of supported route formats.

◆ EnumRoutes()

virtual SDKResult SDK_CALLTYPE EnumRoutes ( INavBoxFileInfoListSP &  routes) const
throw (
)
pure virtual

Returns list of ECDIS routes.

Parameters
routes[out] Address of a variable that receives the pointer to the collection of route descriptions.

◆ LoadRoute()

virtual SDKResult SDK_CALLTYPE LoadRoute ( const SDKString &  route_name,
const SDKString &  route_format,
SDKArray &  route_content 
) const
throw (
)
pure virtual

Load the content of the specified route.

Parameters
route_name[in] The route name.
route_format[in] The route format.
route_content[out] The address of a variable that receives the route content.

◆ SaveRoute()

virtual SDKResult SDK_CALLTYPE SaveRoute ( const SDKString &  route_name,
const SDKString &  route_format,
const SDKArray &  route_content 
) const
throw (
)
pure virtual

Save the content of the specified route.

Parameters
route_name[in] The route name.
route_format[in] The route format.
route_content[in] The route content.
The documentation for this class was generated from the following file: