rp::standalone::aurora::RemoteSDK Class Reference

The main class for the remote SDK. More...

#include <slamtec_remote_public.hxx>

Inheritance diagram for rp::standalone::aurora::RemoteSDK:

Public Member Functions
size_t	getDiscoveredServers (std::vector< SDKServerConnectionDesc > &serverList, size_t maxFetchCount=32)
	Get the discovered servers. More...
bool	connect (const SDKServerConnectionDesc &serverDesc, slamtec_aurora_sdk_errorcode_t *errCode=nullptr)
	Connect to a server. More...
void	disconnect ()
	Disconnect from the server. More...
bool	isConnected ()
	Check if the session is connected. More...
void	startBackgroundMapDataSyncing ()
	Start the background map data syncing. More...
void	stopBackgroundMapDataSyncing ()
	Stop the background map data syncing. More...
void	release ()
	Release the session. More...

Static Public Member Functions
static bool	GetSDKInfo (slamtec_aurora_sdk_version_info_t &info_out, slamtec_aurora_sdk_errorcode_t *errcode=nullptr)
	Get the SDK version info. More...
static RemoteSDK *	CreateSession (const RemoteSDKListener *listener=nullptr, const SDKConfig &config=SDKConfig(), slamtec_aurora_sdk_errorcode_t *error_code=nullptr)
	Create a session. More...
static void	DestroySession (RemoteSDK *session)
	Destroy a session. More...

Public Attributes
RemoteDataProvider	dataProvider
	The data provider class object.
RemoteController	controller
	The controller class object.
RemoteMapManager	mapManager
	The map manager class object.
LIDAR2DMapBuilder	lidar2DMapBuilder
	The LIDAR 2D map builder class object.
FloorDetector	floorDetector
	The floor detector class object.

Protected Member Functions
	RemoteSDK (slamtec_aurora_sdk_session_handle_t &obj)
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	handle

Detailed Description

The main class for the remote SDK.

Caller can use this class to create a session and access the data from the remote device

Member Function Documentation

connect()

bool rp::standalone::aurora::RemoteSDK::connect ( const SDKServerConnectionDesc &  serverDesc, slamtec_aurora_sdk_errorcode_t *  errCode = nullptr  )

inline

Connect to a server.

Caller can use this function to connect to a server. This is an alias of the connect function in the controller.

Parameters

[in]	serverDesc	The server description
[out]	errCode	The error code, set to nullptr if not interested

Returns

True if the connection is established successfully, false otherwise

CreateSession()

static RemoteSDK* rp::standalone::aurora::RemoteSDK::CreateSession ( const RemoteSDKListener *  listener = nullptr, const SDKConfig &  config = SDKConfig(), slamtec_aurora_sdk_errorcode_t *  error_code = nullptr  )

inlinestatic

Create a session.

Caller can use this function to create a session.

Parameters

[in]	listener	The listener to listen the SDK events, set to nullptr if not interested
[in]	config	The SDK configuration, set to default if using default configuration
[out]	error_code	The error code, set to nullptr if not interested

Returns

The pointer to the created session, nullptr if failed

DestroySession()

static void rp::standalone::aurora::RemoteSDK::DestroySession ( RemoteSDK *  session )

inlinestatic

Destroy a session.

Caller can use this function to destroy a session.

Parameters

[in]

session

The pointer to the session to be destroyed

disconnect()

void rp::standalone::aurora::RemoteSDK::disconnect ( )

inline

Disconnect from the server.

Caller can use this function to disconnect from the server. This is an alias of the disconnect function in the controller.

getDiscoveredServers()

size_t rp::standalone::aurora::RemoteSDK::getDiscoveredServers ( std::vector< SDKServerConnectionDesc > &  serverList, size_t  maxFetchCount = 32  )

inline

Get the discovered servers.

Caller can use this function to get the discovered servers. This is an alias of the getDiscoveredServers function in the controller.

Parameters

[out]	serverList	The buffer to store the server list
[in]	maxFetchCount	The maximum number of servers to fetch

Returns

The number of discovered servers

GetSDKInfo()

static bool rp::standalone::aurora::RemoteSDK::GetSDKInfo ( slamtec_aurora_sdk_version_info_t &  info_out, slamtec_aurora_sdk_errorcode_t *  errcode = nullptr  )

inlinestatic

Get the SDK version info.

Caller can use this function to get the SDK version info.

Parameters

[out]	info_out	The SDK version info
[out]	errcode	The error code, set to nullptr if not interested

Returns

True if the version info is retrieved successfully, false otherwise

isConnected()

bool rp::standalone::aurora::RemoteSDK::isConnected ( )

inline

Check if the session is connected.

Caller can use this function to check if the session is connected. This is an alias of the isConnected function in the controller.

Returns

True if the session is connected, false otherwise

release()

void rp::standalone::aurora::RemoteSDK::release ( )

inline

Release the session.

Caller can use this function to release the session.

startBackgroundMapDataSyncing()

void rp::standalone::aurora::RemoteSDK::startBackgroundMapDataSyncing ( )

inline

Start the background map data syncing.

Caller can use this function to start the background map data syncing. This is an alias of the setMapDataSyncing function in the controller.

stopBackgroundMapDataSyncing()

void rp::standalone::aurora::RemoteSDK::stopBackgroundMapDataSyncing ( )

inline

Stop the background map data syncing.

Caller can use this function to stop the background map data syncing. This is an alias of the setMapDataSyncing function in the controller.

---

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

• inc/cxx/slamtec_remote_public.hxx