RTC::DataFlowComponentAction Interface Reference
DataFlowComponentAction. More...
import "RTC.idl";
Public Member Functions | |
| ReturnCode_t | on_execute (in ExecutionContextHandle_t exec_handle) |
| on_execute | |
| ReturnCode_t | on_state_update (in ExecutionContextHandle_t exec_handle) |
| on_state_update | |
| ReturnCode_t | on_rate_changed (in ExecutionContextHandle_t exec_handle) |
| on_rate_changed | |
Detailed Description
Description
DataFlowComponentAction is a companion to ComponentAction (see Section 5.2.2.4) that provides additional callbacks for intercepting the two execution passes defined in Section 5.3.1.1.2.
Member Function Documentation
| ReturnCode_t RTC::DataFlowComponentAction::on_execute | ( | in ExecutionContextHandle_t | exec_handle | ) |
on_execute
Description
This operation will be invoked periodically at the rate of the given execution context as long as the following conditions hold:
- The RTC is Active.
- The given execution context is Running.
Semantics
This callback occurs during the first execution pass.
Constraints
- The execution context of the given context shall be PERIODIC.
| ReturnCode_t RTC::DataFlowComponentAction::on_rate_changed | ( | in ExecutionContextHandle_t | exec_handle | ) |
on_rate_changed
Description
This operation is a notification that the rate of the indicated execution context (see Section 5.2.2.6.4) has changed.
Constraints
- The execution context of the given context shall be PERIODIC.
| ReturnCode_t RTC::DataFlowComponentAction::on_state_update | ( | in ExecutionContextHandle_t | exec_handle | ) |
on_state_update
Description
This operation will be invoked periodically at the rate of the given execution context as long as the following conditions hold:
- The RTC is Active.
- The given execution context is Running.
Semantics
This callback occurs during the second execution pass.
Constraints
- The execution context of the given context shall be PERIODIC.
The documentation for this interface was generated from the following file:
