creos Namespace Reference

The main namespace for the CreOS client library. More...

Classes
class	AlreadyExistsError
	Something already exists when trying to create it. More...
class	Client
	The client class. More...
class	ConnectionError
	Connection error. More...
class	Exception
	Exception class for the CreOS client library. More...
class	IDiagnosticsInterface
	The interface for retrieving diagnostic information from an Avular robot. More...
class	InvalidArgumentError
	Invalid argument error. More...
class	IPowerManagementInterface
	The interface for querying and managing the power state of an Avular robot. More...
class	ISensorsInterface
	The interface for retrieving sensor data from an Avular robot. More...
class	ISetpointControlInterface
	The interface for sending control setpoints to an Avular robot. More...
class	ISystemInfoInterface
	The interface for retrieving general system information of an Avular robot. More...
class	ITransformsInterface
	The interface for retrieving information about the relationships between different coordinate frames used within an Avular robot. More...
class	NotImplementedError
	The function is not implemented. More...
class	PublicationError
	An error occurred while publishing data. More...
class	RobotClock
	The clock that represents the robot time. More...
class	ServiceCallError
	Service call failure. More...
class	SubscriptionError
	An error occurred while subscribing to data. More...
class	SubscriptionId
	This type holds an subscription ID. More...
class	TimeoutError
	Timeout error. More...
class	UnsupportedError
	A part of the API is not supported by the connected robot. More...

Typedefs
using	ErrorCode = creos_messages::ErrorCode
	Value that indicates an error.

Functions
std::string CREOS_UTILS_API	base64_encode (const std::span< const std::byte > &data)
	Encodes data to base64.
std::string CREOS_UTILS_API	base64_encode (const std::span< const uint8_t > &data)
std::vector< std::byte > CREOS_UTILS_API	base64_decode (const std::string_view &data)
	Decodes base64 encoded data.
std::string CREOS_UTILS_API	url_encode (const std::string_view &value)
	Encodes a string to be used in a URL.
std::string CREOS_UTILS_API	url_decode (const std::string_view &value)
	Decodes a string from a URL.
std::string CREOS_UTILS_API	create_query (const std::unordered_map< std::string, std::string > &parameters)
	Creates a query string from a map of parameters.
std::unordered_map< std::string, std::string > CREOS_UTILS_API	parse_query (const std::string_view &query)
	Parses a query string into a map of parameters.

Detailed Description

The main namespace for the CreOS client library.

Function Documentation

base64_decode()

std::vector< std::byte > creos::base64_decode

(

const std::string_view &

data

)

Decodes base64 encoded data.

Parameters

data	The base64 encoded data.

Returns

std::vector<std::byte> The decoded data.

base64_encode()

std::string creos::base64_encode

(

const std::span< const std::byte > &

data

)

Encodes data to base64.

Parameters

data	The data to encode.

Returns

std::string The base64 encoded data.

create_query()

std::string creos::create_query

(

const std::unordered_map< std::string, std::string > &

parameters

)

Creates a query string from a map of parameters.

Parameters

parameters

The map of parameters.

Returns

std::string The query string.

parse_query()

std::unordered_map< std::string, std::string > creos::parse_query

(

const std::string_view &

query

)

Parses a query string into a map of parameters.

Parameters

query

The query string.

Returns

std::unordered_map<std::string, std::string> The map of parameters.

url_decode()

std::string creos::url_decode

(

const std::string_view &

value

)

Decodes a string from a URL.

Parameters

value

The string to decode.

Returns

std::string The decoded string.

url_encode()

std::string creos::url_encode

(

const std::string_view &

value

)

Encodes a string to be used in a URL.

Parameters

value

The string to encode.

Returns

std::string The encoded string.