Namespaces
namespace	detail

Classes
class	CommandFailedException
	Dedicated exception type to indicate errors. More...

class	ModeCmdsImpl
	Class that handles reception of mode-related commands using MAL. More...

class	RtcMonitor

class	RtcObject
	Concrete RtcObject implementation. More...

class	RtcObjectController
	Class used to control multiple RtcObjects. More...

class	RtcObjectIf
	Interface class for RtcObject. More...

struct	RtcObjectInfo
	Basic information necessary to construct an RtcObject. More...

class	RtcSupervisor

class	StatusEstimator
	Class for system status estimation. More...

class	StatusPublisher
	Class used to publish status-changed-topic using MAL. More...

struct	Supervisory
	Life cycle extension to make RtcComponent Supervisory. More...

class	WriteBackCmdsImpl
	Class that handles reception of writeback-related commands using MAL. More...

Typedefs
using	Super = Supervisory< RtcComponent >

Enumerations
enum class	RtcCommand { STOP , INIT , RESET , ENABLE , DISABLE , EXIT , GET_STATE , GET_VERSION , UPDATE }
	List of commands that can be issued by the RtcSupervisor. More...

Functions
bool	Contains (std::string const &cont, std::string const &item)

bool	ContainsAny (std::string const &cont, std::set< std::string > const &item)

bool	Contains (std::map< std::string, std::string > const &cont, std::string const &item)

bool	ContainsAny (std::map< std::string, std::string > const &cont, std::set< std::string > const &item)

template<typename T >
std::shared_ptr< T >	GetInterfaceHandle (const std::string &uri_str, std::optional< std::chrono::milliseconds > timeout=std::nullopt)

std::string	MakeUri (std::string const &rr_uri, std::string const &if_name)

std::string	MakeExceptionText (RtcCommand cmd, std::vector< std::exception_ptr > const &eptrs)

Variables
constexpr auto	STATE_OFF = "Off"

constexpr auto	STATE_STARTING = "On::NotOperational::Starting"

constexpr auto	STATE_NOT_READY = "On::NotOperational::NotReady"

constexpr auto	STATE_INITIALISING = "On::NotOperational::Initialising"

constexpr auto	STATE_READY = "On::NotOperational::Ready"

constexpr auto	STATE_ENABLING = "On::NotOperational::Enabling"

constexpr auto	STATE_DISABLING = "On::NotOperational::Disabling"

constexpr auto	STATE_IDLE = "On::Operational::Idle"

constexpr auto	STATE_RUNNING = "On::Operational::Running"

constexpr auto	STATE_GOING_RUNNING = "On::Operational::GoingRunning"

constexpr auto	STATE_GOING_IDLE = "On::Operational::GoingIdle"

constexpr auto	STATE_LOOP_OPENED = "On::Operational::Opened"

constexpr auto	STATE_LOOP_CLOSED = "On::Operational::Closed"

constexpr auto	STATE_LOOP_SUSPENDED = "On::Operational::Suspended"

constexpr auto	STATE_LOOP_SUSPENDING = "On::Operational::Suspending"

constexpr auto	STATE_LOOP_RESUMING = "On::Operational::Resuming"

constexpr auto	STATE_ERROR = "On::Operational::Error"

constexpr auto	STATE_RECOVERING = "On::Operational::Recovering"

constexpr auto	STATUS_OFF = "Off;Off"

constexpr auto	STATUS_NOT_READY = "NotOperational;NotReady"

constexpr auto	STATUS_INITIALISING = "NotOperational;Initialising"

constexpr auto	STATUS_READY = "NotOperational;Ready"

constexpr auto	STATUS_IDLE = "Operational;Idle"

constexpr auto	STATUS_LOOP_OPENED = "Operational;LoopOpened"

constexpr auto	STATUS_LOOP_CLOSED = "Operational;LoopClosed"

constexpr auto	STATUS_ERROR = "Operational;Error"

Typedef Documentation

◆ Super

using rtctk::rtcSupervisor::Super = typedef Supervisory<RtcComponent>

Enumeration Type Documentation

◆ RtcCommand

enum class rtctk::rtcSupervisor::RtcCommand

strong

List of commands that can be issued by the RtcSupervisor.

Enumerator
STOP
INIT
RESET
ENABLE
DISABLE
EXIT
GET_STATE
GET_VERSION
UPDATE

Function Documentation

◆ Contains() [1/2]

bool rtctk::rtcSupervisor::Contains	(	std::map< std::string, std::string > const &	cont,
		std::string const &	item
	)

◆ Contains() [2/2]

bool rtctk::rtcSupervisor::Contains	(	std::string const &	cont,
		std::string const &	item
	)

◆ ContainsAny() [1/2]

bool rtctk::rtcSupervisor::ContainsAny	(	std::map< std::string, std::string > const &	cont,
		std::set< std::string > const &	item
	)

◆ ContainsAny() [2/2]

bool rtctk::rtcSupervisor::ContainsAny	(	std::string const &	cont,
		std::set< std::string > const &	item
	)

◆ GetInterfaceHandle()

template<typename T >

std::shared_ptr< T > rtctk::rtcSupervisor::GetInterfaceHandle	(	const std::string &	uri_str,
		std::optional< std::chrono::milliseconds >	timeout = `std::nullopt`
	)

◆ MakeExceptionText()

std::string rtctk::rtcSupervisor::MakeExceptionText	(	RtcCommand	cmd,
		std::vector< std::exception_ptr > const &	eptrs
	)

◆ MakeUri()

std::string rtctk::rtcSupervisor::MakeUri	(	std::string const &	rr_uri,
		std::string const &	if_name
	)

Variable Documentation

◆ STATE_DISABLING

constexpr auto rtctk::rtcSupervisor::STATE_DISABLING = "On::NotOperational::Disabling"

constexpr

◆ STATE_ENABLING

constexpr auto rtctk::rtcSupervisor::STATE_ENABLING = "On::NotOperational::Enabling"

constexpr

◆ STATE_ERROR

constexpr auto rtctk::rtcSupervisor::STATE_ERROR = "On::Operational::Error"

constexpr

◆ STATE_GOING_IDLE

constexpr auto rtctk::rtcSupervisor::STATE_GOING_IDLE = "On::Operational::GoingIdle"

constexpr

◆ STATE_GOING_RUNNING

constexpr auto rtctk::rtcSupervisor::STATE_GOING_RUNNING = "On::Operational::GoingRunning"

constexpr

◆ STATE_IDLE

constexpr auto rtctk::rtcSupervisor::STATE_IDLE = "On::Operational::Idle"

constexpr

◆ STATE_INITIALISING

constexpr auto rtctk::rtcSupervisor::STATE_INITIALISING = "On::NotOperational::Initialising"

constexpr

◆ STATE_LOOP_CLOSED

constexpr auto rtctk::rtcSupervisor::STATE_LOOP_CLOSED = "On::Operational::Closed"

constexpr

◆ STATE_LOOP_OPENED

constexpr auto rtctk::rtcSupervisor::STATE_LOOP_OPENED = "On::Operational::Opened"

constexpr

◆ STATE_LOOP_RESUMING

constexpr auto rtctk::rtcSupervisor::STATE_LOOP_RESUMING = "On::Operational::Resuming"

constexpr

◆ STATE_LOOP_SUSPENDED

constexpr auto rtctk::rtcSupervisor::STATE_LOOP_SUSPENDED = "On::Operational::Suspended"

constexpr

◆ STATE_LOOP_SUSPENDING

constexpr auto rtctk::rtcSupervisor::STATE_LOOP_SUSPENDING = "On::Operational::Suspending"

constexpr

◆ STATE_NOT_READY

constexpr auto rtctk::rtcSupervisor::STATE_NOT_READY = "On::NotOperational::NotReady"

constexpr

◆ STATE_OFF

constexpr auto rtctk::rtcSupervisor::STATE_OFF = "Off"

constexpr

◆ STATE_READY

constexpr auto rtctk::rtcSupervisor::STATE_READY = "On::NotOperational::Ready"

constexpr

◆ STATE_RECOVERING

constexpr auto rtctk::rtcSupervisor::STATE_RECOVERING = "On::Operational::Recovering"

constexpr

◆ STATE_RUNNING

constexpr auto rtctk::rtcSupervisor::STATE_RUNNING = "On::Operational::Running"

constexpr

◆ STATE_STARTING

constexpr auto rtctk::rtcSupervisor::STATE_STARTING = "On::NotOperational::Starting"

constexpr

◆ STATUS_ERROR

constexpr auto rtctk::rtcSupervisor::STATUS_ERROR = "Operational;Error"

constexpr

◆ STATUS_IDLE

constexpr auto rtctk::rtcSupervisor::STATUS_IDLE = "Operational;Idle"

constexpr

◆ STATUS_INITIALISING

constexpr auto rtctk::rtcSupervisor::STATUS_INITIALISING = "NotOperational;Initialising"

constexpr

◆ STATUS_LOOP_CLOSED

constexpr auto rtctk::rtcSupervisor::STATUS_LOOP_CLOSED = "Operational;LoopClosed"

constexpr

◆ STATUS_LOOP_OPENED

constexpr auto rtctk::rtcSupervisor::STATUS_LOOP_OPENED = "Operational;LoopOpened"

constexpr

◆ STATUS_NOT_READY

constexpr auto rtctk::rtcSupervisor::STATUS_NOT_READY = "NotOperational;NotReady"

constexpr

◆ STATUS_OFF

constexpr auto rtctk::rtcSupervisor::STATUS_OFF = "Off;Off"

constexpr

◆ STATUS_READY

constexpr auto rtctk::rtcSupervisor::STATUS_READY = "NotOperational;Ready"

constexpr

Namespaces

Classes

Typedefs

Enumerations

Functions

Variables

Typedef Documentation

◆ Super

Enumeration Type Documentation

◆ RtcCommand

Function Documentation

◆ Contains() [1/2]

◆ Contains() [2/2]

◆ ContainsAny() [1/2]

◆ ContainsAny() [2/2]

◆ GetInterfaceHandle()

◆ MakeExceptionText()

◆ MakeUri()

Variable Documentation

◆ STATE_DISABLING

◆ STATE_ENABLING

◆ STATE_ERROR

◆ STATE_GOING_IDLE

◆ STATE_GOING_RUNNING

◆ STATE_IDLE

◆ STATE_INITIALISING

◆ STATE_LOOP_CLOSED

◆ STATE_LOOP_OPENED

◆ STATE_LOOP_RESUMING

◆ STATE_LOOP_SUSPENDED

◆ STATE_LOOP_SUSPENDING

◆ STATE_NOT_READY

◆ STATE_OFF

◆ STATE_READY

◆ STATE_RECOVERING

◆ STATE_RUNNING

◆ STATE_STARTING

◆ STATUS_ERROR

◆ STATUS_IDLE

◆ STATUS_INITIALISING

◆ STATUS_LOOP_CLOSED

◆ STATUS_LOOP_OPENED

◆ STATUS_NOT_READY

◆ STATUS_OFF

◆ STATUS_READY