Inheritance diagram for test_PeriodicExecutionContext.DFP:

Public Member Functions
def	__init__
def	exit
	Stop the RTC's execution context(s) and finalize it along with its contents.
def	finalize
	Finalize the RTC for preparing it for destruction.
def	get_component_profile
	[RTObject CORBA interface] Get RTC's profile
def	get_configuration
	[SDO interface] Getting Configuration object
def	get_contexts
def	get_device_profile
	[SDO interface] Getting SDO DeviceProfile
def	get_execution_context_services
def	get_monitoring
	[SDO interface] Get Monitoring object
def	get_organizations
	[SDO interface] Getting Organizations
def	get_owned_organizations
	[SDO interface] Getting Organizations
def	get_ports
	[RTObject CORBA interface] Get Ports
def	get_sdo_id
	[SDO interface] Getting SDO ID
def	get_sdo_service
def	get_sdo_type
	[SDO interface] Getting SDO type
def	get_service_profile
	[SDO interface] Getting Organizations
def	get_service_profiles
	[SDO interface] Getting SDO ServiceProfile
def	get_status
	[SDO interface] Get SDO Status
def	get_status_list
	[SDO interface] Get SDO Status
def	getRef
def	gotoError
def	initialize
	Initialize the RTC that realizes this interface.
def	is_alive
def	on_aborting
	[ComponentAction CORBA interface] Transition Error State
def	on_activated
	[ComponentAction CORBA interface] Activate RTC
def	on_deactivated
	[ComponentAction CORBA interface] Deactivate RTC
def	on_error
	[ComponentAction CORBA interface] Error Processing of RTC
def	on_execute
	[DataFlowComponentAction CORBA interface] Primary Periodic Operation of RTC
def	on_finalize
	[ComponentAction CORBA interface] Finalize RTC
def	on_initialize
	[ComponentAction CORBA interface] Initialize RTC
def	on_rate_changed
	[DataFlowComponentAction CORBA interface] Notify rate chenged
def	on_reset
	[ComponentAction CORBA interface] Resetting RTC
def	on_shutdown
	[ComponentAction CORBA interface] ShutDown RTC
def	on_startup
	[ComponentAction CORBA interface] StartUp RTC
def	on_state_update
	[DataFlowComponentAction CORBA interface] Secondary Periodic Operation of RTC
def	set_execution_context_service
Private Attributes
	_eclist
	_error
	_orb
	_poa
	_ref

Detailed Description

Definition at line 32 of file test_PeriodicExecutionContext.py.

Constructor & Destructor Documentation

def test_PeriodicExecutionContext.DFP.__init__ ( self )

Definition at line 33 of file test_PeriodicExecutionContext.py.

Member Function Documentation

def test_PeriodicExecutionContext.DFP.exit ( self )

Stop 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:

Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.

Definition at line 53 of file test_PeriodicExecutionContext.py.

def test_PeriodicExecutionContext.DFP.finalize ( self )

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 participating in any execution context. It must first be removed with ExecutionContextOperations::remove_component. Otherwise, this operation 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.

Returns:

Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.

Definition at line 50 of file test_PeriodicExecutionContext.py.

def test_PeriodicExecutionContext.DFP.get_component_profile ( self )

[RTObject CORBA interface] Get RTC's profile

This operation returns the ComponentProfile of the RTC

Returns:: ComponentProfile

virtual ComponentProfile* get_component_profile()

Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.

Definition at line 66 of file test_PeriodicExecutionContext.py.

def test_PeriodicExecutionContext.DFP.get_configuration ( self )

