OpenRTM-aist  1.2.1
Public Member Functions | Protected Attributes | List of all members
RTC::PeriodicECSharedComposite Class Reference

PeriodicECSharedComposite class. More...

#include <PeriodicECSharedComposite.h>

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

Public Member Functions

 PeriodicECSharedComposite (Manager *manager)
 Constructor. More...
 
virtual ~PeriodicECSharedComposite (void)
 Destructor. More...
 
virtual ReturnCode_t onInitialize (void)
 Initialization. More...
 
virtual ReturnCode_t onActivated (RTC::UniqueId exec_handle)
 Callback function to activate. More...
 
virtual ReturnCode_t onDeactivated (RTC::UniqueId exec_handle)
 Callback function to deactivate. More...
 
virtual ReturnCode_t onReset (RTC::UniqueId exec_handle)
 Callback function to reset. More...
 
virtual ReturnCode_t onFinalize (void)
 [ComponentAction CORBA interface] Finalize RTC More...
 
virtual ReturnCode_t exit () throw (CORBA::SystemException)
 [CORBA interface]top the RTC's execution context(s) and finalize it along with its contents. More...
 
- Public Member Functions inherited from RTC::RTObject_impl
 RTObject_impl (Manager *manager)
 Constructor. More...
 
 RTObject_impl (CORBA::ORB_ptr orb, PortableServer::POA_ptr poa)
 Constructor. More...
 
virtual ~RTObject_impl (void)
 Virtual destructor. More...
 
virtual ReturnCode_t initialize () throw (CORBA::SystemException)
 [CORBA interface] Initialize the RTC that realizes this interface. More...
 
virtual ReturnCode_t finalize () throw (CORBA::SystemException)
 [CORBA interface] Finalize the RTC for destruction More...
 
virtual CORBA::Boolean is_alive (ExecutionContext_ptr exec_context) throw (CORBA::SystemException)
 [CORBA interface] Confirm whether RTC is the alive state More...
 
virtual ExecutionContext_ptr get_context (UniqueId exec_handle) throw (CORBA::SystemException)
 [CORBA interface] Get ExecutionContext. More...
 
virtual ExecutionContextList * get_owned_contexts () throw (CORBA::SystemException)
 [CORBA interface] Get ExecutionContextList. More...
 
virtual ExecutionContextList * get_participating_contexts () throw (CORBA::SystemException)
 [CORBA interface] Get participating ExecutionContextList. More...
 
virtual ExecutionContextHandle_t get_context_handle (ExecutionContext_ptr cxt) throw (CORBA::SystemException)
 [CORBA interface] Return a handle of a ExecutionContext More...
 
UniqueId attach_context (ExecutionContext_ptr exec_context) throw (CORBA::SystemException)
 [CORBA interface] Attach ExecutionContext More...
 
UniqueId bindContext (ExecutionContext_ptr exec_context)
 
ReturnCode_t detach_context (UniqueId exec_handle) throw (CORBA::SystemException)
 [CORBA interface] Detach ExecutionContext. More...
 
virtual ComponentProfile * get_component_profile () throw (CORBA::SystemException)
 [RTObject CORBA interface] Get RTC's profile More...
 
virtual PortServiceList * get_ports () throw (CORBA::SystemException)
 [RTObject CORBA interface] Get Ports More...
 
virtual ReturnCode_t on_initialize () throw (CORBA::SystemException)
 [RTObject CORBA interface] Get ExecutionContextAdmin More...
 
virtual ReturnCode_t on_finalize () throw (CORBA::SystemException)
 [ComponentAction CORBA interface] Finalize RTC More...
 
virtual ReturnCode_t on_startup (UniqueId exec_handle) throw (CORBA::SystemException)
 [ComponentAction CORBA interface] Startup RTC More...
 
virtual ReturnCode_t on_shutdown (UniqueId exec_handle) throw (CORBA::SystemException)
 [ComponentAction CORBA interface] Shutdown RTC More...
 
virtual ReturnCode_t on_activated (UniqueId exec_handle) throw (CORBA::SystemException)
 [ComponentAction CORBA interface] Activate RTC More...
 
virtual ReturnCode_t on_deactivated (UniqueId exec_handle) throw (CORBA::SystemException)
 [ComponentAction CORBA interface] Deactivate RTC More...
 
virtual ReturnCode_t on_aborting (UniqueId exec_handle) throw (CORBA::SystemException)
 [ComponentAction CORBA interface] Transition to Error State More...
 
virtual ReturnCode_t on_error (UniqueId exec_handle) throw (CORBA::SystemException)
 [ComponentAction CORBA interface] Error Processing of RTC More...
 
virtual ReturnCode_t on_reset (UniqueId exec_handle) throw (CORBA::SystemException)
 [ComponentAction CORBA interface] Resetting RTC More...
 
virtual ReturnCode_t on_execute (UniqueId exec_handle) throw (CORBA::SystemException)
 [DataFlowComponentAction CORBA interface] Primary Periodic Operation of RTC More...
 
virtual ReturnCode_t on_state_update (UniqueId exec_handle) throw (CORBA::SystemException)
 [DataFlowComponentAction CORBA interface] Secondary Periodic Operation of RTC More...
 
virtual ReturnCode_t on_rate_changed (UniqueId exec_handle) throw (CORBA::SystemException)
 [DataFlowComponentAction CORBA interface] Notify rate changed More...
 
virtual SDOPackage::OrganizationList * get_owned_organizations () throw (CORBA::SystemException, SDOPackage::NotAvailable, SDOPackage::InternalError)
 [SDO interface] Get Organization list More...
 
virtual char * get_sdo_id () throw (CORBA::SystemException, SDOPackage::NotAvailable, SDOPackage::InternalError)
 [SDO interface] Get the SDO ID More...
 
virtual char * get_sdo_type () throw (CORBA::SystemException, SDOPackage::NotAvailable, SDOPackage::InternalError)
 [SDO interface] Get SDO type More...
 
virtual SDOPackage::DeviceProfile * get_device_profile () throw (CORBA::SystemException, SDOPackage::NotAvailable, SDOPackage::InternalError)
 [SDO interface] Get SDO DeviceProfile list More...
 
virtual SDOPackage::ServiceProfileList * get_service_profiles () throw (CORBA::SystemException, SDOPackage::NotAvailable, SDOPackage::InternalError)
 [SDO interface] Get SDO ServiceProfile More...
 
virtual SDOPackage::ServiceProfile * get_service_profile (const char *id) throw (CORBA::SystemException, SDOPackage::InvalidParameter, SDOPackage::NotAvailable, SDOPackage::InternalError)
 [SDO interface] Get specified ServiceProfile More...
 
virtual SDOPackage::SDOService_ptr get_sdo_service (const char *id) throw (CORBA::SystemException, SDOPackage::InvalidParameter, SDOPackage::NotAvailable, SDOPackage::InternalError)
 [SDO interface] Get specified SDO Service's reference More...
 
virtual SDOPackage::Configuration_ptr get_configuration () throw (CORBA::SystemException, SDOPackage::InterfaceNotImplemented, SDOPackage::NotAvailable, SDOPackage::InternalError)
 [SDO interface] Get Configuration object More...
 
virtual SDOPackage::Monitoring_ptr get_monitoring () throw (CORBA::SystemException, SDOPackage::InterfaceNotImplemented, SDOPackage::NotAvailable, SDOPackage::InternalError)
 [SDO interface] Get Monitoring object More...
 
virtual SDOPackage::OrganizationList * get_organizations () throw (CORBA::SystemException, SDOPackage::NotAvailable, SDOPackage::InternalError)
 [SDO interface] Get Organization list More...
 
virtual SDOPackage::NVList * get_status_list () throw (CORBA::SystemException, SDOPackage::NotAvailable, SDOPackage::InternalError)
 [SDO interface] Get SDO Status list More...
 
virtual CORBA::Any * get_status (const char *name) throw (CORBA::SystemException, SDOPackage::InvalidParameter, SDOPackage::NotAvailable, SDOPackage::InternalError)
 [SDO interface] Get SDO Status More...
 
const char * getInstanceName ()
 [local interface] Get instance name More...
 
void setInstanceName (const char *instance_name)
 [local interface] Set instance name More...
 
const char * getTypeName ()
 [local interface] Get type name More...
 
const char * getDescription ()
 [local interface] GetDescription More...
 
const char * getVersion ()
 [local interface] Get version information More...
 
const char * getVendor ()
 [local interface] Get vendor More...
 
const char * getCategory ()
 [local interface] Get category information More...
 
