Public Member Functions | |
| def | __init__ (self) |
| def | exit (self) |
| Stop the RTC's execution context(s) and finalize it along with its contents. More... | |
| def | finalize (self) |
| Finalize the RTC for preparing it for destruction. More... | |
| def | get_component_profile (self) |
| [RTObject CORBA interface] Get RTC's profile More... | |
| def | get_configuration (self) |
| [SDO interface] Getting Configuration object More... | |
| def | get_contexts (self) |
| def | get_device_profile (self) |
| [SDO interface] Getting SDO DeviceProfile More... | |
| def | get_execution_context_services (self) |
| def | get_monitoring (self) |
| [SDO interface] Get Monitoring object More... | |
| def | get_organizations (self) |
| [SDO interface] Getting Organizations More... | |
| def | get_owned_organizations (self) |
| [SDO interface] Getting Organizations More... | |
| def | get_ports (self) |
| [RTObject CORBA interface] Get Ports More... | |
| def | get_sdo_id (self) |
| [SDO interface] Getting SDO ID More... | |
| def | get_sdo_service (self) |
| def | get_sdo_type (self) |
| [SDO interface] Getting SDO type More... | |
| def | get_service_profile (self, id) |
| [SDO interface] Getting Organizations More... | |
| def | get_service_profiles (self) |
| [SDO interface] Getting SDO ServiceProfile More... | |
| def | get_status (self, name) |
| [SDO interface] Get SDO Status More... | |
| def | get_status_list (self) |
| [SDO interface] Get SDO Status More... | |
| def | getRef (self) |
| def | gotoError (self) |
| def | initialize (self) |
| Initialize the RTC that realizes this interface. More... | |
| def | is_alive (self) |
| def | on_aborting (self, id) |
| [ComponentAction CORBA interface] Transition Error State More... | |
| def | on_activated (self, id) |
| [ComponentAction CORBA interface] Activate RTC More... | |
| def | on_deactivated (self, id) |
| [ComponentAction CORBA interface] Deactivate RTC More... | |
| def | on_error (self, id) |
| [ComponentAction CORBA interface] Error Processing of RTC More... | |
| def | on_execute (self, id) |
| [DataFlowComponentAction CORBA interface] Primary Periodic Operation of RTC More... | |
| def | on_finalize (self) |
| [ComponentAction CORBA interface] Finalize RTC More... | |
| def | on_initialize (self) |
| [ComponentAction CORBA interface] Initialize RTC More... | |
| def | on_rate_changed (self, id) |
| [DataFlowComponentAction CORBA interface] Notify rate chenged More... | |
| def | on_reset (self, id) |
| [ComponentAction CORBA interface] Resetting RTC More... | |
| def | on_shutdown (self, id) |
| [ComponentAction CORBA interface] ShutDown RTC More... | |
| def | on_startup (self, id) |
| [ComponentAction CORBA interface] StartUp RTC More... | |
| def | on_state_update (self, id) |
| [DataFlowComponentAction CORBA interface] Secondary Periodic Operation of RTC More... | |
| def | set_execution_context_service (self, ec) |
 Public Member Functions inherited from OpenRTM_aist.RTObject.RTObject_impl | |
