RTC::ComponentAction Interface Reference
ComponentAction. More...
import "RTC.idl";
Inheritance diagram for RTC::ComponentAction:
Public Member Functions | |
| ReturnCode_t | on_initialize () |
| on_initialize | |
| ReturnCode_t | on_finalize () |
| on_finalize | |
| ReturnCode_t | on_startup (in ExecutionContextHandle_t exec_handle) |
| on_startup | |
| ReturnCode_t | on_shutdown (in ExecutionContextHandle_t exec_handle) |
| on_shutdown | |
| ReturnCode_t | on_activated (in ExecutionContextHandle_t exec_handle) |
| on_activated | |
| ReturnCode_t | on_deactivated (in ExecutionContextHandle_t exec_handle) |
| on_deactivated | |
| ReturnCode_t | on_aborting (in ExecutionContextHandle_t exec_handle) |
| on_aborting | |
| ReturnCode_t | on_error (in ExecutionContextHandle_t exec_handle) |
| on_error | |
| ReturnCode_t | on_reset (in ExecutionContextHandle_t exec_handle) |
| on_reset | |
Detailed Description
ComponentAction.
Description
The ComponentAction interface provides callbacks corresponding to the execution of the lifecycle operations of LightweightRTObject (see Section 5.2.2.2) and ExecutionContext (see Section 5.2.2.5). An RTC developer may implement these callback operations in order to execute application-specific logic pointing response to those transitions.Semantics
Clients of an RTC are not expected to invoke these operations directly; they are provided for the benefit of the RTC middleware implementation.Member Function Documentation
| ReturnCode_t RTC::ComponentAction::on_initialize | ( | ) |
on_initialize
Description
The RTC has been initialized and entered the Alive state.Semantics
Any RTC-specific initialization logic should be performed here.| ReturnCode_t RTC::ComponentAction::on_finalize | ( | ) |
on_finalize
Description
The RTC is being destroyed.Semantics
Any final RTC-specific tear-down logic should be performed here.| ReturnCode_t RTC::ComponentAction::on_startup | ( | in ExecutionContextHandle_t | exec_handle | ) |
on_startup
Description
The given execution context, in which the RTC is participating, has transitioned from Stopped to Running.| ReturnCode_t RTC::ComponentAction::on_shutdown | ( | in ExecutionContextHandle_t | exec_handle | ) |
on_shutdown
Description
The given execution context, in which the RTC is participating, has transitioned from Running to Stopped.| ReturnCode_t RTC::ComponentAction::on_activated | ( | in ExecutionContextHandle_t | exec_handle | ) |
| ReturnCode_t RTC::ComponentAction::on_deactivated | ( | in ExecutionContextHandle_t | exec_handle | ) |
| ReturnCode_t RTC::ComponentAction::on_aborting | ( | in ExecutionContextHandle_t | exec_handle | ) |
on_aborting
Description
The RTC is transitioning from the Active state to the Error state in some execution context.Semantics
This callback is invoked only a single time for time that the RTC transitions into the Error state from another state. This behavior is in contrast to that of on_error.| ReturnCode_t RTC::ComponentAction::on_error | ( | in ExecutionContextHandle_t | exec_handle | ) |
on_error
Description
The RTC remains in the Error state.Semantics
If the RTC is in the Error state relative to some execution context when it would otherwise be invoked from that context (according to the context¡Çs ExecutionKind), this callback shall be invoked instead. For example,
- If the ExecutionKind is PERIODIC, this operation shall be invoked in sorted order at the rate of the context instead of DataFlowComponentAction::on_execute and on_state_update.
- If the ExecutionKind is EVENT_DRIVEN, this operation shall be invoked whenever FsmParticipantAction::on_action would otherwise have been invoked.
| ReturnCode_t RTC::ComponentAction::on_reset | ( | in ExecutionContextHandle_t | exec_handle | ) |
on_reset
Description
The RTC is in the Error state. An attempt is being made to recover it such that it can return to the Inactive state.Semantics
If the RTC was successfully recovered and can safely return to the Inactive state, this method shall complete with ReturnCode_t::OK. Any other result shall indicate that the RTC should remain in the Error state.
The documentation for this interface was generated from the following file:
