OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite Class Reference
PeriodicECSharedComposite class. More...
Public Member Functions | |
| def | __init__ |
| Constructor. | |
| def | __del__ |
| Destructor. | |
| def | onInitialize |
| Initialization. | |
| def | onActivated |
| Callback function to activate. | |
| def | onDeactivated |
| Callback function to deactivate. | |
| def | onReset |
| Callback function to reset. | |
| def | onFinalize |
| [ComponentAction CORBA interface] Finalize RTC | |
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
Member Function Documentation
| def OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.__del__ | ( | self | ) |
| def OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.__init__ | ( | self, | ||
| manager | ||||
| ) |
Constructor.
Constructor
- Parameters:
-
manager Manager object
| 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.
| 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.
| 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.
| 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.
| 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
- Returns:
- The return code of ReturnCode_t type
Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.
The documentation for this class was generated from the following file:
- /var/lib/jenkins/jobs/01_openrtm-python-build-tags/workspace/OpenRTM_aist/PeriodicECSharedComposite.py
