OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext Class Reference
PeriodicExecutionContext class. More...
Classes | |
| class | WorkerThreadCtrl |
| Condition variable class for worker. More... | |
Public Member Functions | |
| def | __init__ |
| Constructor. | |
| def | svc |
| Create internal activity thread. | |
| def | open |
| Generate internal activity thread for ExecutionContext. | |
| def | close |
| Close activity thread. | |
| def | is_running |
| Check for ExecutionContext running state. | |
| def | start |
| Start ExecutionContext. | |
| def | stop |
| Stop ExecutionContext. | |
| def | get_rate |
| Get ExecutionRate. | |
| def | set_rate |
| Set ExecutionRate. | |
| def | activate_component |
| Activate a RT-component. | |
| def | deactivate_component |
| Deactivate a RT-component. | |
| def | reset_component |
| Reset a RT-component. | |
| def | get_component_state |
| Get RT-component's state. | |
| def | get_kind |
| Get the ExecutionKind. | |
| def | add_component |
| Add a RT-component. | |
| def | remove_component |
| Remove the RT-component from participant list. | |
| def | get_profile |
| Get the ExecutionContextProfile. | |
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 | ||||
| ) |
| 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.
| 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.open | ( | self, | ||
| args | ||||
| ) |
Generate internal activity thread for ExecutionContext.
int PeriodicExecutionContext.open(void *args)
Reimplemented from OpenRTM_aist.Task.Task.
| def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.remove_component | ( | self, | ||
| comp | ||||
| ) |
| 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.
Reimplemented from OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.
| 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.
| 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.
The documentation for this class was generated from the following file:
- /var/lib/jenkins/jobs/01_openrtm-python-build-tags/workspace/OpenRTM_aist/PeriodicExecutionContext.py
