SimulatorExecutionContext class. More...

#include <SimulatorExecutionContext.h>

Inheritance diagram for RTC::SimulatorExecutionContext:

[legend]

Collaboration diagram for RTC::SimulatorExecutionContext:

[legend]

Public Member Functions
	SimulatorExecutionContext ()
	Constructor .

	~SimulatorExecutionContext () override
	Destructor .

RTC::ReturnCode_t	activate_component (RTC::LightweightRTObject_ptr comp) override
	Activate an RT-component.

RTC::ReturnCode_t	deactivate_component (RTC::LightweightRTObject_ptr comp) override
	Activate an RT-component.

RTC::ReturnCode_t	reset_component (RTC::LightweightRTObject_ptr comp) override
	Activate an RT-component.

Public Member Functions inherited from RTC::OpenHRPExecutionContext
	OpenHRPExecutionContext ()
	Constructor .

	~OpenHRPExecutionContext () override
	Destructor .

void	tick () override
	Move forward one step of ExecutionContext.

CORBA::Boolean	is_running () override
	Check for ExecutionContext running state.

RTC::ReturnCode_t	start () override
	Start the ExecutionContext.

RTC::ReturnCode_t	stop () override
	Stop the ExecutionContext.

CORBA::Double	get_rate () override
	Get execution rate(Hz) of ExecutionContext.

RTC::ReturnCode_t	set_rate (CORBA::Double rate) override
	Set execution rate(Hz) of ExecutionContext.

RTC::ReturnCode_t	activate_component (RTC::LightweightRTObject_ptr comp) override
	Activate an RT-component.

RTC::ReturnCode_t	deactivate_component (RTC::LightweightRTObject_ptr comp) override
	Deactivate an RT-component.

RTC::ReturnCode_t	reset_component (RTC::LightweightRTObject_ptr comp) override
	Reset the RT-component.

RTC::LifeCycleState	get_component_state (RTC::LightweightRTObject_ptr comp) override
	Get RT-component's state.

RTC::ExecutionKind	get_kind () override
	Get the ExecutionKind.

RTC::ReturnCode_t	add_component (RTC::LightweightRTObject_ptr comp) override
	Add an RT-component.

RTC::ReturnCode_t	remove_component (RTC::LightweightRTObject_ptr comp) override
	Remove the RT-Component from participant list.

RTC::ExecutionContextProfile *	get_profile () override
	Get the ExecutionContextProfile.

Public Member Functions inherited from RTC::ExecutionContextBase
	ExecutionContextBase (const char *name)
	Constructor.

virtual	~ExecutionContextBase ()
	Virtual Destructor.

virtual void	init (coil::Properties &props)
	Initialize the ExecutionContext.

virtual RTC::ReturnCode_t	bindComponent (RTC::RTObject_impl *rtc)
	Bind the component.

CORBA::Boolean	isRunning ()
	Check for ExecutionContext running state.

RTC::ReturnCode_t	start ()
	Start the ExecutionContext.

double	getRate () const
	Get execution rate(Hz) of ExecutionContext.

std::chrono::nanoseconds	getPeriod () const

RTC::ReturnCode_t	setRate (double rate)
	Set execution rate(Hz) of ExecutionContext.

RTC::ReturnCode_t	addComponent (RTC::LightweightRTObject_ptr comp)
	Add an RT-component.

RTC::ReturnCode_t	removeComponent (RTC::LightweightRTObject_ptr comp)
	Remove the RT-Component from participant list.

RTC::ReturnCode_t	activateComponent (RTC::LightweightRTObject_ptr comp)
	Activate an RT-component.

RTC::ReturnCode_t	deactivateComponent (RTC::LightweightRTObject_ptr comp)
	Deactivate an RT-component.

RTC::ReturnCode_t	resetComponent (RTC::LightweightRTObject_ptr comp)
	Reset the RT-component.

RTC::LifeCycleState	getComponentState (RTC::LightweightRTObject_ptr comp)
	Get RT-component's state.

RTC::ExecutionKind	getKind () const
	Get the ExecutionKind.

RTC::ExecutionContextProfile *	getProfile ()
	Getting Profile.

void	setObjRef (RTC::ExecutionContextService_ptr ec_ptr)
	Get the reference to the CORBA object.

RTC::ExecutionContextService_ptr	getObjRef () const

RTC::ReturnCode_t	setKind (RTC::ExecutionKind kind)
	Set the ExecutionKind.

RTC::ReturnCode_t	setOwner (RTC::LightweightRTObject_ptr comp)
	Setting owner component of the execution context.

RTC::RTObject_ptr	getOwner () const
	Getting a reference of the owner component.

const RTC::RTCList &	getComponentList () const
	Getting participant RTC list.

void	setProperties (coil::Properties &props)
	Setting Properties.

coil::Properties	getProperties () const
	Setting Properties.

const RTC::ExecutionContextProfile &	getProfile () const
	Getting Profile.

bool	isAllCurrentState (RTC::LifeCycleState state)

bool	isAllNextState (RTC::LifeCycleState state)

bool	isOneOfCurrentState (RTC::LifeCycleState state)

bool	isOneOfNextState (RTC::LifeCycleState state)

void	invokeWorker ()

void	invokeWorkerPreDo ()

void	invokeWorkerDo ()

void	invokeWorkerPostDo ()

Additional Inherited Members
Static Public Member Functions inherited from RTC::ExecutionContextBase
static const char *	getStateString (RTC::LifeCycleState state)

static const char *	getKindString (RTC::ExecutionKind kind)
	Converting ExecutionKind enum to string.

Protected Member Functions inherited from RTC::OpenHRPExecutionContext
RTC::ReturnCode_t	onAddedComponent (RTC::LightweightRTObject_ptr rtobj) override
	onAddedComponent() template function

RTC::ReturnCode_t	onRemovedComponent (RTC::LightweightRTObject_ptr rtobj) override
	onRemovedComponent() template function

Protected Member Functions inherited from RTC::ExecutionContextBase
virtual bool	onIsRunning (bool running)

virtual RTC::ReturnCode_t	onStarting ()

virtual RTC::ReturnCode_t	onStarted ()

virtual RTC::ReturnCode_t	onStopping ()

virtual RTC::ReturnCode_t	onStopped ()

virtual double	onGetRate (double rate) const

virtual double	onSettingRate (double rate)

virtual RTC::ReturnCode_t	onSetRate (double)

virtual RTC::ReturnCode_t	onAddingComponent (RTC::LightweightRTObject_ptr)

virtual RTC::ReturnCode_t	onRemovingComponent (RTC::LightweightRTObject_ptr)

virtual RTC::ReturnCode_t	onActivating (RTC::LightweightRTObject_ptr)

virtual RTC::ReturnCode_t	onWaitingActivated (RTC_impl::RTObjectStateMachine *, long int)

virtual RTC::ReturnCode_t	onActivated (RTC_impl::RTObjectStateMachine *, long int)

virtual RTC::ReturnCode_t	onDeactivating (RTC::LightweightRTObject_ptr)

virtual RTC::ReturnCode_t	onWaitingDeactivated (RTC_impl::RTObjectStateMachine *, long int)

virtual RTC::ReturnCode_t	onDeactivated (RTC_impl::RTObjectStateMachine *, long int)

virtual RTC::ReturnCode_t	onResetting (RTC::LightweightRTObject_ptr)

virtual RTC::ReturnCode_t	onWaitingReset (RTC_impl::RTObjectStateMachine *, long int)

virtual RTC::ReturnCode_t	onReset (RTC_impl::RTObjectStateMachine *, long int)

virtual RTC::LifeCycleState	onGetComponentState (RTC::LifeCycleState state)

virtual RTC::ExecutionKind	onGetKind (RTC::ExecutionKind kind) const

virtual RTC::ExecutionContextProfile *	onGetProfile (RTC::ExecutionContextProfile *&profile)

Protected Attributes inherited from RTC::OpenHRPExecutionContext
std::mutex	m_tickmutex
	Mutex to guard tick() reenter.

Protected Attributes inherited from RTC::ExecutionContextBase
RTC::Logger	rtclog

RTC_impl::ExecutionContextWorker	m_worker

RTC_impl::ExecutionContextProfile	m_profile

std::chrono::nanoseconds	m_activationTimeout

std::chrono::nanoseconds	m_deactivationTimeout

std::chrono::nanoseconds	m_resetTimeout

bool	m_syncActivation

bool	m_syncDeactivation

bool	m_syncReset

Detailed Description

SimulatorExecutionContext class.

Constructor & Destructor Documentation

◆ SimulatorExecutionContext()

RTC::SimulatorExecutionContext::SimulatorExecutionContext ( )

Constructor .

◆ ~SimulatorExecutionContext()

RTC::SimulatorExecutionContext::~SimulatorExecutionContext ( )

override

Destructor .

Member Function Documentation

◆ activate_component()

RTC::ReturnCode_t RTC::SimulatorExecutionContext::activate_component ( RTC::LightweightRTObject_ptr comp )

override

Activate an RT-component.

Parameters

comp	The target RT-Component for activation

Returns: The return code of ReturnCode_t type

◆ deactivate_component()

RTC::ReturnCode_t RTC::SimulatorExecutionContext::deactivate_component ( RTC::LightweightRTObject_ptr comp )

override

Activate an RT-component.

Parameters

comp	The target RT-Component for deactivate

Returns: The return code of ReturnCode_t type

◆ reset_component()

RTC::ReturnCode_t RTC::SimulatorExecutionContext::reset_component ( RTC::LightweightRTObject_ptr comp )

override

Activate an RT-component.

Parameters

comp	The target RT-Component for reset

Returns: The return code of ReturnCode_t type

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

SimulatorExecutionContext.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SimulatorExecutionContext()

◆ ~SimulatorExecutionContext()

Member Function Documentation

◆ activate_component()

◆ deactivate_component()

◆ reset_component()