Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members

RTC::DataFlowBase Class Reference

#include <DataFlowBase.h>

Inheritance diagram for RTC::DataFlowBase:

RTC::RTObject_impl List of all members.

Public Types

typedef StateHolder< RTC::LifeCycleState > DFState
typedef StateMachine< RTC::LifeCycleState,
RTC::ReturnCode_t, DataFlowBase
DFPStateMachine

Public Member Functions

 DataFlowBase (Manager *manager)
virtual ~DataFlowBase ()
virtual ExecutionContextAdminList * get_execution_context_admins ()
 [RTObject CORBA interface] Get ExecutionContextAdmin
virtual ReturnCode_t initialize ()
virtual ReturnCode_t finalize ()
 Finalize the RTC for preparing it for destruction.
virtual ReturnCode_t reset (ExecutionContext_ptr exec_context)
 Attempt to recover the RTC when it is in Error.
virtual ReturnCode_t exit ()
 Stop the RTC's and finalize it along with its contents.
virtual CORBA::Boolean is_alive ()
virtual ReturnCode_t onInitialize ()
virtual ReturnCode_t onFinalize ()
virtual ReturnCode_t onStartup ()
virtual ReturnCode_t onShutdown ()
virtual ReturnCode_t onActivated ()
virtual ReturnCode_t onExecute ()
virtual ReturnCode_t onStateUpdate ()
virtual ReturnCode_t onRateChanged ()
virtual ReturnCode_t onDeactivated ()
virtual ReturnCode_t onAborting ()
virtual ReturnCode_t onError ()
virtual ReturnCode_t onReset ()
virtual ReturnCode_t on_initialize ()
virtual ReturnCode_t on_finalize ()
virtual ReturnCode_t on_startup (ExecutionContext_ptr exec_context)
virtual ReturnCode_t on_shutdown (ExecutionContext_ptr exec_context)
virtual ReturnCode_t on_activated (ExecutionContext_ptr exec_context)
virtual ReturnCode_t on_execute (ExecutionContext exec_context)
virtual ReturnCode_t on_state_update (ExecutionContext_ptr exec_context)
virtual ReturnCode_t on_rate_changed (ExecutionContext_ptr exec_context)
virtual ReturnCode_t on_deactivated (ExecutionContext_ptr exec_context)
virtual ReturnCode_t on_aborting (ExecutionContext_ptr exec_context)
virtual ReturnCode_t on_error (ExecutionContext_ptr exec_context)
virtual ReturnCode_t on_reset (ExecutionContext_ptr exec_context)
ReturnCode_t _on_initialize (const DFState &state)
ReturnCode_t _on_finalize (const DFState &state)
ReturnCode_t _on_startup (const DFState &state)
ReturnCode_t _on_shutdown (const DFState &state)
ReturnCode_t _on_activated (const DFState &state)
ReturnCode_t _on_execute (const DFState &state)
ReturnCode_t _on_state_update (const DFState &state)
ReturnCode_t _on_rate_changed (const DFState &state)
ReturnCode_t _on_deactivated (const DFState &state)
ReturnCode_t _on_aborting (const DFState &state)
ReturnCode_t _on_error (const DFState &state)
ReturnCode_t _on_reset (const DFState &state)
ReturnCode_t _null_func (const DFState &state)
virtual ComponentProfile * get_component_profile ()
 [RTObject CORBA interface] Get RTC's profile
virtual PortList * get_ports ()
 [RTObject CORBA interface] Get Ports
virtual ReturnCode_t reset ()
 Attempt to recover the RTC when it is in Error.
virtual ReturnCode_t on_startup (RTC::ExecutionContext_ptr exec_context)
virtual ReturnCode_t on_shutdown (RTC::ExecutionContext_ptr exec_context)
virtual ReturnCode_t on_activated (RTC::ExecutionContext_ptr exec_context)
virtual ReturnCode_t on_deactivated (RTC::ExecutionContext_ptr exec_context)
virtual ReturnCode_t on_aborting (RTC::ExecutionContext_ptr exec_context)
virtual ReturnCode_t on_error (RTC::ExecutionContext_ptr exec_context)
virtual ReturnCode_t on_reset (RTC::ExecutionContext_ptr exec_context)
virtual SDOPackage::OrganizationList * get_owned_organizations () throw (SDOPackage::NotAvailable)
 [CORBA interface] Getting Organizations
virtual char * get_sdo_id () throw (SDOPackage::NotAvailable, SDOPackage::InternalError)
 [CORBA interface] Getting SDO ID
virtual char * get_sdo_type () throw (SDOPackage::NotAvailable, SDOPackage::InternalError)
 [CORBA interface] Getting SDO type
virtual SDOPackage::DeviceProfile * get_device_profile () throw (SDOPackage::NotAvailable, SDOPackage::InternalError)
 [CORBA interface] Getting SDO DeviceProfile
virtual SDOPackage::ServiceProfileList * get_service_profiles () throw (SDOPackage::InvalidParameter, SDOPackage::NotAvailable, SDOPackage::InternalError)
 [CORBA interface] Getting SDO ServiceProfile
virtual SDOPackage::ServiceProfile * get_service_profile (const char *id) throw (SDOPackage::InvalidParameter, SDOPackage::NotAvailable, SDOPackage::InternalError)
 [CORBA interface] Getting Organizations
virtual SDOPackage::SDOService_ptr get_sdo_service (const char *id) throw (SDOPackage::InvalidParameter, SDOPackage::NotAvailable, SDOPackage::InternalError)
 [CORBA interface] Getting specified SDO Service's reference
virtual SDOPackage::Configuration_ptr get_configuration () throw (SDOPackage::InterfaceNotImplemented, SDOPackage::NotAvailable, SDOPackage::InternalError)
 [CORBA interface] Getting Configuration object
virtual SDOPackage::Monitoring_ptr get_monitoring () throw (SDOPackage::InterfaceNotImplemented, SDOPackage::NotAvailable, SDOPackage::InternalError)
 [CORBA interface] Get Monitoring object
virtual SDOPackage::OrganizationList * get_organizations () throw (SDOPackage::NotAvailable, SDOPackage::InternalError)
 [CORBA interface] Getting Organizations
virtual SDOPackage::NVList * get_status_list () throw (SDOPackage::NotAvailable, SDOPackage::InternalError)
 [CORBA interface] Get SDO Status
virtual CORBA::Any * get_status (const char *name) throw (SDOPackage::InvalidParameter, SDOPackage::NotAvailable, SDOPackage::InternalError)
 [CORBA interface] Get SDO Status
const char * getInstanceName ()
void setInstanceName (const char *instance_name)
const char * getTypeName ()
const char * getDescription ()
const char * getVersion ()
const char * getVendor ()
const char * getCategory ()
std::vector< std::string > getNamingNames ()
void setObjRef (const RTObject_ptr rtobj)
RTObject_ptr getObjRef () const
void setProperties (const Properties &prop)
 [local interface] Set RTC property
PropertiesgetProperties ()
 [local interface] Get RTC property
void registerPort (PortBase &port)
 [local interface] Register Port
void deletePort (PortBase &port)
 [local interface] Register Port
void deletePortByName (const char *port_name)
void finalizePorts ()

Public Attributes

DFPStateMachine m_stateMachine
PortableServer::POA_var m_pPOA
CORBA::ORB_var m_pORB

Protected Attributes

SDOPackage::OrganizationList m_sdoOwnedOrganizations
SDOPackage::ServiceProfileList m_sdoSvcProfiles
SDOPackage::Configuration_implm_pSdoConfigImpl
SDOPackage::Configuration_var m_pSdoConfig
SDOPackage::OrganizationList m_sdoOrganizations
SDOPackage::NVList m_sdoStatus
ComponentProfile m_profile
RTObject_ptr m_objref
PortAdmin m_portAdmin
ExecutionContextServiceList m_execContexts
bool m_alive
Properties m_properties

Member Typedef Documentation

typedef StateMachine<RTC::LifeCycleState, RTC::ReturnCode_t, DataFlowBase> RTC::DataFlowBase::DFPStateMachine
 

typedef StateHolder<RTC::LifeCycleState> RTC::DataFlowBase::DFState
 


Constructor & Destructor Documentation

RTC::DataFlowBase::DataFlowBase Manager manager  ) 
 

virtual RTC::DataFlowBase::~DataFlowBase  )  [inline, virtual]
 


Member Function Documentation

ReturnCode_t RTC::DataFlowBase::_null_func const DFState state  ) 
 

ReturnCode_t RTC::DataFlowBase::_on_aborting const DFState state  ) 
 

ReturnCode_t RTC::DataFlowBase::_on_activated const DFState state  ) 
 

ReturnCode_t RTC::DataFlowBase::_on_deactivated const DFState state  ) 
 

ReturnCode_t RTC::DataFlowBase::_on_error const DFState state  ) 
 

ReturnCode_t RTC::DataFlowBase::_on_execute const DFState state  ) 
 

ReturnCode_t RTC::DataFlowBase::_on_finalize const DFState state  ) 
 

ReturnCode_t RTC::DataFlowBase::_on_initialize const DFState state  ) 
 

ReturnCode_t RTC::DataFlowBase::_on_rate_changed const DFState state  ) 
 

ReturnCode_t RTC::DataFlowBase::_on_reset const DFState state  ) 
 

ReturnCode_t RTC::DataFlowBase::_on_shutdown const DFState state  ) 
 

ReturnCode_t RTC::DataFlowBase::_on_startup const DFState state  ) 
 

ReturnCode_t RTC::DataFlowBase::_on_state_update const DFState state  ) 
 

void RTC::RTObject_impl::deletePort PortBase port  )  [inherited]
 

[local interface] Register Port

This operation registers a Port to be held by this RTC. In order to enable access to the Port from outside of RTC, the Port must be registered by this operation. The Port that is registered by this operation would be identified by PortProfile.name in the inside of RTC. Therefore, the Port should have unique PortProfile.name in the RTC. The registering Port would be activated properly, and the reference and the object reference would be stored in lists in RTC.

Parameters:
port Port which is registered in the RTC

void RTC::RTObject_impl::deletePortByName const char *  port_name  )  [inherited]
 

virtual ReturnCode_t RTC::DataFlowBase::exit  )  [virtual]
 

Stop the RTC'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.

Reimplemented from RTC::RTObject_impl.

virtual ReturnCode_t RTC::DataFlowBase::finalize  )  [virtual]
 

Finalize the RTC for preparing it for destruction.

This invocation of this operation shall result in the invocation of the callback ComponentAction::on_finalize.

Constraints

  • An RTC may not be finalized while it is Active in any Running execution context. Any attempt to invoke this operation at such a time shall fail with ReturnCode_t::PRECONDITION_NOT_MET.
  • An RTC may not be finalized while it is in the Created state. Any attempt to invoke this operation while in that state shall fail with ReturnCode_t::PRECONDITION_NOT_MET.
  • Application developers are not expected to call this operation directly; it exists for use by the RTC infrastructure.

Reimplemented from RTC::RTObject_impl.

void RTC::RTObject_impl::finalizePorts  )  [inherited]
 

virtual ComponentProfile* RTC::RTObject_impl::get_component_profile  )  [virtual, inherited]
 

[RTObject CORBA interface] Get RTC's profile

This operation returns the ComponentProfile of the RTC

virtual SDOPackage::Configuration_ptr RTC::RTObject_impl::get_configuration  )  throw (SDOPackage::InterfaceNotImplemented, SDOPackage::NotAvailable, SDOPackage::InternalError) [virtual, inherited]
 

[CORBA interface] Getting Configuration object

This operation returns an object implementing the Configuration interface. The Configuration interface is one of the interfaces that each SDO maintains. The interface is used to configure the attributes defined in DeviceProfile, ServiceProfile, and Organization. See OMG SDO specification Section 2.3.5, "Configuration Interface," on page 2-24 for more details about the Configuration interface.

Returns:
The Configuration interface of an SDO.
Exceptions:
InterfaceNotImplemented The target SDO has no Configuration interface.
SDONotExists The target SDO does not exist.
NotAvailable The target SDO is reachable but cannot respond.
InternalError The target SDO cannot execute the operation completely due to some internal error.

virtual SDOPackage::DeviceProfile* RTC::RTObject_impl::get_device_profile  )  throw (SDOPackage::NotAvailable, SDOPackage::InternalError) [virtual, inherited]
 

[CORBA interface] Getting SDO DeviceProfile

This operation returns the DeviceProfile of the SDO. If the SDO does not represent any hardware device, then a DeviceProfile with empty values are returned. This operation throws SDOException with one of the following types.

Exceptions:
NotAvailable if the target SDO is reachable but cannot respond.
InternalError if the target SDO cannot execute the operation completely due to some internal error.
Returns:
The DeviceProfile of the SDO.

virtual ExecutionContextAdminList* RTC::DataFlowBase::get_execution_context_admins  )  [virtual]
 

[RTObject CORBA interface] Get ExecutionContextAdmin

This operation returns a list containing an ExecutionContextAdmin for every ExecutionContext owned by the RTC.

Reimplemented from RTC::RTObject_impl.

virtual SDOPackage::Monitoring_ptr RTC::RTObject_impl::get_monitoring  )  throw (SDOPackage::InterfaceNotImplemented, SDOPackage::NotAvailable, SDOPackage::InternalError) [virtual, inherited]
 

[CORBA interface] Get Monitoring object

This operation returns an object implementing the Monitoring interface. The Monitoring interface is one of the interfaces that each SDO maintains. The interface is used to monitor the properties of an SDO. See OMG SDO specification Section 2.3.7, "Monitoring Interface," on page 2-35 for more details about the Monitoring interface.

Returns:
The Monitoring interface of an SDO.
Exceptions:
InterfaceNotImplemented The target SDO has no Configuration interface.
SDONotExists The target SDO does not exist.
NotAvailable The target SDO is reachable but cannot respond.
InternalError The target SDO cannot execute the operation completely due to some internal error.

virtual SDOPackage::OrganizationList* RTC::RTObject_impl::get_organizations  )  throw (SDOPackage::NotAvailable, SDOPackage::InternalError) [virtual, inherited]
 

[CORBA interface] Getting Organizations

An SDO belongs to zero or more organizations. If the SDO belongs to one or more organizations, this operation returns the list of organizations that the SDO belongs to. An empty list is returned if the SDO does not belong to any Organizations.

Returns:
The list of Organizations that the SDO belong to.
Exceptions:
SDONotExists The target SDO does not exist.
NotAvailable The target SDO is reachable but cannot respond.
InternalError The target SDO cannot execute the operation completely due to some internal error.

virtual SDOPackage::OrganizationList* RTC::RTObject_impl::get_owned_organizations  )  throw (SDOPackage::NotAvailable) [virtual, inherited]
 

[CORBA interface] Getting Organizations

SDOSystemElement can be the owner of zero or more organizations. If the SDOSystemElement owns one or more Organizations, this operation returns the list of Organizations that the SDOSystemElement owns. If it does not own any Organization, it returns empty list.

virtual PortList* RTC::RTObject_impl::get_ports  )  [virtual, inherited]
 

[RTObject CORBA interface] Get Ports

This operation returns a list of the RTCs ports.

virtual char* RTC::RTObject_impl::get_sdo_id  )  throw (SDOPackage::NotAvailable, SDOPackage::InternalError) [virtual, inherited]
 

[CORBA interface] Getting SDO ID

This operation returns id of the SDO. This operation throws SDOException with one of the following types.

Exceptions:
SDONotExists if the target SDO does not exist.
NotAvailable if the target SDO is reachable but cannot respond.
InternalError if the target SDO cannot execute the operation completely due to some internal error.
Returns:
id of the SDO defined in the resource data model.

virtual SDOPackage::SDOService_ptr RTC::RTObject_impl::get_sdo_service const char *  id  )  throw (SDOPackage::InvalidParameter, SDOPackage::NotAvailable, SDOPackage::InternalError) [virtual, inherited]
 

[CORBA interface] Getting specified SDO Service's reference

This operation returns an object implementing an SDO's service that is identified by the identifier specified as an argument. Different services provided by an SDO are distinguished with different identifiers. See OMG SDO specification Section 2.2.8, "ServiceProfile," on page 2-12 for more details.

Parameters:
id The identifier referring to one of the SDO Service
Returns:
The object implementing the requested service.

virtual char* RTC::RTObject_impl::get_sdo_type  )  throw (SDOPackage::NotAvailable, SDOPackage::InternalError) [virtual, inherited]
 

[CORBA interface] Getting SDO type

This operation returns sdoType of the SDO. This operation throws SDOException with one of the following types.

Exceptions:
SDONotExists if the target SDO does not exist.
NotAvailable if the target SDO is reachable but cannot respond.
InternalError if the target SDO cannot execute the operation completely due to some internal error.
Returns:
Type of the SDO defined in the resource data model.

virtual SDOPackage::ServiceProfile* RTC::RTObject_impl::get_service_profile const char *  id  )  throw (SDOPackage::InvalidParameter, SDOPackage::NotAvailable, SDOPackage::InternalError) [virtual, inherited]
 

[CORBA interface] Getting Organizations

This operation returns the ServiceProfile that is specified by the argument "id."

Parameters:
id The identifier referring to one of the ServiceProfiles.
Returns:
The profile of the specified service.
Exceptions:
NotAvailable If the target SDO is reachable but cannot respond.
InternalError If the target SDO cannot execute the operation completely due to some internal error.

virtual SDOPackage::ServiceProfileList* RTC::RTObject_impl::get_service_profiles  )  throw (SDOPackage::InvalidParameter, SDOPackage::NotAvailable, SDOPackage::InternalError) [virtual, inherited]
 

[CORBA interface] Getting SDO ServiceProfile

This operation returns a list of ServiceProfiles that the SDO has. If the SDO does not provide any service, then an empty list is returned. This operation throws SDOException with one of the following types.

Exceptions:
NotAvailable if the target SDO is reachable but cannot respond.
InternalError if the target SDO cannot execute the operation completely due to some internal error.
Returns:
List of ServiceProfiles of all the services the SDO is providing.

virtual CORBA::Any* RTC::RTObject_impl::get_status const char *  name  )  throw (SDOPackage::InvalidParameter, SDOPackage::NotAvailable, SDOPackage::InternalError) [virtual, inherited]
 

[CORBA interface] Get SDO Status

Parameters:
name One of the parameters defining the "status" of an SDO.
Returns:
The value of the specified status parameter.
Exceptions:
SDONotExists The target SDO does not exist.
NotAvailable The target SDO is reachable but cannot respond.
InvalidParameter The parameter defined by "name" is null or does not exist.
InternalError The target SDO cannot execute the operation completely due to some internal error.

virtual SDOPackage::NVList* RTC::RTObject_impl::get_status_list  )  throw (SDOPackage::NotAvailable, SDOPackage::InternalError) [virtual, inherited]
 

[CORBA interface] Get SDO Status

This operation returns an NVlist describing the status of an SDO.

Returns:
The actual status of an SDO.
Exceptions:
SDONotExists The target SDO does not exist.
NotAvailable The target SDO is reachable but cannot respond.
InternalError The target SDO cannot execute the operation completely due to some internal error.

const char* RTC::RTObject_impl::getCategory  )  [inline, inherited]
 

const char* RTC::RTObject_impl::getDescription  )  [inline, inherited]
 

const char* RTC::RTObject_impl::getInstanceName  )  [inline, inherited]
 

std::vector<std::string> RTC::RTObject_impl::getNamingNames  )  [inherited]
 

RTObject_ptr RTC::RTObject_impl::getObjRef  )  const [inherited]
 

Properties& RTC::RTObject_impl::getProperties  )  [inherited]
 

[local interface] Get RTC property

This operation returns the properties of the RTC. Empty property would be returned, if RTC has no property.

Returns:
Property for RTC.

const char* RTC::RTObject_impl::getTypeName  )  [inline, inherited]
 

const char* RTC::RTObject_impl::getVendor  )  [inline, inherited]
 

const char* RTC::RTObject_impl::getVersion  )  [inline, inherited]
 

virtual ReturnCode_t RTC::DataFlowBase::initialize  )  [virtual]
 

Initialize the RTC that realizes this interface.

The invocation of this operation shall result in the invocation of the callback ComponentAction::on_initialize.

Constraints

  • An RTC may be initialized only while it is in the Created state. Any attempt to invoke this operation while in another state shall fail with ReturnCode_t::PRECONDITION_NOT_MET.
  • Application developers are not expected to call this operation directly; it exists for use by the RTC infrastructure.

Reimplemented from RTC::RTObject_impl.

virtual CORBA::Boolean RTC::DataFlowBase::is_alive  )  [virtual]
 

A component is alive or not regardless of the execution context from which it is observed. However, whether or not it is Active, Inactive, or in Error is dependent on the execution context(s) in which it is running. That is, it may be Active in one context but Inactive in another. Therefore, this operation shall report whether this RTC is either Active, Inactive or in Error; which of those states a component is in with respect to a particular context may be queried from the context itself.

