#include <RTSample.h>
Public Member Functions | |
| virtual RTC::ReturnCode_t | onActivated (RTC::UniqueId ec_id) |
| Callback function to activate. | |
| virtual RTC::ReturnCode_t | onDeactivated (RTC::UniqueId ec_id) |
| Callback function to deactivate. | |
| virtual RTC::ReturnCode_t | onExecute (RTC::UniqueId ec_id) |
| Callback function to execute periodically. | |
| virtual RTC::ReturnCode_t | onInitialize () |
| Callback function to initialize. | |
| RTSample (RTC::Manager *manager) | |
| ~RTSample () | |
Private Attributes | |
| coil::TimeMeasure | m_tm |
Detailed Description
Definition at line 31 of file RTSample.h.
Constructor & Destructor Documentation
| RTSample::RTSample | ( | RTC::Manager * | manager | ) |
Definition at line 29 of file RTSample.cpp.
Definition at line 36 of file RTSample.cpp.
Member Function Documentation
| RTC::ReturnCode_t RTSample::onActivated | ( | RTC::UniqueId | exec_handle | ) | [virtual] |
Callback function to activate.
This is a callback function that is executed when ComponentAction::on_activated was invoked.
As for actual activation of each component, since this function is dummy-implemented to return RTC::RTC_OK unconditionally, you need to implement this function by overriding it.
- Parameters:
-
exec_handle ID of the participant ExecutionContext
- Returns:
- The return code of ReturnCode_t type
Reimplemented from RTC::RTObject_impl.
Definition at line 84 of file RTSample.cpp.
| RTC::ReturnCode_t RTSample::onDeactivated | ( | RTC::UniqueId | exec_handle | ) | [virtual] |
Callback function to deactivate.
This is a callback function that is executed when ComponentAction::on_deactivated was invoked.
As for actual deactivation of each component, since this function is dummy-implemented to return RTC::RTC_OK unconditionally, you need to implement this function by overriding it.
- Parameters:
-
exec_handle ID of the participant ExecutionContext
- Returns:
- The return code of ReturnCode_t type
Reimplemented from RTC::RTObject_impl.
Definition at line 91 of file RTSample.cpp.
| RTC::ReturnCode_t RTSample::onExecute | ( | RTC::UniqueId | exec_handle | ) | [virtual] |
Callback function to execute periodically.
This is a callback function that is executed when DataFlowComponentAction::on_execute is invoked.
As for actual periodic execution of each component, since this function is dummy-implemented to return RTC::RTC_OK unconditionally, you need to implement this function by overriding it. This function is invoked periodically as the first execution pass of Two-Pass Execution in Periodic Sampled Data Processing.
- Parameters:
-
exec_handle ID of the participant ExecutionContext
- Returns:
- The return code of ReturnCode_t type
Reimplemented from RTC::RTObject_impl.
Definition at line 103 of file RTSample.cpp.
| RTC::ReturnCode_t RTSample::onInitialize | ( | void | ) | [virtual] |
Callback function to initialize.
This is a callback function that is executed when ComponentAction::on_initialize was invoked.
As for actual initialization of each component, since this function is dummy-implemented to return RTC::RTC_OK unconditionally, you need to implement this function by overriding it.
- Returns:
- The return code of ReturnCode_t type
Reimplemented from RTC::RTObject_impl.
Definition at line 41 of file RTSample.cpp.
Member Data Documentation
coil::TimeMeasure RTSample::m_tm [private] |
Definition at line 118 of file RTSample.h.
The documentation for this class was generated from the following files: