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

RTObject_impl Class Reference

List of all members.

Public Member Functions

 __del__ ()
 onInitialize ()
 onFinalize ()
 onStartup (ec_id)
 onShutdown (ec_id)
 onActivated (ec_id)
 onDeactivated (ec_id)
 onExecute (ec_id)
 onAborting (ec_id)
 onError (ec_id)
 onReset (ec_id)
 onStateUpdate (ec_id)
 onRateChanged (ec_id)
 initialize ()
 finalize ()
 Finalize the RTC for preparing it for destruction.
 exit ()
 Stop the RTC's and finalize it along with its contents.
 is_alive ()
 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.
 get_contexts ()
 [CORBA interface] Get ExecutionContextList.
 get_context (ec_id)
 [CORBA interface] Get ExecutionContext.
 get_component_profile ()
 [RTObject CORBA interface] Get RTC's profile
 get_ports ()
 [RTObject CORBA interface] Get Ports
 get_execution_context_services ()
 [RTObject CORBA interface] Get ExecutionContextAdmin
 attach_executioncontext (exec_context)
 detach_executioncontext (ec_id)
 on_initialize ()
 on_finalize ()
 on_startup (ec_id)
 on_shutdown (ec_id)
 on_activated (ec_id)
 on_deactivated (ec_id)
 on_aborting (ec_id)
 on_error (ec_id)
 on_reset (ec_id)
 on_execute (ec_id)
 on_state_update (ec_id)
 on_rate_changed (ec_id)
 get_owned_organizations ()
 [CORBA interface] Getting Organizations
 get_sdo_id ()
 [CORBA interface] Getting SDO ID
 get_sdo_type ()
 [CORBA interface] Getting SDO type
 get_device_profile ()
 [CORBA interface] Getting SDO DeviceProfile
 get_service_profiles ()
 [CORBA interface] Getting SDO ServiceProfile
 get_service_profile (_id)
 [CORBA interface] Getting Organizations
 get_sdo_service (_id)
 [CORBA interface] Getting specified SDO Service's reference
 get_configuration ()
 [CORBA interface] Getting Configuration object
 get_monitoring ()
 [CORBA interface] Get Monitoring object
 get_organizations ()
 [CORBA interface] Getting Organizations
 get_status_list ()
 [CORBA interface] Get SDO Status
 get_status (name)
 [CORBA interface] Get SDO Status
 getInstanceName ()
 setInstanceName (instance_name)
 getTypeName ()
 getDescription ()
 getVersion ()
 getVendor ()
 getCategory ()
 getNamingNames ()
 setObjRef (rtobj)
 getObjRef ()
 setProperties (prop)
 [local interface] Set RTC property
 getProperties ()
 [local interface] Get RTC property
 bindParameter (param_name, var, def_val, trans=None)
 var はリストを渡す必要がある。
 updateParameters (config_set)
 registerPort (port)
 [local interface] Register Port
 registerInPort (name, inport)
 registerOutPort (name, outport)
 deletePort (port)
 [local interface] Register Port
 deletePortByName (port_name)
 finalizePorts ()
 shutdown ()

Classes

class  deactivate_comps
class  ec_copy
class  nv_name
class  svc_name

Member Function Documentation

RTObject_impl::__del__  ) 
 

RTObject_impl::attach_executioncontext exec_context   ) 
 

RTObject_impl::bindParameter param_name  ,
var  ,
def_val  ,
trans  = None
 

var はリストを渡す必要がある。

Parameters:
param_name name of Parameter.
var object.
def_val stirng of parameter.

RTObject_impl::deletePort port   ) 
 

[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

RTObject_impl::deletePortByName port_name   ) 
 

RTObject_impl::detach_executioncontext ec_id   ) 
 

RTObject_impl::exit  ) 
 

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.

RTObject_impl::finalize  ) 
 

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.

RTObject_impl::finalizePorts  ) 
 

RTObject_impl::get_component_profile  ) 
 

[RTObject CORBA interface] Get RTC's profile

This operation returns the ComponentProfile of the RTC

RTObject_impl::get_configuration  ) 
 

[CORBA interface] Getting Configuration object

This operation returns an object implementing the Configuration interface. The Configuration interface is one of the interfaces thatreturn RTC.BAD_PARAMETER 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.

RTObject_impl::get_context ec_id   ) 
 

[CORBA interface] Get ExecutionContext.

RTObject_impl::get_contexts  ) 
 