Reimplemented from RTC::RTObject_impl.

virtual ReturnCode_t RTC::RTObject_impl::on_aborting RTC::ExecutionContext_ptr  exec_context  )  [virtual, inherited]
 

virtual ReturnCode_t RTC::DataFlowBase::on_aborting ExecutionContext_ptr  exec_context  )  [virtual]
 

virtual ReturnCode_t RTC::RTObject_impl::on_activated RTC::ExecutionContext_ptr  exec_context  )  [virtual, inherited]
 

virtual ReturnCode_t RTC::DataFlowBase::on_activated ExecutionContext_ptr  exec_context  )  [virtual]
 

virtual ReturnCode_t RTC::RTObject_impl::on_deactivated RTC::ExecutionContext_ptr  exec_context  )  [virtual, inherited]
 

virtual ReturnCode_t RTC::DataFlowBase::on_deactivated ExecutionContext_ptr  exec_context  )  [virtual]
 

virtual ReturnCode_t RTC::RTObject_impl::on_error RTC::ExecutionContext_ptr  exec_context  )  [virtual, inherited]
 

virtual ReturnCode_t RTC::DataFlowBase::on_error ExecutionContext_ptr  exec_context  )  [virtual]
 

virtual ReturnCode_t RTC::DataFlowBase::on_execute ExecutionContext  exec_context  )  [virtual]
 

virtual ReturnCode_t RTC::DataFlowBase::on_finalize  )  [virtual]
 

Reimplemented from RTC::RTObject_impl.

virtual ReturnCode_t RTC::DataFlowBase::on_initialize  )  [virtual]
 

Reimplemented from RTC::RTObject_impl.

virtual ReturnCode_t RTC::DataFlowBase::on_rate_changed ExecutionContext_ptr  exec_context  )  [virtual]
 

virtual ReturnCode_t RTC::RTObject_impl::on_reset RTC::ExecutionContext_ptr  exec_context  )  [virtual, inherited]
 

virtual ReturnCode_t RTC::DataFlowBase::on_reset ExecutionContext_ptr  exec_context  )  [virtual]
 

virtual ReturnCode_t RTC::RTObject_impl::on_shutdown RTC::ExecutionContext_ptr  exec_context  )  [virtual, inherited]
 

virtual ReturnCode_t RTC::DataFlowBase::on_shutdown ExecutionContext_ptr  exec_context  )  [virtual]
 

virtual ReturnCode_t RTC::RTObject_impl::on_startup RTC::ExecutionContext_ptr  exec_context  )  [virtual, inherited]
 

virtual ReturnCode_t RTC::DataFlowBase::on_startup ExecutionContext_ptr  exec_context  )  [virtual]
 

virtual ReturnCode_t RTC::DataFlowBase::on_state_update ExecutionContext_ptr  exec_context  )  [virtual]
 

virtual ReturnCode_t RTC::DataFlowBase::onAborting  )  [virtual]
 

virtual ReturnCode_t RTC::DataFlowBase::onActivated  )  [virtual]
 

virtual ReturnCode_t RTC::DataFlowBase::onDeactivated  )  [virtual]
 

virtual ReturnCode_t RTC::DataFlowBase::onError  )  [virtual]
 

virtual ReturnCode_t RTC::DataFlowBase::onExecute  )  [virtual]
 

virtual ReturnCode_t RTC::DataFlowBase::onFinalize  )  [virtual]
 

virtual ReturnCode_t RTC::DataFlowBase::onInitialize  )  [virtual]
 

virtual ReturnCode_t RTC::DataFlowBase::onRateChanged  )  [virtual]
 

virtual ReturnCode_t RTC::DataFlowBase::onReset  )  [virtual]
 

virtual ReturnCode_t RTC::DataFlowBase::onShutdown  )  [virtual]
 

virtual ReturnCode_t RTC::DataFlowBase::onStartup  )  [virtual]
 

virtual ReturnCode_t RTC::DataFlowBase::onStateUpdate  )  [virtual]
 

void RTC::RTObject_impl::registerPort PortBase port  )  [inherited]
 

[local interface] Register Port

This operation registers a Port to be held by this RTC. In order to enable access to the Port from outside of RTC, the Port must be registered by this operation. The Port that is registered by this operation would be identified by PortProfile.name in the inside of RTC. Therefore, the Port should have unique PortProfile.name in the RTC. The registering Port would be activated properly, and the reference and the object reference would be stored in lists in RTC.

Parameters:
port Port which is registered in the RTC

virtual ReturnCode_t RTC::RTObject_impl::reset  )  [virtual, inherited]
 

Attempt to recover the RTC when it is in Error.

The ComponentAction::on_reset callback shall be invoked. If possible, the RTC developer should implement that callback such that the RTC may be returned to a valid state. If this operation fails, the RTC will remain in Error.

Constraints

  • An RTC may only be reset in an execution context in which it is in error. If the RTC is not in Error in the identified context, this operation shall fail with ReturnCode_t::PRECONDITION_NOT_MET. However, that failure shall not cause the RTC to enter the Error state.
  • An RTC may not be reset while in the Created state. Any attempt to invoke this operation while the RTC is in that state shall fail with ReturnCode_t::PRECONDITION_NOT_MET. However, that failure shall not cause the RTC to enter the Error state.

virtual ReturnCode_t RTC::DataFlowBase::reset ExecutionContext_ptr  exec_context  )  [virtual]
 

Attempt to recover the RTC when it is in Error.

The ComponentAction::on_reset callback shall be invoked. If possible, the RTC developer should implement that callback such that the RTC may be returned to a valid state. If this operation fails, the RTC will remain in Error.

Constraints

  • An RTC may only be reset in an execution context in which it is in error. If the RTC is not in Error in the identified context, this operation shall fail with ReturnCode_t::PRECONDITION_NOT_MET. However, that failure shall not cause the RTC to enter the Error state.
  • An RTC may not be reset while in the Created state. Any attempt to invoke this operation while the RTC is in that state shall fail with ReturnCode_t::PRECONDITION_NOT_MET. However, that failure shall not cause the RTC to enter the Error state.

void RTC::RTObject_impl::setInstanceName const char *  instance_name  )  [inherited]
 

void RTC::RTObject_impl::setObjRef const RTObject_ptr  rtobj  )  [inherited]
 

void RTC::RTObject_impl::setProperties const Properties prop  )  [inherited]
 

[local interface] Set RTC property

This operation sets the properties to the RTC. The given property values should include information for ComponentProfile. Generally, this operation is designed to be called from Manager, when RTC is initialized

Parameters:
prop Property for RTC.


Member Data Documentation

bool RTC::RTObject_impl::m_alive [protected, inherited]
 

ExecutionContextServiceList RTC::RTObject_impl::m_execContexts [protected, inherited]
 

RTObject_ptr RTC::RTObject_impl::m_objref [protected, inherited]
 

CORBA::ORB_var RTC::DataFlowBase::m_pORB
 

PortAdmin RTC::RTObject_impl::m_portAdmin [protected, inherited]
 

Port のオブジェクトリファレンスのリスト

PortableServer::POA_var RTC::DataFlowBase::m_pPOA
 

ComponentProfile RTC::RTObject_impl::m_profile [protected, inherited]
 

RTC::ComponentProfile

Properties RTC::RTObject_impl::m_properties [protected, inherited]
 

RTC のプロパティ

SDOPackage::Configuration_var RTC::RTObject_impl::m_pSdoConfig [protected, inherited]
 

SDOPackage::Configuration_impl* RTC::RTObject_impl::m_pSdoConfigImpl [protected, inherited]
 

SDO Configuratio Interface へのポインタ

SDOPackage::OrganizationList RTC::RTObject_impl::m_sdoOrganizations [protected, inherited]
 

SDO organization

SDOPackage::OrganizationList RTC::RTObject_impl::m_sdoOwnedOrganizations [protected, inherited]
 

SDO owned organization list

SDOPackage::NVList RTC::RTObject_impl::m_sdoStatus [protected, inherited]
 

SDO Status

SDOPackage::ServiceProfileList RTC::RTObject_impl::m_sdoSvcProfiles [protected, inherited]
 

SDOService のプロファイルリスト

DFPStateMachine RTC::DataFlowBase::m_stateMachine
 


The documentation for this class was generated from the following file:
Generated on Fri Jan 5 15:43:08 2007 for OpenRTM by  doxygen 1.4.1