NavBox REST client Data layers provider. More...

#include <navbox_client_interfaces.h>

Inheritance diagram for INavBoxDataLayersClient:

Public Member Functions
virtual SDKResult SDK_CALLTYPE	GetAllLayers (ICollectionSDKComponentSP &data_layers, bool include_removed=false) const =0 throw ()
	Returns data layers supported by NavBox REST server. More...

virtual SDKResult SDK_CALLTYPE	CreateLayer (INavBoxDataLayerSP &data_layer) const =0 throw ()
	Create data layer on NavBox REST server. More...

virtual SDKResult SDK_CALLTYPE	UpdateLayer (const SDKString &layer_id, const INavBoxDataLayerSP &updated_data_layer) const =0 throw ()
	Update data layer on NavBox REST server. More...

virtual SDKResult SDK_CALLTYPE	DeleteLayer (const SDKString &layer_id) const =0 throw ()
	Delete data layer on NavBox REST server. More...

virtual SDKResult SDK_CALLTYPE	GetAllAttachments (ICollectionSDKComponentSP &attachments) const =0 throw ()
	Returns data layers supported by NavBox REST server. More...

virtual SDKResult SDK_CALLTYPE	CreateAttachment (INavBoxDataObjectAttachmentInfoSP &attachment, const SDKArray &attachment_content) const =0 throw ()
	Create attachment on NavBox REST server. More...

virtual SDKResult SDK_CALLTYPE	GetAttachment (const SDKString &attachment_id, SDKArray &attachment_content) const =0 throw ()
	Returns attachment content from NavBox REST server. More...

virtual SDKResult SDK_CALLTYPE	UpdateAttachment (const SDKString &attachment_id, INavBoxDataObjectAttachmentInfoSP &attachment, const SDKArray &attachment_content) const =0 throw ()
	Update attachment on NavBox REST server. More...

virtual SDKResult SDK_CALLTYPE	GetDataObjectsInLayer (const SDKString &layer_id, DataObjectsExtractionMode mode, ICollectionSDKComponentSP &data_objects) const =0 throw ()
	Returns data objects from layer on NavBox REST server. More...

virtual SDKResult SDK_CALLTYPE	GetDataObjectsInLayer (const SDKString &layer_id, SDKString &data_objects_json) const =0 throw ()
	Returns data objects from layer on NavBox REST server. More...

virtual SDKResult SDK_CALLTYPE	GetDataObject (const SDKString &object_id, DataObjectsExtractionMode mode, INavBoxDataObjectSP &data_object) const =0 throw ()
	Returns data object from NavBox REST server. More...

virtual SDKResult SDK_CALLTYPE	CreateDataObject (const SDKString &layer_id, INavBoxDataObjectSP &data_object) const =0 throw ()
	Create data object on NavBox REST server. More...

virtual SDKResult SDK_CALLTYPE	UpdateDataObject (const SDKString &object_id, INavBoxDataObjectSP &data_object) const =0 throw ()
	Update data object on NavBox REST server. More...

virtual SDKResult SDK_CALLTYPE	DeleteDataObject (const SDKString &object_id) const =0 throw ()
	Delete data object from layer on NavBox REST server. More...

virtual SDKResult SDK_CALLTYPE	GetDataLayerSENCFiles (const SDKString &layer_id, IFileStreamFileInfoListSP &senc_file_info_list) const =0 throw ()
	Returns collection of data layer SENC files. More...

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

virtual SDKResult SDK_CALLTYPE	OpenDataLayerSENCFileStream (const SDKString &layer_id, const SDKString &senc_file_pathname, SDK_BASE_NAMESPACE::SDKStreamSP &stream) const =0 throw ()
	Opens data layer SENC file read stream. More...

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

virtual SDKResult SDK_CALLTYPE	ExportDataLayer (const SDKString &layer_id, SDKString &expport_data_layer) const =0 throw ()
	Export data layer from NavBox REST server. More...

virtual SDKResult SDK_CALLTYPE	ImportDataLayer (const SDKString &import_data_layer, INavBoxDataLayerSP &data_layer) const =0 throw ()
	Import data layer to NavBox REST server. 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

