NavBox REST client Provides access to INavBoxRESTClient. More...

#include <navbox_client_interfaces.h>

Inherits ISDKProperties.

Public Member Functions
virtual SDKResult SDK_CALLTYPE	GetNavBoxInfo (INavBoxRESTInfoSP &navbox_info) const =0 throw ()
	Returns NavBox information. More...

virtual SDKResult SDK_CALLTYPE	GetRoutes (ICollectionSDKComponentSP &routes) const =0 throw ()
	Returns a list of routes located on the NavBox. More...

virtual SDKResult SDK_CALLTYPE	GetRoute (const SDKString &route_id, const SDKString &route_format, SDKArray &route_file_content) const =0 throw ()
	Returns a route from the NavBox. More...

virtual SDKResult SDK_CALLTYPE	CreateRoute (const SDKString &route_id, const SDKString &route_format, const SDKArray &route_file_content) const =0 throw ()
	Creates a route in the NavBox. More...

virtual SDKResult SDK_CALLTYPE	UpdateRoute (const SDKString &route_id, const SDKString &route_format, const SDKArray &route_file_content) const =0 throw ()
	Updates a route in the NavBox. More...

virtual SDKResult SDK_CALLTYPE	DeleteRoute (const SDKString &route_id) const =0 throw ()
	Deletes a route from the NavBox. More...

virtual SDKResult SDK_CALLTYPE	GetENCSerial (SDKArray &enc_serial_file) const =0 throw ()
	Returns ENC Serial File. More...

virtual SDKResult SDK_CALLTYPE	GetENCCatalog (SDKArray &catalog) const =0 throw ()
	Returns ENC catalog. More...

virtual SDKResult SDK_CALLTYPE	GetENCProducts (SDKArray &products) const =0 throw ()
	Returns ENC PRODUCTS.TXT. More...

virtual SDKResult SDK_CALLTYPE	GetENCPermits (const SDKString &sub_path, INavBoxFileInfoListSP &permits_file_info_list) const =0 throw ()
	Returns ENC permit path list. More...

virtual SDKResult SDK_CALLTYPE	GetENCPermit (const SDKString &permit_file_pathname, SDKArray &permit_content) const =0 throw ()
	Returns ENC permit content. More...

virtual SDKResult SDK_CALLTYPE	GetENCData (const SDKString &file_path_name, SDKArray &file_content) const =0 throw ()
	Returns ENC data. More...

virtual SDKResult SDK_CALLTYPE	GetSENCFiles (const SDKString &sub_path, IFileStreamFileInfoListSP &senc_file_info_list) const =0 throw ()
	Returns collection of SENC files. More...

virtual SDKResult SDK_CALLTYPE	GetSENCFileInfo (const SDKString &senc_file_pathname, IFileStreamFileInfoSP &senc_file_info) const =0 throw ()
	Returns SENC file info. More...

virtual SDKResult SDK_CALLTYPE	OpenSENCFileStream (const SDKString &senc_file_pathname, SDK_BASE_NAMESPACE::SDKStreamSP &stream) const =0 throw ()
	Opens file read stream. More...

virtual SDKResult SDK_CALLTYPE	GetSENCResourceStorage (base::SDKResourceStorageSP &storage)=0 throw ()
	Creates resource storage at SENC root. The resource storage can be used instead of 3 previous calls. It provides more general way to access SENC. More...

virtual SDKResult SDK_CALLTYPE	SetCallback (const INavBoxRESTCallbacksSP &listener)=0 throw ()
	Attaches callback to the client. More...

virtual SDKResult SDK_CALLTYPE	CheckConnection () const =0 throw ()
	Method returns Ok if server is accessible.

Detailed Description

NavBox REST client Provides access to INavBoxRESTClient.

Member Function Documentation

◆ GetNavBoxInfo()

virtual SDKResult SDK_CALLTYPE GetNavBoxInfo	(	INavBoxRESTInfoSP &	navbox_info	)	const
throw	(
	)

pure virtual

Returns NavBox information.

Parameters

[out] navbox_info A reference to a variable that receives a pointer to INavBoxRESTInfo.

Returns: kSDKResult_Succeeded; kSDKResult_AccessDenied; kSDKResult_NotFound

◆ GetRoutes()

virtual SDKResult SDK_CALLTYPE GetRoutes	(	ICollectionSDKComponentSP &	routes	)	const
throw	(
	)

pure virtual

Returns a list of routes located on the NavBox.

Parameters

[out] routes A reference to a variable that receives a pointer to ICollectionSDKComponent.

Returns: kSDKResult_Succeeded; kSDKResult_AccessDenied; kSDKResult_NotFound

◆ GetRoute()

virtual SDKResult SDK_CALLTYPE GetRoute	(	const SDKString &	route_id,
		const SDKString &	route_format,
		SDKArray &	route_file_content
	)		const
throw	(
	)

pure virtual

Returns a route from the NavBox.

Parameters

[in]	route_id	Route identifier.
[in]	route_format	The route format in which to return the route. Routes formats specified in sdk/ecdislayer/inc/route_planning/route_storage_interfaces.h, see kRouteFormatTable.
[out]	route_file_content	A reference to a variable that receives the route file content.

Returns: kSDKResult_Succeeded; kSDKResult_AccessDenied; kSDKResult_NotFound

◆ CreateRoute()

virtual SDKResult SDK_CALLTYPE CreateRoute	(	const SDKString &	route_id,
		const SDKString &	route_format,
		const SDKArray &	route_file_content
	)		const
throw	(
	)

pure virtual

Creates a route in the NavBox.

Parameters

[in]	route_id	Route identifier.
[in]	route_format	The route format in which to return the route. Routes formats specified in sdk/ecdislayer/inc/route_planning/route_storage_interfaces.h, see kRouteFormatTable.
[out]	route_file_content	A reference to the route file content.

Returns: kSDKResult_Succeeded; kSDKResult_AccessDenied; kSDKResult_NotFound

◆ UpdateRoute()

virtual SDKResult SDK_CALLTYPE UpdateRoute	(	const SDKString &	route_id,
		const SDKString &	route_format,
		const SDKArray &	route_file_content
	)		const
throw	(
	)

pure virtual

Updates a route in the NavBox.

Parameters

[in]	route_id	Route identifier.
[in]	route_format	The route format in which to return the route. Routes formats specified in sdk/ecdislayer/inc/route_planning/route_storage_interfaces.h, see kRouteFormatTable.
[out]	route_file_content	A reference to the route content.

Returns: kSDKResult_Succeeded; kSDKResult_AccessDenied; kSDKResult_NotFound

◆ DeleteRoute()

virtual SDKResult SDK_CALLTYPE DeleteRoute	(	const SDKString &	route_id	)	const
throw	(
	)

pure virtual

Deletes a route from the NavBox.

Parameters

[in] route_id Route identifier.

Returns: kSDKResult_Succeeded; kSDKResult_AccessDenied; kSDKResult_NotFound

◆ GetENCSerial()

virtual SDKResult SDK_CALLTYPE GetENCSerial	(	SDKArray &	enc_serial_file	)	const
throw	(
	)

pure virtual

Returns ENC Serial File.

Parameters

[out] enc_serial_file A reference to a variable that receives SERIAL.ENC content.

Returns: kSDKResult_Succeeded; kSDKResult_AccessDenied; kSDKResult_NotFound

◆ GetENCCatalog()

virtual SDKResult SDK_CALLTYPE GetENCCatalog	(	SDKArray &	catalog	)	const
throw	(
	)

pure virtual

Returns ENC catalog.

Parameters

[out] serial_enc A reference to a variable that receives the catalog content.

Returns: kSDKResult_Succeeded; kSDKResult_AccessDenied; kSDKResult_NotFound

◆ GetENCProducts()

virtual SDKResult SDK_CALLTYPE GetENCProducts	(	SDKArray &	products	)	const
throw	(
	)

pure virtual

Returns ENC PRODUCTS.TXT.

Parameters

[out] products A reference to a variable that receives PRODUCTS.TXT content.

Returns: kSDKResult_Succeeded; kSDKResult_AccessDenied; kSDKResult_NotFound

◆ GetENCPermits()

virtual SDKResult SDK_CALLTYPE GetENCPermits	(	const SDKString &	sub_path,
		INavBoxFileInfoListSP &	permits_file_info_list
	)		const
throw	(
	)

pure virtual

Returns ENC permit path list.

Parameters

[in]	sub_path	A path relative from permits root path. Empty string or "." specifies the root path of permits.
[out]	permits_file_info_list	A reference to a variable that receives a pointer to INavBoxFileInfoList.

Returns: kSDKResult_Succeeded; kSDKResult_AccessDenied; kSDKResult_NotFound

◆ GetENCPermit()

virtual SDKResult SDK_CALLTYPE GetENCPermit	(	const SDKString &	permit_file_pathname,
		SDKArray &	permit_content
	)		const
throw	(
	)

pure virtual

Returns ENC permit content.

Parameters

[in]	permit_file_pathname	The permit path name that relative from the root path of permits returned in GetENCPermits.
[out]	permit_content	A reference to a variable that receives the permit content.

Returns: kSDKResult_Succeeded; kSDKResult_AccessDenied; kSDKResult_NotFound

◆ GetENCData()

virtual SDKResult SDK_CALLTYPE GetENCData	(	const SDKString &	file_path_name,
		SDKArray &	file_content
	)		const
throw	(
	)

pure virtual

Returns ENC data.

Parameters

[in]	file_path_name	The ENC file path name that relative from the root path of ENC.
[out]	file_content	A reference to a variable that receives the ENC file content.

Returns: kSDKResult_Succeeded; kSDKResult_AccessDenied; kSDKResult_NotFound

◆ GetSENCFiles()

virtual SDKResult SDK_CALLTYPE GetSENCFiles	(	const SDKString &	sub_path,
		IFileStreamFileInfoListSP &	senc_file_info_list
	)		const
throw	(
	)

pure virtual

Returns collection of SENC files.

Parameters

[in]	sub_path	A path relative from SENC root path. Empty string specifies the SENC root path.
[out]	senc_file_info_list	A reference to a variable that receives a pointer to INavBoxFileInfoList.

Returns: kSDKResult_Succeeded; kSDKResult_AccessDenied; kSDKResult_NotFound

◆ GetSENCFileInfo()

virtual SDKResult SDK_CALLTYPE GetSENCFileInfo	(	const SDKString &	senc_file_pathname,
		IFileStreamFileInfoSP &	senc_file_info
	)		const
throw	(
	)

pure virtual

Returns SENC file info.

Parameters

[in]	senc_file_pathname	The SENC file path name that relative from the root path of SENC returned in GetSENCFiles.
[out]	senc_file_info	A reference to a variable that receives a pointer to IFileStreamFileInfo.

Returns: kSDKResult_Succeeded; kSDKResult_AccessDenied; kSDKResult_NotFound

◆ OpenSENCFileStream()

virtual SDKResult SDK_CALLTYPE OpenSENCFileStream	(	const SDKString &	senc_file_pathname,
		SDK_BASE_NAMESPACE::SDKStreamSP &	stream
	)		const
throw	(
	)

pure virtual

Opens file read stream.

Parameters

[in]	senc_file_pathname	The SENC file path name that relative from the root path of SENC returned in GetSENCFileInfo.
[out]	stream	A reference to a variable that receives a pointer to SDKStream.

Returns: kSDKResult_Succeeded; kSDKResult_AccessDenied; kSDKResult_NotFound

◆ GetSENCResourceStorage()

virtual SDKResult SDK_CALLTYPE GetSENCResourceStorage	(	base::SDKResourceStorageSP &	storage	)
throw	(
	)

pure virtual

Creates resource storage at SENC root. The resource storage can be used instead of 3 previous calls. It provides more general way to access SENC.

Parameters

[out] storage A reference to a variable that receives a pointer to SDKResourceStorage.

Returns: kSDKResult_Succeeded; kSDKResult_AccessDenied; kSDKResult_NotFound

◆ SetCallback()

virtual SDKResult SDK_CALLTYPE SetCallback	(	const INavBoxRESTCallbacksSP &	listener	)
throw	(
	)

pure virtual

Attaches callback to the client.

Parameters

[in] listener A pointer to INavBoxRESTCallbacks. See INavBoxRESTCallbacks for details.

Returns: kSDKResult_Succeeded; kSDKResult_AccessDenied; kSDKResult_NotFound

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

navbox_client_interfaces.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ GetNavBoxInfo()

◆ GetRoutes()

◆ GetRoute()

◆ CreateRoute()

◆ UpdateRoute()

◆ DeleteRoute()

◆ GetENCSerial()

◆ GetENCCatalog()

◆ GetENCProducts()

◆ GetENCPermits()

◆ GetENCPermit()

◆ GetENCData()

◆ GetSENCFiles()

◆ GetSENCFileInfo()

◆ OpenSENCFileStream()

◆ GetSENCResourceStorage()

◆ SetCallback()