OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext Class Reference

More...

Inheritance diagram for OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext:

Classes
class	WorkerThreadCtrl

Public Member Functions
def	__init__ (self)
def	exit (self, Task=OpenRTM_aist.Task)
def	init (self, props)
def	svc (self)
def	open (self, *args)
def	close (self, flags)
def	is_running (self)
def	start (self)
def	stop (self)
def	get_rate (self)
def	set_rate (self, rate)
def	activate_component (self, comp)
def	deactivate_component (self, comp)
def	reset_component (self, comp)
def	get_component_state (self, comp)
def	get_kind (self)
def	add_component (self, comp)
def	remove_component (self, comp)
def	get_profile (self)
Public Member Functions inherited from OpenRTM_aist.ExecutionContextBase.ExecutionContextBase
def	init (self, props)
def	exit (self)
def	bindComponent (self, rtc)
def	isRunning (self)
def	start (self)
def	stop (self)
def	getRate (self)
def	setRate (self, rate)
def	addComponent (self, comp)
def	removeComponent (self, comp)
def	activateComponent (self, comp)
def	deactivateComponent (self, comp)
def	resetComponent (self, comp)
def	getComponentState (self, comp)
def	getKind (self)
def	getProfile (self)
def	setObjRef (self, ec_ptr)
def	getObjRef (self)
def	getKindString (self, kind)
def	setKind (self, kind)
def	setOwner (self, comp)
def	getOwner (self)
def	getComponentList (self)
def	setProperties (self, props)
def	getProperties (self)
def	isAllCurrentState (self, state)
def	setExecutionRate (self, props)
def	setTransitionMode (self, props, key, flag=False)
def	setTimeout (self, props, key, timevalue=0.0)

Detailed Description

PeriodicExecutionContext class

Constructor & Destructor Documentation

__init__()

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.__init__

(

self

)

Constructor

Reimplemented from OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.

Reimplemented in OpenRTM_aist.EventDrivenExecutionContext.EventDrivenExecutionContext, and OpenRTM_aist.MultilayerCompositeEC.MultilayerCompositeEC.

Member Function Documentation

activate_component()

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.

Reimplemented from OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.

add_component()

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.

Reimplemented from OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.

close()

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.

Reimplemented from OpenRTM_aist.Task.Task.

deactivate_component()

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.

Reimplemented from OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.

exit()

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.exit	(		self,
			Task = OpenRTM_aist.Task
	)

Parameters

self
Task

Reimplemented from OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.

Reimplemented in OpenRTM_aist.MultilayerCompositeEC.MultilayerCompositeEC.

get_component_state()

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.

Reimplemented from OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.

get_kind()

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.get_kind

(

self

)

Get the ExecutionKind

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

Reimplemented from OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.

get_profile()

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.get_profile

(

self

)

Get the ExecutionContextProfile

This operation provides a profile “descriptor” for the execution context.

Reimplemented from OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.

get_rate()

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.

Reimplemented from OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.

init()

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

Parameters

self
props

Reimplemented from OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.

Reimplemented in OpenRTM_aist.MultilayerCompositeEC.MultilayerCompositeEC.

is_running()

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.

Reimplemented from OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.

open()

def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.open	(		self,
		*	args
	)

Generate internal activity thread for ExecutionContext

int PeriodicExecutionContext::open(void *args)

Reimplemented from OpenRTM_aist.Task.Task.

remove_component()

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.

Reimplemented from OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.

reset_component()

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.

Reimplemented from OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.

set_rate()

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.

Reimplemented from OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.

start()

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.

Reimplemented from OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.

stop()

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.

Reimplemented from OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.

svc()

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.

Reimplemented from OpenRTM_aist.Task.Task.

Reimplemented in OpenRTM_aist.MultilayerCompositeEC.MultilayerCompositeEC.

---

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

• C:/docs/OpenRTM-aist-Python/OpenRTM_aist/PeriodicExecutionContext.py