NavBox REST client Data layers provider.

Member Function Documentation

◆ GetAllLayers()

virtual SDKResult SDK_CALLTYPE GetAllLayers	(	ICollectionSDKComponentSP &	data_layers,
		bool	include_removed = `false`
	)		const
throw	(
	)

pure virtual

Returns data layers supported by NavBox REST server.

Parameters

[out]	data_layers	Data layers supported by NavBox.
[in]	include_removed	True to include removed data layers in result.

◆ CreateLayer()

virtual SDKResult SDK_CALLTYPE CreateLayer	(	INavBoxDataLayerSP &	data_layer	)	const
throw	(
	)

pure virtual

Create data layer on NavBox REST server.

Parameters

[in] data_layer Data layer to create.

◆ UpdateLayer()

virtual SDKResult SDK_CALLTYPE UpdateLayer	(	const SDKString &	layer_id,
		const INavBoxDataLayerSP &	updated_data_layer
	)		const
throw	(
	)

pure virtual

Update data layer on NavBox REST server.

Parameters

[in]	layer_id	Data layer id.
[in]	updated_data_layer	Data layer to update.

◆ DeleteLayer()

virtual SDKResult SDK_CALLTYPE DeleteLayer	(	const SDKString &	layer_id	)	const
throw	(
	)

pure virtual

Delete data layer on NavBox REST server.

Parameters

[in] layer_id Data layer id.

◆ GetAllAttachments()

virtual SDKResult SDK_CALLTYPE GetAllAttachments	(	ICollectionSDKComponentSP &	attachments	)	const
throw	(
	)

pure virtual

Returns data layers supported by NavBox REST server.

Parameters

[out] attachments Attachments info from NavBox.

◆ CreateAttachment()

virtual SDKResult SDK_CALLTYPE CreateAttachment	(	INavBoxDataObjectAttachmentInfoSP &	attachment,
		const SDKArray &	attachment_content
	)		const
throw	(
	)

pure virtual

Create attachment on NavBox REST server.

Parameters

[in]	attachment	Attachment info to create.
[in]	attachment_content	Attachment content.

◆ GetAttachment()

virtual SDKResult SDK_CALLTYPE GetAttachment	(	const SDKString &	attachment_id,
		SDKArray &	attachment_content
	)		const
throw	(
	)

pure virtual

Returns attachment content from NavBox REST server.

Parameters

[in]	attachment_id	Attachment id.
[out]	updated_data_layer	Attachment content.

◆ UpdateAttachment()

virtual SDKResult SDK_CALLTYPE UpdateAttachment	(	const SDKString &	attachment_id,
		INavBoxDataObjectAttachmentInfoSP &	attachment,
		const SDKArray &	attachment_content
	)		const
throw	(
	)

pure virtual

Update attachment on NavBox REST server.

Parameters

[in]	attachment	Attachment info to update.
[in]	attachment_content	Attachment content.

◆ GetDataObjectsInLayer() [1/2]

virtual SDKResult SDK_CALLTYPE GetDataObjectsInLayer	(	const SDKString &	layer_id,
		DataObjectsExtractionMode	mode,
		ICollectionSDKComponentSP &	data_objects
	)		const
throw	(
	)

pure virtual

Returns data objects from layer on NavBox REST server.

Parameters

[in]	layer_id	Data layer id.
[out]	data_objects	Data objects from NavBox.

◆ GetDataObjectsInLayer() [2/2]

virtual SDKResult SDK_CALLTYPE GetDataObjectsInLayer	(	const SDKString &	layer_id,
		SDKString &	data_objects_json
	)		const
throw	(
	)

pure virtual

Returns data objects from layer on NavBox REST server.

Parameters

[in]	layer_id	Data layer id.
[out]	data_objects_json	Data objects full JSON from NavBox.

◆ GetDataObject()

virtual SDKResult SDK_CALLTYPE GetDataObject	(	const SDKString &	object_id,
		DataObjectsExtractionMode	mode,
		INavBoxDataObjectSP &	data_object
	)		const
throw	(
	)

pure virtual

Returns data object from NavBox REST server.

Parameters

[in]	object_id	Data object id.
[in]	mode	Data object retrieving mode.
[out]	data_object	Data object.

◆ CreateDataObject()

virtual SDKResult SDK_CALLTYPE CreateDataObject	(	const SDKString &	layer_id,
		INavBoxDataObjectSP &	data_object
	)		const
throw	(
	)

pure virtual

Create data object on NavBox REST server.

Parameters

[in]	layer_id	Data layer id.
[in,out]	data_object	Data object to create.

◆ UpdateDataObject()

virtual SDKResult SDK_CALLTYPE UpdateDataObject	(	const SDKString &	object_id,
		INavBoxDataObjectSP &	data_object
	)		const
throw	(
	)

pure virtual

Update data object on NavBox REST server.

Parameters

[in]	object_id	Data object id.
[in,out]	data_object	Data object to update.

◆ DeleteDataObject()

virtual SDKResult SDK_CALLTYPE DeleteDataObject	(	const SDKString &	object_id	)	const
throw	(
	)

pure virtual

Delete data object from layer on NavBox REST server.

Parameters

[in] object_id Data object id.

◆ GetDataLayerSENCFiles()

virtual SDKResult SDK_CALLTYPE GetDataLayerSENCFiles	(	const SDKString &	layer_id,
		IFileStreamFileInfoListSP &	senc_file_info_list
	)		const
throw	(
	)

pure virtual

Returns collection of data layer SENC files.

Parameters

[in]	layer_id	Data layer id.
[out]	senc_file_info_list	A reference to a variable that receives a pointer to INavBoxFileInfoList.

Returns: kSDKResult_Succeeded; kSDKResult_AccessDenied; kSDKResult_NotFound

◆ GetDataLayerSENCFileInfo()

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

pure virtual

Returns data layer SENC file info.

Parameters

[in]	layer_id	Data layer id.
[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

◆ OpenDataLayerSENCFileStream()

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

pure virtual

Opens data layer SENC file read stream.

Parameters

[in]	layer_id	Data layer id.
[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

◆ GetDataLayerSENCResourceStorage()

virtual SDKResult SDK_CALLTYPE GetDataLayerSENCResourceStorage	(	const SDKString &	layer_id,
		base::SDKResourceStorageSP &	storage
	)
throw	(
	)

pure virtual

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

Parameters

[in]	layer_id	Data layer id.
[out]	storage	A reference to a variable that receives a pointer to SDKResourceStorage.

Returns: kSDKResult_Succeeded; kSDKResult_AccessDenied; kSDKResult_NotFound

◆ ExportDataLayer()

virtual SDKResult SDK_CALLTYPE ExportDataLayer	(	const SDKString &	layer_id,
		SDKString &	expport_data_layer
	)		const
throw	(
	)

pure virtual

Export data layer from NavBox REST server.

Parameters

[in]	layer_id	Data layer id.
[out]	expport_data_layer	Data layer exprted data.

◆ ImportDataLayer()

virtual SDKResult SDK_CALLTYPE ImportDataLayer	(	const SDKString &	import_data_layer,
		INavBoxDataLayerSP &	data_layer
	)		const
throw	(
	)

pure virtual

Import data layer to NavBox REST server.

Parameters

[in]	import_data_layer	Data layer importing data.
[out]	data_layer	Imported data layer.

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

navbox_client_interfaces.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ GetAllLayers()

◆ CreateLayer()

◆ UpdateLayer()

◆ DeleteLayer()

◆ GetAllAttachments()

◆ CreateAttachment()

◆ GetAttachment()

◆ UpdateAttachment()

◆ GetDataObjectsInLayer() [1/2]

◆ GetDataObjectsInLayer() [2/2]

◆ GetDataObject()

◆ CreateDataObject()

◆ UpdateDataObject()

◆ DeleteDataObject()

◆ GetDataLayerSENCFiles()

◆ GetDataLayerSENCFileInfo()

◆ OpenDataLayerSENCFileStream()

◆ GetDataLayerSENCResourceStorage()

◆ ExportDataLayer()

◆ ImportDataLayer()