rp::standalone::aurora::RemoteMapManager Class Reference

The map manager class for managing the map data. More...

#include <slamtec_remote_public.hxx>

Inheritance diagram for rp::standalone::aurora::RemoteMapManager:

Public Member Functions
bool	startUploadSession (const char *mapfilePath, slamtec_aurora_sdk_mapstorage_session_result_callback_t resultCallBack=nullptr, void *userData=nullptr, slamtec_aurora_sdk_errorcode_t *errCode=nullptr)
	Start an upload session. More...
bool	startDownloadSession (const char *mapfilePath, slamtec_aurora_sdk_mapstorage_session_result_callback_t resultCallBack=nullptr, void *userData=nullptr, slamtec_aurora_sdk_errorcode_t *errCode=nullptr)
	Start a download session. More...
bool	startSession (const char *mapfilePath, slamtec_aurora_sdk_mapstorage_session_type_t sessionType, slamtec_aurora_sdk_mapstorage_session_result_callback_t resultCallBack=nullptr, void *userData=nullptr, slamtec_aurora_sdk_errorcode_t *errCode=nullptr)
	Start a map streaming session. More...
bool	isSessionActive ()
	Check if the map streaming session is active. More...
void	abortSession ()
	Abort the map streaming session. More...
bool	querySessionStatus (slamtec_aurora_sdk_mapstorage_session_status_t &progressOut, slamtec_aurora_sdk_errorcode_t *errCode=nullptr)
	Query the status of the map streaming session. More...

Protected Member Functions
	RemoteMapManager (slamtec_aurora_sdk_session_handle_t &sdk)
Protected Member Functions inherited from rp::standalone::aurora::Noncopyable
	Noncopyable (const Noncopyable &)=delete
Noncopyable &	operator= (const Noncopyable &)=delete
	Noncopyable (Noncopyable &&)=default
Noncopyable &	operator= (Noncopyable &&)=default

Protected Attributes
slamtec_aurora_sdk_session_handle_t	_sdk

Friends
class	RemoteSDK

Detailed Description

The map manager class for managing the map data.

Use this class to upload or download the map to the remote device

The map data accessing provided by the RemoteDataProvider class is only for visualization

Member Function Documentation

abortSession()

void rp::standalone::aurora::RemoteMapManager::abortSession ( )

inline

Abort the map streaming session.

Abort the current map streaming session

If the session is created by other client, the abort operation will be rejected

isSessionActive()

bool rp::standalone::aurora::RemoteMapManager::isSessionActive ( )

inline

Check if the map streaming session is active.

Returns

True if the map streaming session is active, false otherwise

querySessionStatus()

bool rp::standalone::aurora::RemoteMapManager::querySessionStatus ( slamtec_aurora_sdk_mapstorage_session_status_t &  progressOut, slamtec_aurora_sdk_errorcode_t *  errCode = nullptr  )

inline

Query the status of the map streaming session.

Parameters

[out]	progressOut	The progress of the map streaming session
[out]	errCode	The error code, set to nullptr if not interested

Returns

True if the status is queried successfully, false otherwise

startDownloadSession()

bool rp::standalone::aurora::RemoteMapManager::startDownloadSession ( const char *  mapfilePath, slamtec_aurora_sdk_mapstorage_session_result_callback_t  resultCallBack = nullptr, void *  userData = nullptr, slamtec_aurora_sdk_errorcode_t *  errCode = nullptr  )

inline

Start a download session.

Start a download session to download the map file from the remote device

Parameters

[in]	mapfilePath	The path to the map file to download
[in]	resultCallBack	The callback function to receive the session result, set to nullptr if not interested
[in]	userData	The user data to pass to the callback function, set to nullptr if not interested
[out]	errCode	The error code, set to nullptr if not interested

Returns

True if the download session is started successfully, false otherwise

startSession()

bool rp::standalone::aurora::RemoteMapManager::startSession ( const char *  mapfilePath, slamtec_aurora_sdk_mapstorage_session_type_t  sessionType, slamtec_aurora_sdk_mapstorage_session_result_callback_t  resultCallBack = nullptr, void *  userData = nullptr, slamtec_aurora_sdk_errorcode_t *  errCode = nullptr  )

inline

Start a map streaming session.

Start a map streaming session to stream the map data from the remote device

Parameters

[in]	mapfilePath	The path to the map file to stream
[in]	sessionType	The type of the session to start
[in]	resultCallBack	The callback function to receive the session result, set to nullptr if not interested
[in]	userData	The user data to pass to the callback function, set to nullptr if not interested
[out]	errCode	The error code, set to nullptr if not interested

Returns

True if the map streaming session is started successfully, false otherwise

startUploadSession()

bool rp::standalone::aurora::RemoteMapManager::startUploadSession ( const char *  mapfilePath, slamtec_aurora_sdk_mapstorage_session_result_callback_t  resultCallBack = nullptr, void *  userData = nullptr, slamtec_aurora_sdk_errorcode_t *  errCode = nullptr  )

inline

Start an upload session.

Start an upload session to upload the map file to the remote device

It the device has already working on a map streaming session, the new upload session will be failed

The SDK will enter the low rate mode during the upload session to reduce the data traffic

The low rate mode will be automatically disabled after the upload session is done

Parameters

[in]	mapfilePath	The path to the map file to upload
[in]	resultCallBack	The callback function to receive the session result, set to nullptr if not interested
[in]	userData	The user data to pass to the callback function, set to nullptr if not interested
[out]	errCode	The error code, set to nullptr if not interested

Returns

True if the upload session is started successfully, false otherwise

---

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

• inc/cxx/slamtec_remote_public.hxx