Public Member Functions | Protected Attributes
Sensor Class Reference

#include <Sensor.h>

Inheritance diagram for Sensor:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual RTC::ReturnCode_t onExecute (RTC::UniqueId ec_id)
 Callback function to execute periodically.
virtual RTC::ReturnCode_t onInitialize ()
 Callback function to initialize.
 Sensor (RTC::Manager *manager)
 ~Sensor ()

Protected Attributes

TimedLong m_in
InPort< TimedLong > m_inIn
TimedFloat m_out
OutPort< TimedFloat > m_outOut

Detailed Description

Definition at line 29 of file Sensor.h.


Constructor & Destructor Documentation

Sensor::Sensor ( RTC::Manager manager)

Definition at line 29 of file Sensor.cpp.

Definition at line 39 of file Sensor.cpp.


Member Function Documentation

RTC::ReturnCode_t Sensor::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_handleID of the participant ExecutionContext
Returns:
The return code of ReturnCode_t type

Reimplemented from RTC::RTObject_impl.

Definition at line 102 of file Sensor.cpp.

RTC::ReturnCode_t Sensor::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 44 of file Sensor.cpp.


Member Data Documentation

TimedLong Sensor::m_in [protected]

Definition at line 92 of file Sensor.h.

InPort<TimedLong> Sensor::m_inIn [protected]

Definition at line 93 of file Sensor.h.

TimedFloat Sensor::m_out [protected]

Definition at line 99 of file Sensor.h.

OutPort<TimedFloat> Sensor::m_outOut [protected]

Definition at line 100 of file Sensor.h.


The documentation for this class was generated from the following files:


openrtm_aist
Author(s): Noriaki Ando
autogenerated on Thu Aug 27 2015 14:16:40