|
OpenRTM-aist-Python 1.2.1
|
Public Member Functions | |
| def | __init__ (self) |
| Default Constructor. More... | |
| def | isRunning (self) |
| Check for ExecutionContext running state. More... | |
| def | start (self) |
| Start the ExecutionContext. More... | |
| def | stop (self) |
| Stop the ExecutionContext. More... | |
| def | activateComponent (self, comp, rtobj) |
| Activate an RT-component. More... | |
| def | deactivateComponent (self, comp, rtobj) |
| Deactivate an RT-component. More... | |
| def | resetComponent (self, comp, rtobj) |
| Reset the RT-component. More... | |
| def | getComponentState (self, comp) |
| Get RT-component's state. More... | |
| def | addComponent (self, comp) |
| Add an RT-component. More... | |
| def | bindComponent (self, rtc) |
| Bind the component. More... | |
| def | removeComponent (self, comp) |
| Remove the RT-Component from participant list. More... | |
| def OpenRTM_aist.ExecutionContextWorker.ExecutionContextWorker.__init__ | ( | self | ) |
Default Constructor.
Default Constructor Set the following items to profile.
| def OpenRTM_aist.ExecutionContextWorker.ExecutionContextWorker.activateComponent | ( | self, | |
| comp, | |||
| rtobj | |||
| ) |
Activate an 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.
| comp | The target RT-Component for activation |
RTC::ReturnCode_t activateComponent(RTC::LightweightRTObject_ptr comp, RTObjectStateMachine*& rtobj);
| def OpenRTM_aist.ExecutionContextWorker.ExecutionContextWorker.addComponent | ( | self, | |
| comp | |||
| ) |
Add an 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. BAD_PARAMETER will be invoked, if the given RT-Component is null or if the given RT-Component is other than DataFlowComponent.
| comp | The target RT-Component for add |
RTC::ReturnCode_t addComponent(RTC::LightweightRTObject_ptr comp);
| def OpenRTM_aist.ExecutionContextWorker.ExecutionContextWorker.bindComponent | ( | self, | |
| rtc | |||
| ) |
Bind the component.
Bind the component.
| rtc | RT-Component's instances |
| def OpenRTM_aist.ExecutionContextWorker.ExecutionContextWorker.deactivateComponent | ( | self, | |
| comp, | |||
| rtobj | |||
| ) |
Deactivate an 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.
| comp | The target RT-Component for deactivate |
RTC::ReturnCode_t deactivateComponent(RTC::LightweightRTObject_ptr comp, RTObjectStateMachine*& rtobj);
| def OpenRTM_aist.ExecutionContextWorker.ExecutionContextWorker.getComponentState | ( | self, | |
| comp | |||
| ) |
Get RT-component's state.
This operation shall report the LifeCycleState of the given participant RTC. UNKNOWN_STATE will be returned, if the given RT-Component is not inclued in the participant list.
| comp | The target RT-Component to get the state |
RTC::LifeCycleState getComponentState(RTC::LightweightRTObject_ptr comp);
| def OpenRTM_aist.ExecutionContextWorker.ExecutionContextWorker.isRunning | ( | 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.
bool isRunning(void);
| def OpenRTM_aist.ExecutionContextWorker.ExecutionContextWorker.removeComponent | ( | 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. BAD_PARAMETER will be returned, if the given RT-Component is not participating in the participant list.
| comp | The target RT-Component for delete |
RTC::ReturnCode_t removeComponent(RTC::LightweightRTObject_ptr comp);
| def OpenRTM_aist.ExecutionContextWorker.ExecutionContextWorker.resetComponent | ( | self, | |
| comp, | |||
| rtobj | |||
| ) |
Reset the 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.
| comp | The target RT-Component for reset |
RTC::ReturnCode_t resetComponent(RTC::LightweightRTObject_ptr com, RTObjectStateMachine*& rtobj);
| def OpenRTM_aist.ExecutionContextWorker.ExecutionContextWorker.start | ( | self | ) |
Start the 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.
RTC::ReturnCode_t start(void);
| def OpenRTM_aist.ExecutionContextWorker.ExecutionContextWorker.stop | ( | self | ) |
Stop the 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.
RTC::ReturnCode_t stop(void);
1.8.11