OpenRTM_aist.ExecutionContextBase.ExecutionContextBase Class Reference

A base class for ExecutionContext. More...

Inheritance diagram for OpenRTM_aist.ExecutionContextBase.ExecutionContextBase:

Public Member Functions
def	init (self, props)
	Initialization function of the ExecutionContext. More...
def	exit (self)
	virtual void exit();
def	bindComponent (self, rtc)
	Destructor def tick(self): pass. More...
def	isRunning (self)
	Check for ExecutionContext running state CORBA::Boolean ExecutionContextBase::isRunning()
def	start (self)
	Start the ExecutionContext RTC::ReturnCode_t ExecutionContextBase::start()
def	stop (self)
	Stopping the ExecutionContext RTC::ReturnCode_t ExecutionContextBase::stop()
def	getRate (self)
	Get execution rate(Hz) of ExecutionContext. More...
def	setRate (self, rate)
	Set execution rate(Hz) of ExecutionContext. More...
def	addComponent (self, comp)
	Add an RT-component RTC::ReturnCode_t ExecutionContextBase:: addComponent(RTC::LightweightRTObject_ptr comp)
def	removeComponent (self, comp)
	Remove the RT-Component from participant list RTC::ReturnCode_t ExecutionContextBase:: removeComponent(RTC::LightweightRTObject_ptr comp)
def	activateComponent (self, comp)
	Activate an RT-component RTC::ReturnCode_t ExecutionContextBase:: activateComponent(RTC::LightweightRTObject_ptr comp)
def	deactivateComponent (self, comp)
	Deactivate an RT-component RTC::ReturnCode_t ExecutionContextBase:: deactivateComponent(RTC::LightweightRTObject_ptr comp)
def	resetComponent (self, comp)
	Reset the RT-component RTC::ReturnCode_t ExecutionContextBase:: resetComponent(RTC::LightweightRTObject_ptr comp)
def	getComponentState (self, comp)
	Get RT-component's state. More...
def	getKind (self)
	Get the ExecutionKind. More...
def	getProfile (self)
	Getting Profile. More...
def	setObjRef (self, ec_ptr)
	Get the reference to the CORBA object. More...
def	getObjRef (self)
	Get the reference to the CORBA object. More...
def	getKindString (self, kind)
	Converting ExecutionKind enum to string. More...
def	setKind (self, kind)
	Set the ExecutionKind. More...
def	setOwner (self, comp)
	Setting owner component of the execution context. More...
def	getOwner (self)
	Getting a reference of the owner component. More...
def	getComponentList (self)
	Getting participant RTC list. More...
def	setProperties (self, props)
	Setting Properties. More...
def	getProperties (self)
	Setting Properties. More...
def	isAllCurrentState (self, state)
	Getting Profile. More...
def	setExecutionRate (self, props)
	Setting execution rate from given properties. More...
def	setTransitionMode (self, props, key, flag)
	Setting state transition mode from given properties. More...
def	setTimeout (self, props, key, timevalue)
	Setting state transition timeout from given properties. More...

Detailed Description

A base class for ExecutionContext.

A base class of ExecutionContext.

Since

0.4.0

Member Function Documentation

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.bindComponent	(		self,
			rtc
	)

Destructor def tick(self): pass.

Bind the component.

Bind the component.

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.getComponentList

(

self

)

Getting participant RTC list.

This function returns a list of participant RTC of the execution context.

Returns

Participants RTC list

const RTC::RTCList& getComponentList() const

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.getComponentState	(		self,
			comp
	)

Get RT-component's state.

This operation shall report the LifeCycleState of the given participant RTC. UNKNOWN_STATE will be returned, if the given RT-Component is not inclued in the participant list.

Parameters

comp	The target RT-Component to get the state

Returns

The current state of the target RT-Component(LifeCycleState)

RTC::LifeCycleState ExecutionContextBase:: getComponentState(RTC::LightweightRTObject_ptr comp)

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.getKind

(

self

)

Get the ExecutionKind.

This operation shall report the execution kind of the execution context.

Returns

ExecutionKind

RTC::ExecutionKind ExecutionContextBase::getKind(void) const

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.getKindString	(		self,
			kind
	)

Converting ExecutionKind enum to string.

This function converts enumeration (PERIODIC, EVENT_DRIVEN, OTHER) defined in RTC::ExecutionKind to string.

Parameters

kind	ExecutionKind

Returns

String of ExecutionKind

const char* getKindString(RTC::ExecutionKind kind) const

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.getObjRef

(

self

)

Get the reference to the CORBA object.

Get the reference to the CORBA object as ExecutioncontextService of this object.

Returns

The reference to CORBA object

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.getOwner

(

self

)

Getting a reference of the owner component.

This function returns a reference of the owner RT-Component of this execution context

Returns

a reference of the owner RT-Component const RTC::RTObject_ptr getOwner() const

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.getProfile

(

self

)

Getting Profile.

This function gets RTC::ExecutionContextProfile. The ownership of the obtained ExecutionContextProfile is given to caller. The caller should release obtained object when it is unneccessary anymore.

Returns

RTC::ExecutionContextProfile

RTC::ExecutionContextProfile* ExecutionContextBase::getProfile(void)

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.getProperties

(

self

)

Setting Properties.

This function sets ExecutionContextProfile::properties by coil::Properties.

Parameters

props

Properties to be set to ExecutionContextProfile::properties.

const coil::Properties getProperties() const

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.getRate

(

self

)

Get execution rate(Hz) of ExecutionContext.

This operation shall return the rate (in hertz) at which its Active participating RTCs are being invoked.

Returns

Execution cycle(Unit:Hz)

double getRate(void) const

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.init	(		self,
			props
	)

Initialization function of the ExecutionContext.

virtual void init(coil::Properties& props);

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.isAllCurrentState	(		self,
			state
	)

Getting Profile.

This function gets RTC::ExecutionContextProfile. The ownership of the obtained ExecutionContextProfile is given to caller. The caller should release obtained object when it is unneccessary anymore.

Returns

RTC::ExecutionContextProfile

RTC::ExecutionContextProfile* getProfile(void) def getProfile(self): return self._profile.getProfile()

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.setExecutionRate	(		self,
			props
	)

Setting execution rate from given properties.

bool ExecutionContextBase::setExecutionRate(coil::Properties& props)

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.setKind	(		self,
			kind
	)

Set the ExecutionKind.

This operation sets the kind of the execution context.

Parameters

kind	ExecutionKind

RTC::ReturnCode_t setKind(RTC::ExecutionKind kind)

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.setObjRef	(		self,
			ec_ptr
	)

Get the reference to the CORBA object.

Get the reference to the CORBA object as ExecutioncontextService of this object.

Returns

The reference to CORBA object

void setObjRef(RTC::ExecutionContextService_ptr ec_ptr)

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.setOwner	(		self,
			comp
	)

Setting owner component of the execution context.

This function sets an RT-Component to be owner of the execution context.

Parameters

comp	an owner RT-Component of this execution context

Returns

The return code of ReturnCode_t type RTC::ReturnCode_t setOwner(RTC::LightweightRTObject_ptr comp)

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.setProperties	(		self,
			props
	)

Setting Properties.

This function sets ExecutionContextProfile::properties by coil::Properties.

Parameters

props

Properties to be set to ExecutionContextProfile::properties.

void setProperties(coil::Properties& props)

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.setRate	(		self,
			rate
	)

Set execution rate(Hz) of ExecutionContext.

This operation shall set the rate (in hertz) at which this context¡Çs Active participating RTCs are being called. If the execution kind of the context is PERIODIC, a rate change shall result in the invocation of on_rate_changed on any RTCs realizing DataFlowComponentAction that are registered with any RTCs participating in the context.

Parameters

rate	Execution cycle(Unit:Hz)

Returns

The return code of ReturnCode_t type RTC_OK: Succeed BAD_PARAMETER: Invalid value. The value might be negative.

RTC::ReturnCode_t setRate(double rate)

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.setTimeout	(		self,
			props,
			key,
			timevalue
	)

Setting state transition timeout from given properties.

bool ExecutionContextBase:: setTimeout(coil::Properties& props, const char* key, coil::TimeValue& timevalue)

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.setTransitionMode	(		self,
			props,
			key,
			flag
	)

Setting state transition mode from given properties.

bool ExecutionContextBase:: setTransitionMode(coil::Properties& props, const char* key, bool& flag)

---

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

• /home/openrtm/git-src/OpenRTM-aist-Python/OpenRTM_aist/ExecutionContextBase.py