[SDO 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	if the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_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::Configuration_ptr get_configuration()

Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.

Definition at line 147 of file test_PeriodicExecutionContext.py.

def test_PeriodicExecutionContext.DFP.get_contexts ( self )

Definition at line 59 of file test_PeriodicExecutionContext.py.

def test_PeriodicExecutionContext.DFP.get_device_profile ( self )

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

Returns:: The DeviceProfile of the SDO.

Exceptions:

SDONotExists	if the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_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.

virtual SDOPackage::DeviceProfile* get_device_profile()

Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.

Definition at line 135 of file test_PeriodicExecutionContext.py.

def test_PeriodicExecutionContext.DFP.get_execution_context_services ( self )

Definition at line 72 of file test_PeriodicExecutionContext.py.

def test_PeriodicExecutionContext.DFP.get_monitoring ( self )

[SDO 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	if the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_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::Monitoring_ptr get_monitoring()

Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.

Definition at line 150 of file test_PeriodicExecutionContext.py.

def test_PeriodicExecutionContext.DFP.get_organizations ( self )

[SDO 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	if the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_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* get_organizations()

Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.

Definition at line 153 of file test_PeriodicExecutionContext.py.

def test_PeriodicExecutionContext.DFP.get_owned_organizations ( self )

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

Returns:: Owned Organization List

Exceptions:

SDONotExists	if the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_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.

virtual SDOPackage::OrganizationList* get_owned_organizations()

Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.

Definition at line 126 of file test_PeriodicExecutionContext.py.

def test_PeriodicExecutionContext.DFP.get_ports ( self )

[RTObject CORBA interface] Get Ports

This operation returns a list of the RTCs ports.

Returns:: PortList

virtual PortServiceList* get_ports()

Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.

Definition at line 69 of file test_PeriodicExecutionContext.py.

def test_PeriodicExecutionContext.DFP.get_sdo_id ( self )

[SDO interface] Getting SDO ID

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

Returns:: id of the SDO defined in the resource data model.

Exceptions:

SDONotExists	if the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_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.

virtual char* get_sdo_id()

Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.

Definition at line 129 of file test_PeriodicExecutionContext.py.

def test_PeriodicExecutionContext.DFP.get_sdo_service ( self )

Definition at line 144 of file test_PeriodicExecutionContext.py.

def test_PeriodicExecutionContext.DFP.get_sdo_type ( self )

[SDO interface] Getting SDO type

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

Returns:: Type of the SDO defined in the resource data model.

Exceptions:

SDONotExists	if the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_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.

virtual char* get_sdo_type()

Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.

Definition at line 132 of file test_PeriodicExecutionContext.py.

def test_PeriodicExecutionContext.DFP.get_service_profile	(	self,
		_id
	)

[SDO 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:

InvalidParameter	if the ServiceProfile that is specified by the argument 'id' does not exist or if 'id' is 'null.'
SDONotExists	if the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_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.

virtual SDOPackage::ServiceProfile* get_service_profile(const char* id)

Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.

Definition at line 141 of file test_PeriodicExecutionContext.py.

def test_PeriodicExecutionContext.DFP.get_service_profiles ( self )

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

Returns:: List of ServiceProfiles of all the services the SDO is providing.

Exceptions:

SDONotExists	if the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_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.

virtual SDOPackage::ServiceProfileList* get_service_profiles()

Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.

Definition at line 138 of file test_PeriodicExecutionContext.py.

def test_PeriodicExecutionContext.DFP.get_status	(	self,
		name
	)

[SDO 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	if the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_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 CORBA::Any* get_status(const char* name)

Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.

Definition at line 159 of file test_PeriodicExecutionContext.py.

def test_PeriodicExecutionContext.DFP.get_status_list ( self )

[SDO interface] Get SDO Status

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

Returns:: The actual status of an SDO.

Exceptions:

SDONotExists	if the target SDO does not exist.(This exception is mapped to CORBA standard system exception OBJECT_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::NVList* get_status_list()

Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.

Definition at line 156 of file test_PeriodicExecutionContext.py.

def test_PeriodicExecutionContext.DFP.getRef ( self )

Definition at line 41 of file test_PeriodicExecutionContext.py.

def test_PeriodicExecutionContext.DFP.gotoError ( self )

Definition at line 44 of file test_PeriodicExecutionContext.py.

def test_PeriodicExecutionContext.DFP.initialize ( self )

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.

Returns:

Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.

Definition at line 47 of file test_PeriodicExecutionContext.py.

def test_PeriodicExecutionContext.DFP.is_alive ( self )

Definition at line 56 of file test_PeriodicExecutionContext.py.

def test_PeriodicExecutionContext.DFP.on_aborting	(	self,
		ec_id
	)

[ComponentAction CORBA interface] Transition Error State

The RTC is transitioning from the Active state to the Error state in some execution context. This callback is invoked only a single time for time that the RTC transitions into the Error state from another state. This behavior is in contrast to that of on_error.

Parameters:

ec_id

Returns:

Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.

Definition at line 99 of file test_PeriodicExecutionContext.py.

def test_PeriodicExecutionContext.DFP.on_activated	(	self,
		ec_id
	)

[ComponentAction CORBA interface] Activate RTC

The RTC has been activated in the given execution context.

Parameters:

ec_id

Returns:

Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.

Definition at line 91 of file test_PeriodicExecutionContext.py.

def test_PeriodicExecutionContext.DFP.on_deactivated	(	self,
		ec_id
	)

[ComponentAction CORBA interface] Deactivate RTC

The RTC has been deactivated in the given execution context.

Parameters:

ec_id

Returns:

Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.

Definition at line 95 of file test_PeriodicExecutionContext.py.

def test_PeriodicExecutionContext.DFP.on_error	(	self,
		ec_id
	)

[ComponentAction CORBA interface] Error Processing of RTC

The RTC remains in the Error state. If the RTC is in the Error state relative to some execution context when it would otherwise be invoked from that context (according to the context��s ExecutionKind), this callback shall be invoked instead. For example,

If the ExecutionKind is PERIODIC, this operation shall be invoked in sorted order at the rate of the context instead of DataFlowComponentAction::on_execute and on_state_update.
If the ExecutionKind is EVENT_DRIVEN, this operation shall be invoked whenever FsmParticipantAction::on_action would otherwise have been invoked.

Parameters:

ec_id

Returns:

Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.

Definition at line 103 of file test_PeriodicExecutionContext.py.

def test_PeriodicExecutionContext.DFP.on_execute	(	self,
		ec_id
	)

[DataFlowComponentAction CORBA interface] Primary Periodic Operation of RTC

This operation will be invoked periodically at the rate of the given execution context as long as the following conditions hold:

The RTC is Active.
The given execution context is Running This callback occurs during the first execution pass.

Constraints

The execution context of the given context shall be PERIODIC.

Parameters:

ec_id

Returns:

Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.

Definition at line 111 of file test_PeriodicExecutionContext.py.

def test_PeriodicExecutionContext.DFP.on_finalize ( self )

[ComponentAction CORBA interface] Finalize RTC

The RTC is being destroyed. Any final RTC-specific tear-down logic should be performed here.

Returns:

Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.

Definition at line 79 of file test_PeriodicExecutionContext.py.

def test_PeriodicExecutionContext.DFP.on_initialize ( self )

[ComponentAction CORBA interface] Initialize RTC

The RTC has been initialized and entered the Alive state. Any RTC-specific initialization logic should be performed here.

Returns:

Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.

Definition at line 75 of file test_PeriodicExecutionContext.py.

def test_PeriodicExecutionContext.DFP.on_rate_changed	(	self,
		ec_id
	)

[DataFlowComponentAction CORBA interface] Notify rate chenged

This operation is a notification that the rate of the indicated execution context has changed.

Constraints

The execution context of the given context shall be PERIODIC.

Parameters:

ec_id

Returns:

Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.

Definition at line 122 of file test_PeriodicExecutionContext.py.

def test_PeriodicExecutionContext.DFP.on_reset	(	self,
		ec_id
	)

[ComponentAction CORBA interface] Resetting RTC

The RTC is in the Error state. An attempt is being made to recover it such that it can return to the Inactive state. If the RTC was successfully recovered and can safely return to the Inactive state, this method shall complete with ReturnCode_t::OK. Any other result shall indicate that the RTC should remain in the Error state.

Parameters:

ec_id