Public Member Functions | Protected Attributes
RTC::PeriodicECSharedComposite Class Reference

PeriodicECSharedComposite class. More...

#include <PeriodicECSharedComposite.h>

Inheritance diagram for RTC::PeriodicECSharedComposite:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual ReturnCode_t onActivated (RTC::UniqueId exec_handle)
 Callback function to activate.
virtual ReturnCode_t onDeactivated (RTC::UniqueId exec_handle)
 Callback function to deactivate.
virtual ReturnCode_t onFinalize (void)
 [ComponentAction CORBA interface] Finalize RTC
virtual ReturnCode_t onInitialize (void)
 Initialization.
virtual ReturnCode_t onReset (RTC::UniqueId exec_handle)
 Callback function to reset.
 PeriodicECSharedComposite (Manager *manager)
 Constructor.
virtual ~PeriodicECSharedComposite (void)
 Destructor.

Protected Attributes

std::vector< std::string > m_members
 Components.
SDOPackage::PeriodicECOrganizationm_org
 Reference of Organization.
OpenRTM::DataFlowComponent_var m_ref
 Reference of object.

Detailed Description

PeriodicECSharedComposite class.

This is a base class of the data flow type RT-Component. Inherit this class when implementing various data flow type RT-Components.

Since:
0.4.0

Definition at line 466 of file PeriodicECSharedComposite.h.


Constructor & Destructor Documentation

Constructor.

Constructor

Parameters:
managerManager object

Definition at line 601 of file PeriodicECSharedComposite.cpp.

Destructor.

Destructor

Definition at line 624 of file PeriodicECSharedComposite.cpp.


Member Function Documentation

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

Reimplemented from RTC::RTObject_impl.

Definition at line 696 of file PeriodicECSharedComposite.cpp.

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

Reimplemented from RTC::RTObject_impl.

Definition at line 719 of file PeriodicECSharedComposite.cpp.

ReturnCode_t RTC::PeriodicECSharedComposite::onFinalize ( void  ) [virtual]

[ComponentAction CORBA interface] Finalize RTC

The RTC is being destroyed. Any final RTC-specific tear-down logic should be performed here. As a result of this operation, onFinalize() callback function is called.

Returns:
The return code of ReturnCode_t type

Reimplemented from RTC::RTObject_impl.

Definition at line 761 of file PeriodicECSharedComposite.cpp.

ReturnCode_t RTC::PeriodicECSharedComposite::onInitialize ( void  ) [virtual]

Initialization.

Initialization the data flow type RT-Component. Write the actual initialization code in each concrete class.

Reimplemented from RTC::RTObject_impl.

Definition at line 637 of file PeriodicECSharedComposite.cpp.

ReturnCode_t RTC::PeriodicECSharedComposite::onReset ( RTC::UniqueId  exec_handle) [virtual]

Callback function to reset.

This is a callback function that is executed when ComponentAction::on_reset was invoked.
As for actual reset 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_handleID of the participant ExecutionContext
Returns:
The return code of ReturnCode_t type

Reimplemented from RTC::RTObject_impl.

Definition at line 740 of file PeriodicECSharedComposite.cpp.


Member Data Documentation

std::vector<std::string> RTC::PeriodicECSharedComposite::m_members [protected]

Components.

Definition at line 650 of file PeriodicECSharedComposite.h.

Reference of Organization.

Definition at line 669 of file PeriodicECSharedComposite.h.

OpenRTM::DataFlowComponent_var RTC::PeriodicECSharedComposite::m_ref [protected]

Reference of object.

Definition at line 659 of file PeriodicECSharedComposite.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:41