Public Member Functions | Protected Attributes
ConsoleIn Class Reference

#include <ConsoleIn.h>

Inheritance diagram for ConsoleIn:
Inheritance graph
[legend]

List of all members.

Public Member Functions

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

Protected Attributes

TimedLong m_out
OutPort< TimedLong > m_outOut

Detailed Description

Definition at line 32 of file ExtTrigger/ConsoleIn.h.


Constructor & Destructor Documentation

Definition at line 31 of file ExtTrigger/ConsoleIn.cpp.

Definition at line 39 of file ExtTrigger/ConsoleIn.cpp.


Member Function Documentation

RTC::ReturnCode_t ConsoleIn::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 64 of file ExtTrigger/ConsoleIn.cpp.

virtual RTC::ReturnCode_t ConsoleIn::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.

RTC::ReturnCode_t ConsoleIn::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 ExtTrigger/ConsoleIn.cpp.

virtual RTC::ReturnCode_t ConsoleIn::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.


Member Data Documentation

TimedLong ConsoleIn::m_out [protected]

Definition at line 97 of file ExtTrigger/ConsoleIn.h.

OutPort< TimedLong > ConsoleIn::m_outOut [protected]

Definition at line 98 of file ExtTrigger/ConsoleIn.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