rtctk::rtcSupervisor Namespace Reference

Namespaces
namespace	detail

Classes
class	AlertAggregator
	Class for system status estimation. More...
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 : uint8_t {   RtcCommand::STOP , RtcCommand::INIT , RtcCommand::RESET , RtcCommand::ENABLE ,   RtcCommand::DISABLE , RtcCommand::EXIT , RtcCommand::GET_STATE , RtcCommand::GET_VERSION ,   RtcCommand::UPDATE , RtcCommand::CLEAR_ALERTS , RtcCommand::RECOVER }
	List of commands that can be issued by the RtcSupervisor. More...

Functions
bool	Contains (const std::string &cont, const std::string &item)
bool	ContainsAny (const std::string &cont, const std::set< std::string > &item)
bool	Contains (const std::map< std::string, std::string > &cont, const std::string &item)
bool	ContainsAny (const std::map< std::string, std::string > &cont, const std::set< std::string > &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 (const std::string &rr_uri, const std::string &if_name)
std::string	MakeExceptionText (RtcCommand cmd, const std::vector< std::exception_ptr > &eptrs)
PersistentRepoIf &	SetupPersistentRepo (ServiceContainer &services)

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_OPENING = "On::Operational::Opening"
constexpr auto	STATE_LOOP_OPENED = "On::Operational::Opened"
constexpr auto	STATE_LOOP_CLOSING = "On::Operational::Closing"
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"
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_OPEN_LOOP = "Operational::OpenLoop"
constexpr auto	STATUS_CLOSED_LOOP = "Operational::ClosedLoop"
constexpr auto	STATUS_ERROR = "Operational::Error"

Typedef Documentation

Super

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

Function Documentation

Contains() [1/2]

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

Contains() [2/2]

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

ContainsAny() [1/2]

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

ContainsAny() [2/2]

bool rtctk::rtcSupervisor::ContainsAny	(	const std::string &	cont,
		const std::set< std::string > &	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,
		const std::vector< std::exception_ptr > &	eptrs )

MakeUri()

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

SetupPersistentRepo()

PersistentRepoIf & rtctk::rtcSupervisor::SetupPersistentRepo

(

ServiceContainer &

services

)

Variable Documentation

STATE_DISABLING

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

constexpr

STATE_ENABLING

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

constexpr

STATE_ERROR

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

constexpr

STATE_GOING_IDLE

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

constexpr

STATE_GOING_RUNNING

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

constexpr

STATE_IDLE

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

constexpr

STATE_INITIALISING

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

constexpr

STATE_LOOP_CLOSED

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

constexpr

STATE_LOOP_CLOSING

auto rtctk::rtcSupervisor::STATE_LOOP_CLOSING = "On::Operational::Closing"

constexpr

STATE_LOOP_OPENED

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

constexpr

STATE_LOOP_OPENING

auto rtctk::rtcSupervisor::STATE_LOOP_OPENING = "On::Operational::Opening"

constexpr

STATE_LOOP_RESUMING

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

constexpr

STATE_LOOP_SUSPENDED

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

constexpr

STATE_LOOP_SUSPENDING

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

constexpr

STATE_NOT_READY

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

constexpr

STATE_OFF

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

constexpr

STATE_READY

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

constexpr

STATE_RECOVERING

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

constexpr

STATE_RUNNING

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

constexpr

STATE_STARTING

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

constexpr

STATUS_CLOSED_LOOP

auto rtctk::rtcSupervisor::STATUS_CLOSED_LOOP = "Operational::ClosedLoop"

constexpr

STATUS_ERROR

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

constexpr

STATUS_IDLE

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

constexpr

STATUS_INITIALISING

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

constexpr

STATUS_NOT_READY

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

constexpr

STATUS_OFF

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

constexpr

STATUS_OPEN_LOOP

auto rtctk::rtcSupervisor::STATUS_OPEN_LOOP = "Operational::OpenLoop"

constexpr

STATUS_READY

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

constexpr