rtctk::rtcSupervisor::RtcObjectIf Class Reference

Interface class for RtcObject. More...

#include <rtctk/rtcSupervisor/rtcObject.hpp>

Inheritance diagram for rtctk::rtcSupervisor::RtcObjectIf:

Public Member Functions
virtual	~RtcObjectIf ()=default
virtual RtcObjectInfo	GetInfo () const =0
	Get basic object information.
virtual void	RunAsync (RtcCommand cmd)=0
	Starts an async command request.
virtual std::string	WaitAsync (std::optional< unsigned > timeout)=0
	Weits for a previously started command request to conclude.

Detailed Description

Interface class for RtcObject.

Constructor & Destructor Documentation

~RtcObjectIf()

virtual rtctk::rtcSupervisor::RtcObjectIf::~RtcObjectIf ( )

virtualdefault

Member Function Documentation

GetInfo()

virtual RtcObjectInfo rtctk::rtcSupervisor::RtcObjectIf::GetInfo ( ) const

pure virtual

Get basic object information.

Returns

RtcObjectInfo struct.

Implemented in rtctk::rtcSupervisor::RtcObject.

RunAsync()

virtual void rtctk::rtcSupervisor::RtcObjectIf::RunAsync ( RtcCommand cmd )

pure virtual

Starts an async command request.

Parameters

cmd	The command to be issued.

Implemented in rtctk::rtcSupervisor::RtcObject.

WaitAsync()

virtual std::string rtctk::rtcSupervisor::RtcObjectIf::WaitAsync ( std::optional< unsigned > timeout )

pure virtual

Weits for a previously started command request to conclude.

Parameters

timeout

The timeout in seconds.

Returns

command return string.

Implemented in rtctk::rtcSupervisor::RtcObject.

---

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

• reusableComponents/rtcSupervisor/lib/src/include/rtctk/rtcSupervisor/rtcObject.hpp