[CORBA interface] Get ExecutionContextList.

RTObject_impl::get_device_profile  ) 
 

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

RTObject_impl::get_execution_context_services  ) 
 

[RTObject CORBA interface] Get ExecutionContextAdmin

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

RTObject_impl::get_monitoring  ) 
 

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

RTObject_impl::get_organizations  ) 
 

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

RTObject_impl::get_owned_organizations  ) 
 

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

RTObject_impl::get_ports  ) 
 

[RTObject CORBA interface] Get Ports

This operation returns a list of the RTCs ports.

RTObject_impl::get_sdo_id  ) 
 

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

RTObject_impl::get_sdo_service _id   ) 
 

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

RTObject_impl::get_sdo_type  ) 
 

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

RTObject_impl::get_service_profile _id   ) 
 

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

RTObject_impl::get_service_profiles  ) 
 

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

RTObject_impl::get_status name   ) 
 

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

RTObject_impl::get_status_list  ) 
 

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

RTObject_impl::getCategory  ) 
 

RTObject_impl::getDescription  ) 
 

RTObject_impl::getInstanceName  ) 
 

RTObject_impl::getNamingNames  ) 
 

RTObject_impl::getObjRef  ) 
 

RTObject_impl::getProperties  ) 
 

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

RTObject_impl::getTypeName  ) 
 

RTObject_impl::getVendor  ) 
 

RTObject_impl::getVersion  ) 
 

RTObject_impl::initialize  ) 
 

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.

RTObject_impl::is_alive  ) 
 

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.

RTObject_impl::on_aborting ec_id   ) 
 

RTObject_impl::on_activated ec_id   ) 
 

RTObject_impl::on_deactivated ec_id   ) 
 

RTObject_impl::on_error ec_id   ) 
 

RTObject_impl::on_execute ec_id   ) 
 

RTObject_impl::on_finalize  ) 
 

RTObject_impl::on_initialize  ) 
 

RTObject_impl::on_rate_changed ec_id   ) 
 

RTObject_impl::on_reset ec_id   ) 
 

RTObject_impl::on_shutdown ec_id   ) 
 

RTObject_impl::on_startup ec_id   ) 
 

RTObject_impl::on_state_update ec_id   ) 
 

RTObject_impl::onAborting ec_id   ) 
 

The aborting action when main logic error occurred. former rtc_aborting_entry()

RTObject_impl::onActivated ec_id   ) 
 

The activated action (Active state entry action) former rtc_active_entry()

RTObject_impl::onDeactivated ec_id   ) 
 

The deactivated action (Active state exit action) former rtc_active_exit()

RTObject_impl::onError ec_id   ) 
 

The error action in ERROR state former rtc_error_do()

RTObject_impl::onExecute ec_id   ) 
 

The execution action that is invoked periodically former rtc_active_do()

RTObject_impl::onFinalize  ) 
 

The finalize action (on ALIVE->END transition) formaer rtc_exiting_entry()

RTObject_impl::onInitialize  ) 
 

The initialize action (on CREATED->ALIVE transition) formaer rtc_init_entry()

RTObject_impl::onRateChanged ec_id   ) 
 

The action that is invoked when execution context's rate is changed no corresponding operation exists in OpenRTm-aist-0.2.0

RTObject_impl::onReset ec_id   ) 
 

The reset action that is invoked resetting This is same but different the former rtc_init_entry()

RTObject_impl::onShutdown ec_id   ) 
 

The shutdown action when ExecutionContext stop former rtc_stopping_entry()

RTObject_impl::onStartup ec_id   ) 
 

The startup action when ExecutionContext startup former rtc_starting_entry()

RTObject_impl::onStateUpdate ec_id   ) 
 

The state update action that is invoked after onExecute() action no corresponding operation exists in OpenRTm-aist-0.2.0

RTObject_impl::registerInPort name  ,
inport 
 

RTObject_impl::registerOutPort name  ,
outport 
 

RTObject_impl::registerPort port   ) 
 

[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

RTObject_impl::setInstanceName instance_name   ) 
 

RTObject_impl::setObjRef rtobj   ) 
 

RTObject_impl::setProperties prop   ) 
 

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

RTObject_impl::shutdown  ) 
 

RTObject_impl::updateParameters config_set   ) 
 


The documentation for this class was generated from the following file:
Generated on Mon Oct 29 15:51:44 2007 for OpenRTM by  doxygen 1.4.3