std::vector< std::string > getNamingNames ()
 [local interface] Get Naming Server information More...
 
void setObjRef (const RTObject_ptr rtobj)
 [local interface] Set the object reference More...
 
RTObject_ptr getObjRef () const
 [local interface] Get the object reference More...
 
void setProperties (const coil::Properties &prop)
 [local interface] Set RTC property More...
 
coil::PropertiesgetProperties ()
 [local interface] Get RTC property More...
 
template<typename VarType >
bool bindParameter (const char *param_name, VarType &var, const char *def_val, bool(*trans)(VarType &, const char *)=coil::stringTo)
 Setup for configuration parameters. More...
 
ConfigAdmingetConfigService ()
 Getting configuration service. More...
 
void updateParameters (const char *config_set)
 Update configuration parameters (by ID) More...
 
bool addPort (PortBase &port)
 [local interface] Register Port More...
 
bool addPort (PortService_ptr port)
 [local interface] Register Port More...
 
bool addPort (CorbaPort &port)
 [local interface] Register Port More...
 
void registerPort (PortBase &port)
 [local interface] Register Port More...
 
void registerPort (PortService_ptr port)
 [local interface] Register Port More...
 
void registerPort (CorbaPort &port)
 [local interface] Register Port More...
 
bool addInPort (const char *name, InPortBase &inport)
 [local interface] Register DataInPort More...
 
const std::vector< InPortBase * > & getInPorts () const
 
const std::vector< OutPortBase * > & getOutPorts () const
 
void registerInPort (const char *name, InPortBase &inport)
 [local interface] Register DataInPort More...
 
bool addOutPort (const char *name, OutPortBase &outport)
 [local interface] Register DataOutPort More...
 
void registerOutPort (const char *name, OutPortBase &outport)
 [local interface] Register DataOutPort More...
 
bool removeInPort (InPortBase &port)
 [local interface] Unregister InPort More...
 
bool removeOutPort (OutPortBase &port)
 [local interface] Unregister OutPort More...
 
bool removePort (PortBase &port)
 [local interface] Unregister Port More...
 
bool removePort (PortService_ptr port)
 [local interface] Unregister Port More...
 
bool removePort (CorbaPort &port)
 [local interface] Unregister Port More...
 
void deletePort (PortBase &port)
 [local interface] Unregister Port More...
 
void deletePort (PortService_ptr port)
 [local interface] Unregister Port More...
 
void deletePort (CorbaPort &port)
 [local interface] Unregister Port More...
 
void deletePortByName (const char *port_name)
 [local interface] Delete Port by specifying its name More...
 
ExecutionContext_ptr getExecutionContext (RTC::UniqueId ec_id)
 [local interface] Getting current execution context More...
 
double getExecutionRate (RTC::UniqueId ec_id)
 [local interface] Getting current context' execution rate More...
 
ReturnCode_t setExecutionRate (RTC::UniqueId ec_id, double rate)
 [local interface] Setting current context' execution rate More...
 
bool isOwnExecutionContext (RTC::UniqueId ec_id)
 [local interface] Checking if the current context is own context More...
 
ReturnCode_t deactivate (RTC::UniqueId ec_id)
 [local interface] Make transition to Inactive state More...
 
ReturnCode_t activate (RTC::UniqueId ec_id)
 [local interface] Make transition to Active state More...
 
ReturnCode_t reset (RTC::UniqueId ec_id)
 [local interface] Resetting and go to Inactive state More...
 
bool addSdoServiceProvider (const SDOPackage::ServiceProfile &prof, SdoServiceProviderBase *provider)
 [local interface] Set a SDO service provider More...
 
bool removeSdoServiceProvider (const char *id)
 [local interface] Remove a SDO service provider More...
 
bool addSdoServiceConsumer (const SDOPackage::ServiceProfile &prof)
 [local interface] Set a SDO service provider More...
 
bool removeSdoServiceConsumer (const char *id)
 [local interface] Remove a SDO service provider More...
 
void removeSdoServiceConsumerStartThread (const char *id)
 [local interface] Remove a SDO service provider More...
 
bool readAll ()
 Readout the value from All InPorts. More...
 
bool writeAll ()
 The write() method of all OutPort is called. More...
 
void setReadAll (bool read=true, bool completion=false)
 Set whether to execute the readAll() method. More...
 
void setWriteAll (bool write=true, bool completion=false)
 Set whether to execute the writeAll() method. More...
 
void finalizePorts ()
 Unregister All Ports. More...
 
void finalizeContexts ()
 The ExecutionContextBase list is deleted. More...
 
void addPreComponentActionListener (PreComponentActionListenerType listener_type, PreComponentActionListener *listener, bool autoclean=true)
 
template<class Listener >
PreComponentActionListeneraddPreComponentActionListener (PreCompActionListenerType listener_type, Listener &obj, void(Listener::*memfunc)(UniqueId ec_id))
 
void removePreComponentActionListener (PreComponentActionListenerType listener_type, PreComponentActionListener *listener)
 Removing PreComponentAction type listener. More...
 
void addPostComponentActionListener (PostComponentActionListenerType listener_type, PostComponentActionListener *listener, bool autoclean=true)
 
template<class Listener >
PostComponentActionListeneraddPostComponentActionListener (PostCompActionListenerType listener_type, Listener &obj, void(Listener::*memfunc)(UniqueId ec_id, ReturnCode_t ret))
 
void removePostComponentActionListener (PostComponentActionListenerType listener_type, PostComponentActionListener *listener)
 Removing PostComponentAction type listener. More...
 
void addPortActionListener (PortActionListenerType listener_type, PortActionListener *listener, bool autoclean=true)
 Adding PortAction type listener. More...
 
template<class Listener >
PortActionListeneraddPortActionListener (PortActionListenerType listener_type, Listener &obj, void(Listener::*memfunc)(const RTC::PortProfile &))
 
void removePortActionListener (PortActionListenerType listener_type, PortActionListener *listener)
 Removing PortAction type listener. More...
 
void addExecutionContextActionListener (ECActionListenerType listener_type, ECActionListener *listener, bool autoclean=true)
 
template<class Listener >
ECActionListeneraddExecutionContextActionListener (ECActionListenerType listener_type, Listener &obj, void(Listener::*memfunc)(UniqueId))
 
void removeExecutionContextActionListener (ECActionListenerType listener_type, ECActionListener *listener)
 Removing ExecutionContextAction type listener. More...
 
void addPortConnectListener (PortConnectListenerType listener_type, PortConnectListener *listener, bool autoclean=true)
 Adding PortConnect type listener. More...
 
template<class Listener >
PortConnectListeneraddPortConnectListener (PortConnectListenerType listener_type, Listener &obj, void(Listener::*memfunc)(const char *, ConnectorProfile &))
 
void removePortConnectListener (PortConnectListenerType listener_type, PortConnectListener *listener)
 Removing PortConnect type listener. More...
 
void addPortConnectRetListener (PortConnectRetListenerType listener_type, PortConnectRetListener *listener, bool autoclean=true)
 Adding PortConnectRet type listener. More...
 
template<class Listener >
PortConnectRetListeneraddPortConnectRetListener (PortConnectRetListenerType listener_type, Listener &obj, void(Listener::*memfunc)(const char *, ConnectorProfile &, ReturnCode_t))
 
void removePortConnectRetListener (PortConnectRetListenerType listener_type, PortConnectRetListener *listener)
 Removing PortConnectRet type listener. More...
 
void addConfigurationParamListener (ConfigurationParamListenerType type, ConfigurationParamListener *listener, bool autoclean=true)
 Adding ConfigurationParamListener. More...
 
template<class Listener >
ConfigurationParamListeneraddConfigurationParamListener (ConfigurationParamListenerType listener_type, Listener &obj, void(Listener::*memfunc)(const char *, const char *))
 
void removeConfigurationParamListener (ConfigurationParamListenerType type, ConfigurationParamListener *listener)
 Removing ConfigurationParamListener. More...
 
void addConfigurationSetListener (ConfigurationSetListenerType type, ConfigurationSetListener *listener, bool autoclean=true)
 Adding ConfigurationSetListener. More...
 
template<class Listener >
ConfigurationSetListeneraddConfigurationSetListener (ConfigurationSetListenerType listener_type, Listener &obj, void(Listener::*memfunc)(const coil::Properties &config_set))
 
void removeConfigurationSetListener (ConfigurationSetListenerType type, ConfigurationSetListener *listener)
 Removing ConfigurationSetListener. More...
 
