PeriodicECSharedComposite class. More...

Inheritance diagram for OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite:

Public Member Functions
def	__del__
	Destructor.
def	__init__
	Constructor.
def	onActivated
	Callback function to activate.
def	onDeactivated
	Callback function to deactivate.
def	onFinalize
	[ComponentAction CORBA interface] Finalize RTC
def	onInitialize
	Initialization.
def	onReset
	Callback function to reset.
Private Attributes
	_members
	_objref
	_org
	_ref
	_rtcout

Detailed Description

PeriodicECSharedComposite class.

This is a base class of the data flow type RT-Component. Inherit this class when implementing various data flow type RT-Components.

Since:: 0.4.0

Definition at line 617 of file PeriodicECSharedComposite.py.

Constructor & Destructor Documentation

def OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.__init__	(	self,
		manager
	)

Constructor.

Constructor

Parameters:

manager Manager object

Definition at line 637 of file PeriodicECSharedComposite.py.

def OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.__del__ ( self )

Destructor.

Destructor

Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.

Definition at line 672 of file PeriodicECSharedComposite.py.

Member Function Documentation

def OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.onActivated	(	self,
		exec_handle
	)

Callback function to activate.

This is a callback function that is executed when ComponentAction::on_activated was invoked.
As for actual activation of each component, since this function is dummy-implemented to return RTC::RTC_OK unconditionally, you need to implement this function by overriding it.

Parameters:

exec_handle ID of the participant ExecutionContext

Returns:: The return code of ReturnCode_t type

Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.

Definition at line 759 of file PeriodicECSharedComposite.py.

def OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.onDeactivated	(	self,
		exec_handle
	)

Callback function to deactivate.

This is a callback function that is executed when ComponentAction::on_deactivated was invoked.
As for actual deactivation of each component, since this function is dummy-implemented to return RTC::RTC_OK unconditionally, you need to implement this function by overriding it.

Parameters:

exec_handle ID of the participant ExecutionContext

Returns:: The return code of ReturnCode_t type

Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.

Definition at line 813 of file PeriodicECSharedComposite.py.

def OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.onFinalize ( self )

[ComponentAction CORBA interface] Finalize RTC

The RTC is being destroyed. Any final RTC-specific tear-down logic should be performed here. As a result of this operation, onFinalize() callback function is called.

Returns:: The return code of ReturnCode_t type

Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.

Definition at line 891 of file PeriodicECSharedComposite.py.

def OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.onInitialize ( self )

Initialization.

Initialization the data flow type RT-Component. Write the actual initialization code in each concrete class.

Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.

Definition at line 692 of file PeriodicECSharedComposite.py.

def OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.onReset	(	self,
		exec_handle
	)

Callback function to reset.

This is a callback function that is executed when ComponentAction::on_reset was invoked.
As for actual reset of each component, since this function is dummy-implemented to return RTC::RTC_OK unconditionally, you need to implement this function by overriding it.

Parameters:

exec_handle ID of the participant ExecutionContext