OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext Class Reference

PeriodicExecutionContext class. More...

Inheritance diagram for OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext:

Classes
class	WorkerThreadCtrl
	Condition variable class for worker. More...

Public Member Functions
def	__init__ (self)
	Constructor.
def	svc (self)
	Create internal activity thread. More...
def	open (self, args)
	Generate internal activity thread for ExecutionContextint PeriodicExecutionContext::open(void *args)
def	close (self, flags)
	Close activity thread. More...
def	is_running (self)
	Check for ExecutionContext running state. More...
def	start (self)
	Start ExecutionContext. More...
def	stop (self)
	Stop ExecutionContext. More...
def	get_rate (self)
	Get ExecutionRate. More...
def	set_rate (self, rate)
	Set ExecutionRate. More...
def	activate_component (self, comp)
	Activate a RT-component. More...
def	deactivate_component (self, comp)
	Deactivate a RT-component. More...
def	reset_component (self, comp)
	Reset a RT-component. More...
def	get_component_state (self, comp)
	Get RT-component's state. More...
def	get_kind (self)
	Get the ExecutionKind. More...
def	add_component (self, comp)
	Add a RT-component. More...
def	remove_component (self, comp)
	Remove the RT-component from participant list. More...
def	get_profile (self)
	Get the ExecutionContextProfile. More...
Public Member Functions inherited from OpenRTM_aist.ExecutionContextBase.ExecutionContextBase
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

PeriodicExecutionContext class.

Member Function Documentation

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.activate_component	(		self,
			comp
	)

Activate a RT-component.

The given participant RTC is Inactive and is therefore not being invoked according to the execution context¡Çs execution kind. This operation shall cause the RTC to transition to the Active state such that it may subsequently be invoked in this execution context. The callback on_activate shall be called as a result of calling this operation. This operation shall not return until the callback has returned, and shall result in an error if the callback does.

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.add_component	(		self,
			comp
	)

Add a RT-component.

The operation causes the given RTC to begin participating in the execution context. The newly added RTC will receive a call to LightweightRTComponent::attach_context and then enter the Inactive state.

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.close	(		self,
			flags
	)

Close activity thread.

close() method is called when activity thread svc() is returned. This method deactivate this object and notify it to manager. ACE_Task class method override.

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.deactivate_component	(		self,
			comp
	)

Deactivate a RT-component.

The given RTC is Active in the execution context. Cause it to transition to the Inactive state such that it will not be subsequently invoked from the context unless and until it is activated again. The callback on_deactivate shall be called as a result of calling this operation. This operation shall not return until the callback has returned, and shall result in an error if the callback does.

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.get_component_state	(		self,
			comp
	)

Get RT-component's state.

This operation shall report the LifeCycleState of the given participant RTC.

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.get_kind

(

self

)

Get the ExecutionKind.

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

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.get_profile

(

self

)

Get the ExecutionContextProfile.

This operation provides a profile ¡Èdescriptor¡É for the execution context.

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.get_rate

(

self

)

Get ExecutionRate.

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

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.is_running

(

self

)

Check for ExecutionContext running state.

This operation shall return true if the context is in the Running state. While the context is Running, all Active RTCs participating in the context shall be executed according to the context¡Çs execution kind.

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.remove_component	(		self,
			comp
	)

Remove the RT-component from participant list.

This operation causes a participant RTC to stop participating in the execution context. The removed RTC will receive a call to LightweightRTComponent::detach_context.

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.reset_component	(		self,
			comp
	)

Reset a RT-component.

Attempt to recover the RTC when it is in Error. The ComponentAction::on_reset callback shall be invoked. This operation shall not return until the callback has returned, and shall result in an error if the callback does. If possible, the RTC developer should implement that callback such that the RTC may be returned to a valid state.

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.set_rate	(		self,
			rate
	)

Set ExecutionRate.

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.

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.start

(

self

)

Start ExecutionContext.

Request that the context enter the Running state. Once the state transition occurs, the ComponentAction::on_startup operation will be invoked. An execution context may not be started until the RT components that participate in it have been initialized. An execution context may be started and stopped multiple times.

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.stop

(

self

)

Stop ExecutionContext.

Request that the context enter the Stopped state. Once the transition occurs, the ComponentAction::on_shutdown operation will be invoked. An execution context must be stopped before the RT components that participate in it are finalized. An execution context may be started and stopped multiple times.

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.svc

(

self

)

Create internal activity thread.

Run by a daemon thread to handle deferred processing. ACE_Task class method override.

---

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

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