RTC Toolkit 5.1.0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
rtctk::rtcSupervisor::RtcObject Class Reference

Concrete RtcObject implementation. More...

#include <rtctk/rtcSupervisor/rtcObject.hpp>

Inheritance diagram for rtctk::rtcSupervisor::RtcObject:
rtctk::rtcSupervisor::RtcObjectIf

Public Member Functions

 RtcObject (const RtcObjectInfo &obj_info)
 Constructor for default RtcObject.
 
 ~RtcObject () override=default
 
RtcObjectInfo GetInfo () const override
 Get basic object information.
 
void RunAsync (RtcCommand cmd) override
 Starts an async command request.
 
std::string WaitAsync (std::optional< unsigned > timeout) override
 Weits for a previously started command request to conclude.
 
- Public Member Functions inherited from rtctk::rtcSupervisor::RtcObjectIf
virtual ~RtcObjectIf ()=default
 

Detailed Description

Concrete RtcObject implementation.

Constructor & Destructor Documentation

◆ RtcObject()

rtctk::rtcSupervisor::RtcObject::RtcObject ( const RtcObjectInfo & obj_info)
explicit

Constructor for default RtcObject.

Parameters
obj_infoBasic object information.

◆ ~RtcObject()

rtctk::rtcSupervisor::RtcObject::~RtcObject ( )
overridedefault

Member Function Documentation

◆ GetInfo()

RtcObjectInfo rtctk::rtcSupervisor::RtcObject::GetInfo ( ) const
overridevirtual

Get basic object information.

Returns
RtcObjectInfo struct.

Implements rtctk::rtcSupervisor::RtcObjectIf.

◆ RunAsync()

void rtctk::rtcSupervisor::RtcObject::RunAsync ( RtcCommand cmd)
overridevirtual

Starts an async command request.

Parameters
cmdThe command to be issued.

Implements rtctk::rtcSupervisor::RtcObjectIf.

◆ WaitAsync()

std::string rtctk::rtcSupervisor::RtcObject::WaitAsync ( std::optional< unsigned > timeout)
overridevirtual

Weits for a previously started command request to conclude.

Parameters
timeoutThe timeout in seconds.
Returns
command return string.

Implements rtctk::rtcSupervisor::RtcObjectIf.


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