PeriodicExecutionContext class. More...
Classes | |
| class | Comp |
| class | DFP |
| class | find_participant |
| class | Worker |
Public Member Functions | |
| def | __del__ (self, Task=OpenRTM_aist.Task) |
| def | __init__ (self, owner=None, rate=None) |
| Constructor. More... | |
| def | activate_component (self, comp) |
| Activate a RT-component. More... | |
| def | add_component (self, comp) |
| Add a RT-component. More... | |
| def | bindComponent (self, rtc) |
| def | close (self, flags) |
| Close activity thread. More... | |
| def | deactivate_component (self, comp) |
| Deactivate 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 | get_profile (self) |
| Get the ExecutionContextProfile. More... | |
| def | get_rate (self) |
| Get ExecutionRate. More... | |
| def | getObjRef (self) |
| def | is_running (self) |
| Check for ExecutionContext running state. More... | |
| def | remove_component (self, comp) |
| Remove the RT-component from participant list. More... | |
| def | reset_component (self, comp) |
| Reset a RT-component. More... | |
| def | set_rate (self, rate) |
| Set ExecutionRate. More... | |
| def | start (self) |
| Start ExecutionContext. More... | |
| def | stop (self) |
| Stop ExecutionContext. More... | |
| def | svc (self) |
| Create internal activity thread. More... | |
 Public Member Functions inherited from OpenRTM_aist.ExecutionContextBase.ExecutionContextBase | |
| def | __del__ (self) |
| def | bindComponent (self, rtc) |
| def | getObjeRef (self) |
| def | tick (self) |
| Destructor. More... | |
| Public Member Functions inherited from OpenRTM_aist.Task.Task | |
| def | __del__ (self) |
| def | __init__ (self) |
| def | activate (self) |
| def | close (self, flags=0) |
| def | finalize (self) |
| def | open (self, args=None) |
| def | reset (self) |
| def | resume (self) |
| def | suspend (self) |
| def | svc (self) |
| def | svc_run (self) |
| def | wait (self) |
Private Attributes | |
| _comps | |
| _mutex_del | |
| _nowait | |
| _period | |
| _profile | |
| _ref | |
| _rtcout | |
| _running | |
| _worker | |
Detailed Description
PeriodicExecutionContext class.
Definition at line 43 of file PeriodicExecutionContext.py.
Constructor & Destructor Documentation
◆ __init__()
| def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.__init__ | ( | self, | |
owner = None, |
|||
rate = None |
|||
| ) |
Constructor.
Definition at line 353 of file PeriodicExecutionContext.py.
◆ __del__()
| def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.__del__ | ( | self, | |
Task = OpenRTM_aist.Task |
|||
| ) |
Definition at line 386 of file PeriodicExecutionContext.py.
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.
Definition at line 726 of file PeriodicExecutionContext.py.
◆ 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.
Definition at line 912 of file PeriodicExecutionContext.py.
◆ bindComponent()
| def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.bindComponent | ( | self, | |
| rtc | |||
| ) |
Definition at line 934 of file PeriodicExecutionContext.py.
◆ 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.
Definition at line 503 of file PeriodicExecutionContext.py.
◆ 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.
Definition at line 767 of file PeriodicExecutionContext.py.
◆ 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.
Definition at line 855 of file PeriodicExecutionContext.py.
◆ get_kind()
| def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.get_kind | ( | self | ) |
Get the ExecutionKind.
This operation shall report the execution kind of the execution context.
Definition at line 881 of file PeriodicExecutionContext.py.
◆ get_profile()
| def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.get_profile | ( | self | ) |
Get the ExecutionContextProfile.
This operation provides a profile ¡Èdescriptor¡É for the execution context.
Definition at line 1014 of file PeriodicExecutionContext.py.
◆ 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.
Definition at line 653 of file PeriodicExecutionContext.py.
◆ getObjRef()
| def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.getObjRef | ( | self | ) |
Definition at line 416 of file PeriodicExecutionContext.py.
◆ 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.
Definition at line 531 of file PeriodicExecutionContext.py.
◆ 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.
Definition at line 977 of file PeriodicExecutionContext.py.
◆ 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.
Definition at line 822 of file PeriodicExecutionContext.py.
◆ 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.
Definition at line 683 of file PeriodicExecutionContext.py.
◆ 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.
Definition at line 563 of file PeriodicExecutionContext.py.
◆ 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.
Definition at line 618 of file PeriodicExecutionContext.py.
◆ 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.
Definition at line 435 of file PeriodicExecutionContext.py.
Member Data Documentation
◆ _comps
|
private |
Definition at line 379 of file PeriodicExecutionContext.py.
◆ _mutex_del
|
private |
Definition at line 382 of file PeriodicExecutionContext.py.
◆ _nowait
|
private |
Definition at line 359 of file PeriodicExecutionContext.py.
◆ _period
|
private |
Definition at line 367 of file PeriodicExecutionContext.py.
◆ _profile
|
private |
Definition at line 380 of file PeriodicExecutionContext.py.
◆ _ref
|
private |
Definition at line 381 of file PeriodicExecutionContext.py.
◆ _rtcout
|
private |
Definition at line 354 of file PeriodicExecutionContext.py.
◆ _running
|
private |
Definition at line 360 of file PeriodicExecutionContext.py.
◆ _worker
|
private |
Definition at line 362 of file PeriodicExecutionContext.py.
The documentation for this class was generated from the following file: