rtctk::rtcSupervisor::RtcObject Class Reference

#include <rtcObject.hpp>

Public Member Functions
	RtcObject (const std::string &name, const std::string &rr_uri, const std::string &ps_uri)
virtual	~RtcObject ()
virtual void	BelievedState (const std::string &s)
	Set the believed state as a string and evaluate as enumeration. More...
virtual std::string	BelievedState ()
	Set the believed state as a string and evaluate as enumeration. More...
virtual std::string	BelievedSubstate ()
void	EvaluatedState (RtcState &state, RtcSubState &sub_state)
	Return the state evaluated as enumeration. More...
virtual std::string	Name ()
virtual void	BelievedError (bool i)
	Setter and Getter for BelievedError. More...
virtual bool	BelievedError ()
virtual std::string	RunCmd (RtcCommand cmd, bool timed)
	Run command with optional arg. More...
virtual std::string	RunAsync (RtcCommand cmd)
	Run command async. More...
virtual std::string	WaitAsync ()
	Wait for previously async run command. More...
virtual bool	GetAsyncCommandOk ()
	Get indication that async command was OK, no exception or funny return values. More...

Constructor & Destructor Documentation

RtcObject()

rtctk::rtcSupervisor::RtcObject::RtcObject	(	const std::string &	name,
		const std::string &	rr_uri,
		const std::string &	ps_uri
	)

Parameters

name	Name of the object e.g. VisAcq
rr_uri	URI of request response end point
ps_uri	URI of publish reply end point for state Event publication

Returns

none

To allow easy unit tests we allow reation of an rtcObject without trying to resolve it

Generate the handles by which we can send commands to the object this might throw if the resolition fails

~RtcObject()

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

virtual

Member Function Documentation

BelievedError() [1/2]

virtual bool rtctk::rtcSupervisor::RtcObject::BelievedError ( )

inlinevirtual

BelievedError() [2/2]

virtual void rtctk::rtcSupervisor::RtcObject::BelievedError ( bool  i )

inlinevirtual

Setter and Getter for BelievedError.

BelievedState() [1/2]

std::string rtctk::rtcSupervisor::RtcObject::BelievedState ( )

virtual

Set the believed state as a string and evaluate as enumeration.

Returns

String as stored by BelievedState

BelievedState() [2/2]

void rtctk::rtcSupervisor::RtcObject::BelievedState ( const std::string &  s )

virtual

Set the believed state as a string and evaluate as enumeration.

Parameters

s	State as string from Event

BelievedSubstate()

std::string rtctk::rtcSupervisor::RtcObject::BelievedSubstate ( )

virtual

EvaluatedState()

void rtctk::rtcSupervisor::RtcObject::EvaluatedState	(	RtcState &	state,
		RtcSubState &	sub_state
	)

Return the state evaluated as enumeration.

Return the state which has been evaluated by the object.

Returns

State and Substate evaluated as enumeration

GetAsyncCommandOk()

bool rtctk::rtcSupervisor::RtcObject::GetAsyncCommandOk ( )

virtual

Get indication that async command was OK, no exception or funny return values.

Name()

virtual std::string rtctk::rtcSupervisor::RtcObject::Name ( )

inlinevirtual

Returns

Name of object

RunAsync()

std::string rtctk::rtcSupervisor::RtcObject::RunAsync ( RtcCommand  cmd )

virtual

Run command async.

RunCmd()

std::string rtctk::rtcSupervisor::RtcObject::RunCmd ( RtcCommand  cmd, bool  timed  )

virtual

Run command with optional arg.

WaitAsync()

std::string rtctk::rtcSupervisor::RtcObject::WaitAsync ( )

virtual

Wait for previously async run command.

---

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

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