void addConfigurationSetNameListener (ConfigurationSetNameListenerType type, ConfigurationSetNameListener *listener, bool autoclean=true)
 Adding ConfigurationSetNameListener. More...
 
template<class Listener >
ConfigurationSetNameListeneraddConfigurationSetNameListener (ConfigurationSetNameListenerType type, Listener &obj, void(Listener::*memfunc)(const char *))
 
void removeConfigurationSetNameListener (ConfigurationSetNameListenerType type, ConfigurationSetNameListener *listener)
 Removing ConfigurationSetNameListener. More...
 

Protected Attributes

std::vector< std::string > m_members
 Components. More...
 
OpenRTM::DataFlowComponent_var m_ref
 Reference of object. More...
 
SDOPackage::PeriodicECOrganizationm_org
 Reference of Organization. More...
 
- Protected Attributes inherited from RTC::RTObject_impl
Logger rtclog
 Logger stream. More...
 
Managerm_pManager
 Manager object. More...
 
CORBA::ORB_var m_pORB
 The pointer to the ORB. More...
 
PortableServer::POA_var m_pPOA
 The pointer to the POA. More...
 
SDOPackage::OrganizationList m_sdoOwnedOrganizations
 SDO owned organization list. More...
 
SDOPackage::Configuration_implm_pSdoConfigImpl
 The pointer to the SDO Configuration Object. More...
 
SDOPackage::Configuration_var m_pSdoConfig
 The pointer to the SDO Configuration Interface. More...
 
SDOPackage::OrganizationList m_sdoOrganizations
 SDO organization. More...
 
SDOPackage::NVList m_sdoStatus
 SDO Status. More...
 
ComponentProfile m_profile
 ComponentProfile. More...
 
RTObject_var m_objref
 Object reference. More...
 
PortAdmin m_portAdmin
 List of Port Object reference. More...
 
std::vector< InPortBase * > m_inports
 List of InPortBase*. More...
 
std::vector< OutPortBase * > m_outports
 List of OutPortBase*. More...
 
ExecutionContextServiceList m_ecMine
 List of owned ExecutionContextService. More...
 
std::vector< ExecutionContextBase * > m_eclist
 List of ExecutionContextBase. More...
 
ExecutionContextServiceList m_ecOther
 List of participating ExecutionContextService. More...
 
bool m_created
 Created Status Flag. More...
 
bool m_exiting
 RTC Finalize Status Flag. More...
 
coil::Properties m_properties
 Alive Status Flag. More...
 
ConfigAdmin m_configsets
 Configuration Administrator Object. More...
 
SdoServiceAdmin m_sdoservice
 SDO Service Administrator Object. More...
 
bool m_readAll
 flag for readAll() More...
 
bool m_writeAll
 flag for writeAll() More...
 
bool m_readAllCompletion
 flag for readAll() More...
 
bool m_writeAllCompletion
 flag for writeAll() More...
 
ComponentActionListeners m_actionListeners
 ComponentActionListener holder. More...
 
PortConnectListeners m_portconnListeners
 PortConnectListener holder. More...
 
SdoServiceConsumerTerminatorm_sdoconterm
 

Additional Inherited Members

- Public Types inherited from RTC::RTObject_impl
typedef PreComponentActionListener PreCompActionListener
 Adding PreComponentAction type listener. More...
 
typedef PreComponentActionListenerType PreCompActionListenerType
 
typedef PostComponentActionListener PostCompActionListener
 Adding PostComponentAction type listener. More...
 
typedef PostComponentActionListenerType PostCompActionListenerType
 
typedef ExecutionContextActionListenerType ECActionListenerType
 Adding ExecutionContextAction type listener. More...
 
typedef ExecutionContextActionListener ECActionListener
 
- Protected Member Functions inherited from RTC::RTObject_impl
virtual ReturnCode_t onStartup (RTC::UniqueId exec_handle)
 Callback function for startup action. More...
 
virtual ReturnCode_t onShutdown (RTC::UniqueId exec_handle)
 Callback function for shutdown action. More...
 
virtual ReturnCode_t onExecute (RTC::UniqueId exec_handle)
 Callback function to execute periodically. More...
 
virtual ReturnCode_t onAborting (RTC::UniqueId exec_handle)
 Callback function to abort. More...
 
virtual ReturnCode_t onError (RTC::UniqueId exec_handle)
 Callback function for error handling. More...
 
virtual ReturnCode_t onStateUpdate (RTC::UniqueId exec_handle)
 Callback function to update the state. More...
 
virtual ReturnCode_t onRateChanged (RTC::UniqueId exec_handle)
 Callback function to change execution cycle. More...
 
void shutdown ()
 Shutdown RTC. More...
 
void preOnInitialize (UniqueId ec_id)
 
void preOnFinalize (UniqueId ec_id)
 
void preOnStartup (UniqueId ec_id)
 
void preOnShutdown (UniqueId ec_id)
 
void preOnActivated (UniqueId ec_id)
 
void preOnDeactivated (UniqueId ec_id)
 
void preOnAborting (UniqueId ec_id)
 
void preOnError (UniqueId ec_id)
 
void preOnReset (UniqueId ec_id)
 
void preOnExecute (UniqueId ec_id)
 
void preOnStateUpdate (UniqueId ec_id)
 
void preOnRateChanged (UniqueId ec_id)
 
void postOnInitialize (UniqueId ec_id, ReturnCode_t ret)
 
void postOnFinalize (UniqueId ec_id, ReturnCode_t ret)
 
void postOnStartup (UniqueId ec_id, ReturnCode_t ret)
 
void postOnShutdown (UniqueId ec_id, ReturnCode_t ret)
 
void postOnActivated (UniqueId ec_id, ReturnCode_t ret)
 
void postOnDeactivated (UniqueId ec_id, ReturnCode_t ret)
 
void postOnAborting (UniqueId ec_id, ReturnCode_t ret)
 
void postOnError (UniqueId ec_id, ReturnCode_t ret)
 
void postOnReset (UniqueId ec_id, ReturnCode_t ret)
 
void postOnExecute (UniqueId ec_id, ReturnCode_t ret)
 
void postOnStateUpdate (UniqueId ec_id, ReturnCode_t ret)
 
void postOnRateChanged (UniqueId ec_id, ReturnCode_t ret)
 
void onAddPort (const PortProfile &pprof)
 
void onRemovePort (const PortProfile &pprof)
 
void onAttachExecutionContext (UniqueId ec_id)
 
void onDetachExecutionContext (UniqueId ec_id)
 
ReturnCode_t getInheritedECOptions (coil::Properties &default_opts)
 
ReturnCode_t getPrivateContextOptions (std::vector< coil::Properties > &ec_args)
 getting individual EC options from RTC's configuration file More...
 
ReturnCode_t getGlobalContextOptions (coil::Properties &global_ec_props)
 getting global EC options from rtc.conf More...
 
ReturnCode_t getContextOptions (std::vector< coil::Properties > &ec_args)
 getting EC options More...
 
ReturnCode_t findExistingEC (coil::Properties &ec_arg, RTC::ExecutionContextBase *&ec)
 fiding existing EC from the factory More...
 
ReturnCode_t createContexts (std::vector< coil::Properties > &ec_args)
 creating, initializing and binding context More...
 

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
managerManager object
virtual RTC::PeriodicECSharedComposite::~PeriodicECSharedComposite ( void  )
virtual

Destructor.

Destructor

Member Function Documentation

virtual ReturnCode_t RTC::PeriodicECSharedComposite::exit ( )
throw (CORBA::SystemException
)
virtual

[CORBA interface]top the RTC's execution context(s) and finalize it along with its contents.

Any execution contexts for which the RTC is the owner shall be stopped. If the RTC participates in any execution contexts belonging to another RTC that contains it, directly or indirectly (i.e. the containing RTC is the owner of the ExecutionContext), it shall be deactivated in those contexts. After the RTC is no longer Active in any Running execution context, it and any RTCs contained transitively within it shall be finalized.

Constraints

  • An RTC cannot be exited if it has not yet been initialized. Any attempt to exit an RTC that is in the Created state shall fail with ReturnCode_t::PRECONDITION_NOT_MET.
Returns
The return code of ReturnCode_t type

Reimplemented from RTC::RTObject_impl.

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

Reimplemented from RTC::RTObject_impl.

Member Data Documentation

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

Components.

SDOPackage::PeriodicECOrganization* RTC::PeriodicECSharedComposite::m_org
protected

Reference of Organization.

OpenRTM::DataFlowComponent_var RTC::PeriodicECSharedComposite::m_ref
protected

Reference of object.


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