SLAMTEC Aurora Public Remote SDK  1.2.0-rtm

Functions for managing and manipulating map data. More...

Functions

slamtec_aurora_sdk_errorcode_t AURORA_SDK_API slamtec_aurora_sdk_mapmanager_start_storage_session (slamtec_aurora_sdk_session_handle_t handle, const char *map_file_name, slamtec_aurora_sdk_mapstorage_session_type_t session_type, slamtec_aurora_sdk_mapstorage_session_result_callback_t callback, void *user_data)
 Start a map storage session. More...
 
void AURORA_SDK_API slamtec_aurora_sdk_mapmanager_abort_session (slamtec_aurora_sdk_session_handle_t handle)
 Abort the current map storage session. More...
 
int AURORA_SDK_API slamtec_aurora_sdk_mapmanager_is_storage_session_active (slamtec_aurora_sdk_session_handle_t handle)
 Check if the map storage session is in progress. More...
 
slamtec_aurora_sdk_errorcode_t AURORA_SDK_API slamtec_aurora_sdk_mapmanager_query_storage_status (slamtec_aurora_sdk_session_handle_t handle, slamtec_aurora_sdk_mapstorage_session_status_t *progress_out)
 Query the progress of the current map storage session. More...
 

Detailed Description

Functions for managing and manipulating map data.

Function Documentation

◆ slamtec_aurora_sdk_mapmanager_abort_session()

void AURORA_SDK_API slamtec_aurora_sdk_mapmanager_abort_session ( slamtec_aurora_sdk_session_handle_t  handle)

Abort the current map storage session.

Caller can use this function to abort the current map storage session.

If a map storage session is not created by the current SDK instance, the request will be rejected.

Parameters
handle- the session handle

◆ slamtec_aurora_sdk_mapmanager_is_storage_session_active()

int AURORA_SDK_API slamtec_aurora_sdk_mapmanager_is_storage_session_active ( slamtec_aurora_sdk_session_handle_t  handle)

Check if the map storage session is in progress.

Caller can use this function to check if the map storage session is still in progress.

Parameters
handle- the session handle
Returns
non-zero means active

◆ slamtec_aurora_sdk_mapmanager_query_storage_status()

slamtec_aurora_sdk_errorcode_t AURORA_SDK_API slamtec_aurora_sdk_mapmanager_query_storage_status ( slamtec_aurora_sdk_session_handle_t  handle,
slamtec_aurora_sdk_mapstorage_session_status_t progress_out 
)

Query the progress of the current map storage session.

Caller can use this function to query the progress of the map saving or loading operation from the remote Device.

Parameters
handle- the session handle
progress_out- the progress will be stored in this pointer
Returns
the error code

◆ slamtec_aurora_sdk_mapmanager_start_storage_session()

slamtec_aurora_sdk_errorcode_t AURORA_SDK_API slamtec_aurora_sdk_mapmanager_start_storage_session ( slamtec_aurora_sdk_session_handle_t  handle,
const char *  map_file_name,
slamtec_aurora_sdk_mapstorage_session_type_t  session_type,
slamtec_aurora_sdk_mapstorage_session_result_callback_t  callback,
void *  user_data 
)

Start a map storage session.

Ask the remote Device to start a map storage session.

If there is already an active map storage session, the new request will be rejected.

NOTICE: the SDK will enter low rate mode during the working session to reduce the data traffic

the low rate mode will be automatically disabled after the map streaming operation is done

Parameters
handle- the session handle
map_file_name- the name of the map file to be stored or to be loaded
session_type- the type of the map storage session, e.g. Load or Store.
Refer to slamtec_aurora_sdk_mapstorage_session_type_t for more details
callback- the callback function to be called when the map storage session is completed. The operation result will be passed to the callback function
user_data- the user data to be passed to the callback function
Returns
the error code