RTC::PeriodicECSharedComposite Class Reference

PeriodicECSharedComposite class. More...

#include <PeriodicECSharedComposite.h>

Inheritance diagram for RTC::PeriodicECSharedComposite:

Public Member Functions
	PeriodicECSharedComposite (Manager *manager)
	Constructor.
virtual	~PeriodicECSharedComposite (void)
	Destructor.
virtual ReturnCode_t	onInitialize (void)
	Initialization.
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	onReset (RTC::UniqueId exec_handle)
	Callback function to reset.
virtual ReturnCode_t	onFinalize (void)
	[ComponentAction CORBA interface] Finalize RTC
Protected Attributes
std::vector< std::string >	m_members
	Components.
OpenRTM::DataFlowComponent_var	m_ref
	Reference of object.
SDOPackage::PeriodicECOrganization *	m_org
	Reference of Organization.

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

Constructor & Destructor Documentation

RTC::PeriodicECSharedComposite::PeriodicECSharedComposite ( Manager * manager )

Constructor.

Constructor

Parameters:

manager

Manager object

virtual RTC::PeriodicECSharedComposite::~PeriodicECSharedComposite ( void ) [virtual]

Destructor.

Destructor

Member Function Documentation

virtual 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_handle

ID of the participant ExecutionContext

Returns:: The return code of ReturnCode_t type

Reimplemented from RTC::RTObject_impl.

virtual 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_handle

ID of the participant ExecutionContext

Returns:: The return code of ReturnCode_t type

Reimplemented from RTC::RTObject_impl.

virtual 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.

virtual 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.

virtual 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_handle

ID of the participant ExecutionContext