| def | __del__ (self) |
| destructor More... | |
| def | __init__ (self, manager=None, orb=None, poa=None) |
| Consructor. More... | |
| def | activate (self, ec_id) |
| [local interface] Make transition to Active state More... | |
| def | addConfigurationParamListener (self, type, memfunc, autoclean=True) |
| Adding ConfigurationParamListener. More... | |
| def | addConfigurationSetListener (self, listener_type, memfunc, autoclean=True) |
| Adding ConfigurationSetListener. More... | |
| def | addConfigurationSetNameListener (self, type, memfunc, autoclean=True) |
| Adding ConfigurationSetNameListener. More... | |
| def | addExecutionContextActionListener (self, listener_type, memfunc, autoclean=True) |
| Adding ExecutionContextAction type listener. More... | |
| def | addInPort (self, name, inport) |
| def | addOutPort (self, name, outport) |
| def | addPort (self, port) |
| def | addPortActionListener (self, listener_type, memfunc, autoclean=True) |
| Adding PortAction type listener. More... | |
| def | addPortConnectListener (self, listener_type, memfunc, autoclean=True) |
| Adding PortConnect type listener. More... | |
| def | addPortConnectRetListener (self, listener_type, memfunc, autoclean=True) |
| Adding PortConnectRet type listener. More... | |
| def | addPostComponentActionListener (self, listener_type, memfunc, autoclean=True) |
| Adding PostComponentAction type listener. More... | |
| def | addPreComponentActionListener (self, listener_type, memfunc, autoclean=True) |
| Adding PreComponentAction type listener. More... | |
| def | addSdoServiceConsumer (self, prof) |
| [local interface] Set a SDO service consumerbool addSdoServiceConsumer(const SDOPackage::ServiceProfile& prof); More... | |
| def | addSdoServiceProvider (self, prof, provider) |
| [local interface] Set a SDO service providerbool addSdoServiceProvider(const SDOPackage::ServiceProfile& prof, SdoServiceProviderBase* provider); More... | |
| def | attach_context (self, exec_context) |
| [CORBA interface] Attach ExecutionContext. More... | |
| def | bindContext (self, exec_context) |
| def | bindParameter (self, param_name, var, def_val, trans=None) |
| template <typename VarType> bool bindParameter(const char* param_name, VarType& var, const char* def_val, bool (trans)(VarType&, const char) = coil::stringTo) More... | |
| def | deactivate (self, ec_id) |
| [local interface] Make transition to Inactive state More... | |
| def | deletePort (self, port) |
| [local interface] Unregister Port More... | |
| def | deletePortByName (self, port_name) |
| def | detach_context (self, ec_id) |
| [CORBA interface] Attach ExecutionContext. More... | |
| def | finalizeContexts (self) |
| def | finalizePorts (self) |
| Unregister the All Portse. More... | |
| def | get_context (self, ec_id) |
| [CORBA interface] Get ExecutionContextList. More... | |
| def | get_context_handle (self, cxt) |
| def | get_owned_contexts (self) |
| [CORBA interface] Get ExecutionContextList. More... | |
| def | get_participating_contexts (self) |
| [CORBA interface] Get participating ExecutionContextList. More... | |
| def | get_sdo_service (self, _id) |
| [SDO interface] Getting specified SDO Service's reference More... | |
| def | getCategory (self) |
| const char* getCategory() More... | |
| def | getDescription (self) |
| const char* getDescription() More... | |
| def | getExecutionContext (self, ec_id) |
| [local interface] Getting current execution context More... | |
| def | getExecutionRate (self, ec_id) |
| [local interface] Getting current context' execution rate More... | |
| def | getInstanceName (self) |
| const char* getInstanceName() More... | |
| def | getNamingNames (self) |
| std::vector<std::string> getNamingNames(); More... | |
| def | getObjRef (self) |
| RTObject_ptr getObjRef() const;. More... | |
| def | getProperties (self) |
| [local interface] Get RTC property More... | |
| def | getTypeName (self) |
| const char* getTypeName() More... | |
| def | getVendor (self) |
| const char* getVendor() More... | |
| def | getVersion (self) |
| const char* getVersion() More... | |
| def | is_alive (self, exec_context) |
| Confirm whether RTC is an Alive state or NOT. More... | |
| def | isOwnExecutionContext (self, ec_id) |
| [local interface] Checking if the current context is own context More... | |
| def | onAborting (self, ec_id) |
| def | onActivated (self, ec_id) |
| def | onAddPort (self, pprof) |
| def | onAttachExecutionContext (self, ec_id) |
| def | onDeactivated (self, ec_id) |
| def | onDetachExecutionContext (self, ec_id) |
| def | onError (self, ec_id) |
| def | onExecute (self, ec_id) |
| def | onFinalize (self) |
| def | onInitialize (self) |
| def | onRateChanged (self, ec_id) |
| def | onRemovePort (self, pprof) |
| def | onReset (self, ec_id) |
| def | onShutdown (self, ec_id) |
| def | onStartup (self, ec_id) |
| def | onStateUpdate (self, ec_id) |
| def | postOnAborting (self, ec_id, ret) |
| def | postOnActivated (self, ec_id, ret) |
| def | postOnDeactivated (self, ec_id, ret) |
| def | postOnError (self, ec_id, ret) |
| def | postOnExecute (self, ec_id, ret) |
| def | postOnFinalize (self, ec_id, ret) |
| def | postOnInitialize (self, ec_id, ret) |
| def | postOnRateChanged (self, ec_id, ret) |
| def | postOnReset (self, ec_id, ret) |
| def | postOnShutdown (self, ec_id, ret) |
| def | postOnStartup (self, ec_id, ret) |
| def | postOnStateUpdate (self, ec_id, ret) |
| def | preOnAborting (self, ec_id) |
| def | preOnActivated (self, ec_id) |
| def | preOnDeactivated (self, ec_id) |
| def | preOnError (self, ec_id) |
| def | preOnExecute (self, ec_id) |
| def | preOnFinalize (self, ec_id) |
| def | preOnInitialize (self, ec_id) |
| def | preOnRateChanged (self, ec_id) |
| def | preOnReset (self, ec_id) |
| def | preOnShutdown (self, ec_id) |
| def | preOnStartup (self, ec_id) |
| def | preOnStateUpdate (self, ec_id) |
| def | readAll (self) |
| Readout the value from All InPorts. More... | |
| def | registerInPort (self, name, inport) |
| def | registerOutPort (self, name, outport) |
| void registerOutPort(const char* name, OutPortBase& outport); More... | |
| def | registerPort (self, port) |
| [local interface] Register Port More... | |
| def | removeConfigurationParamListener (self, type, listener) |
| Removing ConfigurationParamListener. More... | |
| def | removeConfigurationSetListener (self, type, listener) |
| Removing ConfigurationSetListener. More... | |
| def | removeConfigurationSetNameListener (self, type, listener) |
| Removing ConfigurationSetNameListener. More... | |
| def | removeExecutionContextActionListener (self, listener_type, listener) |
| Removing ExecutionContextAction type listener. More... | |
| def | removeInPort (self, port) |
| [local interface] Unregister InPort More... | |
| def | removeOutPort (self, port) |
| [local interface] Unregister OutPort More... | |
| def | removePort (self, port) |
| def | removePortActionListener (self, listener_type, listener) |
| Removing PortAction type listener. More... | |
| def | removePortConnectListener (self, listener_type, listener) |
| Removing PortConnect type listener. More... | |
| def | removePortConnectRetListener (self, listener_type, listener) |
| Removing PortConnectRet type listener. More... | |
| def | removePostComponentActionListener (self, listener_type, listener) |
| Removing PostComponentAction type listener. More... | |
| def | removePreComponentActionListener (self, listener_type, listener) |
| Removing PreComponentAction type listener. More... | |
| def | removeSdoServiceConsumer (self, id) |
| [local interface] Remove a SDO service consumerbool removeSdoServiceConsumer(const char* id); More... | |
| def | removeSdoServiceProvider (self, id) |
| [local interface] Remove a SDO service providerbool removeSdoServiceProvider(const char* id); More... | |
| def | reset (self, ec_id) |
| [local interface] Resetting and go to Inactive state More... | |
| def | setExecutionRate (self, ec_id, rate) |
| [local interface] Setting current context' execution rate More... | |
| def | setInstanceName (self, instance_name) |
| void setInstanceName(const char* instance_name); More... | |
| def | setObjRef (self, rtobj) |
| void setObjRef(const RTObject_ptr rtobj); More... | |
| def | setProperties (self, prop) |
| [local interface] Set RTC property More... | |
| def | setReadAll (self, read=True, completion=False) |
| Set whether to execute the readAll() method. More... | |
| def | setWriteAll (self, write=True, completion=False) |
| Set whether to execute the writeAll() method. More... | |
| def | shutdown (self) |
| def | updateParameters (self, config_set) |
| void updateParameters(const char* config_set); More... | |
| def | writeAll (self) |
| The write() method of all OutPort is called. More... | |
Private Attributes | |
| _eclist | |
| _error | |
| _orb | |
| _poa | |
| _ref | |
Detailed Description
Definition at line 32 of file test_PeriodicExecutionContext.py.
Constructor & Destructor Documentation
◆ __init__()
| def test_PeriodicExecutionContext.DFP.__init__ | ( | self | ) |
Definition at line 33 of file test_PeriodicExecutionContext.py.
Member Function Documentation
◆ exit()
| 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.
◆ finalize()
| 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.
◆ get_component_profile()
| 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.
◆ get_configuration()
| 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.
◆ get_contexts()
| def test_PeriodicExecutionContext.DFP.get_contexts | ( | self | ) |
Definition at line 59 of file test_PeriodicExecutionContext.py.
◆ get_device_profile()
| 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.
◆ get_execution_context_services()
| def test_PeriodicExecutionContext.DFP.get_execution_context_services | ( | self | ) |
Definition at line 72 of file test_PeriodicExecutionContext.py.
◆ get_monitoring()
| 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.
◆ get_organizations()
| 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.
◆ get_owned_organizations()
| 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.
◆ get_ports()
| 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.
◆ get_sdo_id()
| 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.
◆ get_sdo_service()
| def test_PeriodicExecutionContext.DFP.get_sdo_service | ( | self | ) |
Definition at line 144 of file test_PeriodicExecutionContext.py.
◆ get_sdo_type()
| 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.
◆ get_service_profile()
| 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.
◆ get_service_profiles()
| 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.
◆ get_status()
| 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.
◆ get_status_list()
| 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.
◆ getRef()
| def test_PeriodicExecutionContext.DFP.getRef | ( | self | ) |
Definition at line 41 of file test_PeriodicExecutionContext.py.
◆ gotoError()
| def test_PeriodicExecutionContext.DFP.gotoError | ( | self | ) |
Definition at line 44 of file test_PeriodicExecutionContext.py.
◆ initialize()
| 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.
◆ is_alive()
| def test_PeriodicExecutionContext.DFP.is_alive | ( | self | ) |
Definition at line 56 of file test_PeriodicExecutionContext.py.
◆ on_aborting()
| 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.
◆ on_activated()
| 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.
◆ on_deactivated()
| 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.
◆ on_error()
| 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.
◆ on_execute()
| 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.
◆ on_finalize()
| 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.
◆ on_initialize()
| 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.
◆ on_rate_changed()
| 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.
◆ on_reset()
| 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
- Returns
Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.
Definition at line 107 of file test_PeriodicExecutionContext.py.
◆ on_shutdown()
| def test_PeriodicExecutionContext.DFP.on_shutdown | ( | self, | |
| ec_id | |||
| ) |
[ComponentAction CORBA interface] ShutDown RTC
The given execution context, in which the RTC is participating, has transitioned from Running to Stopped.
- Parameters
-
ec_id
- Returns
Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.
Definition at line 87 of file test_PeriodicExecutionContext.py.
◆ on_startup()
| def test_PeriodicExecutionContext.DFP.on_startup | ( | self, | |
| ec_id | |||
| ) |
[ComponentAction CORBA interface] StartUp RTC
The given execution context, in which the RTC is participating, has transitioned from Stopped to Running.
- Parameters
-
ec_id
- Returns
Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.
Definition at line 83 of file test_PeriodicExecutionContext.py.
◆ on_state_update()
| def test_PeriodicExecutionContext.DFP.on_state_update | ( | self, | |
| ec_id | |||
| ) |
[DataFlowComponentAction CORBA interface] Secondary 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 second 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 118 of file test_PeriodicExecutionContext.py.
◆ set_execution_context_service()
| def test_PeriodicExecutionContext.DFP.set_execution_context_service | ( | self, | |
| ec | |||
| ) |
Definition at line 62 of file test_PeriodicExecutionContext.py.
Member Data Documentation
◆ _eclist
|
private |
Definition at line 39 of file test_PeriodicExecutionContext.py.
◆ _error
|
private |
Definition at line 37 of file test_PeriodicExecutionContext.py.
◆ _orb
|
private |
Definition at line 34 of file test_PeriodicExecutionContext.py.
◆ _poa
|
private |
Definition at line 35 of file test_PeriodicExecutionContext.py.
◆ _ref
|
private |
Definition at line 38 of file test_PeriodicExecutionContext.py.
The documentation for this class was generated from the following file: