Inheritance diagram for OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite:
Public Member Functions | |
| def | __init__ (self, manager) |
| def | __del__ (self) |
| def | shutdown (self) |
| def | onInitialize (self) |
| def | onActivated (self, exec_handle) |
| def | activateChildComp (self, rtobj) |
| def | onDeactivated (self, exec_handle) |
| def | deactivateChildComp (self, rtobj) |
| def | onReset (self, exec_handle) |
| def | resetChildComp (self, rtobj) |
| def | onFinalize (self) |
 Public Member Functions inherited from OpenRTM_aist.DataFlowComponentBase.DataFlowComponentBase | |
| def | __init__ (self, manager=None, orb=None, poa=None) |
| def | init (self) |
| def | on_execute (self, ec_id) |
| def | on_state_update (self, ec_id) |
| def | on_rate_changed (self, ec_id) |
| Public Member Functions inherited from OpenRTM_aist.RTObject.RTObject_impl | |
| def | __init__ (self, manager=None, orb=None, poa=None) |
| def | __del__ (self) |
| def | onInitialize (self) |
| def | onFinalize (self) |
| def | onStartup (self, ec_id) |
| def | onShutdown (self, ec_id) |
| def | onActivated (self, ec_id) |
| def | onDeactivated (self, ec_id) |
| def | onExecute (self, ec_id) |
| def | onAborting (self, ec_id) |
| def | onError (self, ec_id) |
| def | onReset (self, ec_id) |
| def | onStateUpdate (self, ec_id) |
| def | onRateChanged (self, ec_id) |
| def | onAction (self, ec_id) |
| def | initialize (self) |
| def | finalize (self) |
| def | exit (self) |
| def | is_alive (self, exec_context) |
| def | get_context (self, ec_id) |
| def | get_owned_contexts (self) |
| def | get_participating_contexts (self) |
| def | get_component_profile (self) |
| def | get_ports (self) |
| def | attach_context (self, exec_context) |
| def | detach_context (self, ec_id) |
| def | on_initialize (self) |
| def | on_finalize (self) |
| def | on_startup (self, ec_id) |
| def | on_shutdown (self, ec_id) |
| def | on_activated (self, ec_id) |
| def | on_deactivated (self, ec_id) |
| def | on_aborting (self, ec_id) |
| def | on_error (self, ec_id) |
| def | on_reset (self, ec_id) |
| def | get_owned_organizations (self) |
| def | get_sdo_id (self) |
| def | get_sdo_type (self) |
| def | get_device_profile (self) |
| def | get_service_profiles (self) |
| def | get_service_profile (self, _id) |
| def | get_sdo_service (self, _id) |
| def | get_configuration (self) |
| def | get_monitoring (self) |
| def | get_organizations (self) |
| def | get_status_list (self) |
| def | get_status (self, name) |
| def | getInstanceName (self) |
| const char* getInstanceName() | |
| def | setInstanceName (self, instance_name) |
| void setInstanceName(const char* instance_name); | |
| def | getTypeName (self) |
| const char* getTypeName() | |
| def | getDescription (self) |
| const char* getDescription() | |
| def | getVersion (self) |
| const char* getVersion() | |
| def | getVendor (self) |
| const char* getVendor() | |
| def | getCategory (self) |
| const char* getCategory() | |
| def | getNamingNames (self) |
| std::vector<std::string> getNamingNames(); | |
| def | setObjRef (self, rtobj) |
| void setObjRef(const RTObject_ptr rtobj); | |
| def | getObjRef (self) |
| RTObject_ptr getObjRef() const; | |
| def | setProperties (self, prop) |
| def | getProperties (self) |
| 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) | |
| def | getConfigService (self) |
| def | updateParameters (self, config_set) |
| void updateParameters(const char* config_set); | |
| def | registerPort (self, port) |
| def | registerInPort (self, name, inport) |
| def | registerOutPort (self, name, outport) |
| void registerOutPort(const char* name, OutPortBase& outport); | |
| def | removeInPort (self, port) |
| def | removeOutPort (self, port) |
| def | deletePort (self, port) |
| def | deletePortByName (self, port_name) |
| def | getExecutionContext (self, ec_id) |
| def | getExecutionRate (self, ec_id) |
| def | setExecutionRate (self, ec_id, rate) |
| def | isOwnExecutionContext (self, ec_id) |
| def | deactivate (self, ec_id) |
| def | activate (self, ec_id) |
| def | reset (self, ec_id) |
| def | addSdoServiceProvider (self, prof, provider) |
| def | removeSdoServiceProvider (self, id) |
| def | addSdoServiceConsumer (self, prof) |
| def | removeSdoServiceConsumer (self, id) |
| def | removeSdoServiceConsumerStartThread (self, id) |
| def | readAll (self) |
| def | writeAll (self) |
| def | setReadAll (self, read=True, completion=False) |
| def | setWriteAll (self, write=True, completion=False) |
| def | finalizePorts (self) |
| def | addPreComponentActionListener (self, listener_type, memfunc) |
| def | removePreComponentActionListener (self, listener_type, listener) |
| def | addPostComponentActionListener (self, listener_type, memfunc) |
| def | removePostComponentActionListener (self, listener_type, listener) |
| def | addPortActionListener (self, listener_type, memfunc) |
| def | removePortActionListener (self, listener_type, listener) |
| def | addExecutionContextActionListener (self, listener_type, memfunc) |
| def | removeExecutionContextActionListener (self, listener_type, listener) |
| def | addPortConnectListener (self, listener_type, memfunc) |
| def | removePortConnectListener (self, listener_type, listener) |
| def | addPortConnectRetListener (self, listener_type, memfunc) |
| def | removePortConnectRetListener (self, listener_type, listener) |
| def | addConfigurationParamListener (self, type, memfunc) |
| def | removeConfigurationParamListener (self, type, listener) |
| def | addConfigurationSetListener (self, listener_type, memfunc) |
| def | removeConfigurationSetListener (self, type, listener) |
| def | addConfigurationSetNameListener (self, type, memfunc) |
| def | removeConfigurationSetNameListener (self, type, listener) |
| def | addPreFsmActionListener (self, listener_type, memfunc) |
| def | removePreFsmActionListener (self, listener_type, listener) |
| def | addPostFsmActionListener (self, listener_type, memfunc) |
| def | removePostFsmActionListener (self, listener_type, listener) |
| def | addFsmProfileListener (self, listener_type, memfunc) |
| def | removeFsmProfileListener (self, listener_type, listener) |
| def | addFsmStructureListener (self, listener_type, memfunc) |
| def | removeFsmStructureListener (self, listener_type, listener) |
| def | shutdown (self) |
| def | getPrivateContextOptions (self, ec_args) |
| getting individual EC options from RTC's configuration file More... | |
| def | getGlobalContextOptions (self, global_ec_props) |
| getting global EC options from rtc.conf More... | |
| def | getContextOptions (self, ec_args) |
| getting EC options More... | |
| def | findExistingEC (self, ec_arg) |
| fiding existing EC from the factory More... | |
| def | createContexts (self, ec_args) |
| creating, initializing and binding context More... | |
| def | setINSObjRef (self, obj) |
| omniINSPOAから取得したオブジェクトを登録 More... | |
Detailed Description
PeriodicECSharedComposite class
This is a base class of the data flow type RT-Component. Inherit this class when implementing various data flow type RT-Components.
- Since
- 0.4.0
Constructor & Destructor Documentation
◆ __init__()
| def OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.__init__ | ( | self, | |
| manager | |||
| ) |
Constructor
Constructor
- Parameters
-
manager Manager object
Reimplemented from OpenRTM_aist.DataFlowComponentBase.DataFlowComponentBase.
◆ __del__()
| def OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.__del__ | ( | self | ) |
Member Function Documentation
◆ activateChildComp()
| def OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.activateChildComp | ( | self, | |
| rtobj | |||
| ) |
- Parameters
-
self rtobj RTC
◆ deactivateChildComp()
| def OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.deactivateChildComp | ( | self, | |
| rtobj | |||
| ) |
- Parameters
-
self rtobj RTC
◆ onActivated()
| def OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.onActivated | ( | self, | |
| exec_handle | |||
| ) |
Callback function to activate
This is a callback function that is executed when ComponentAction::on_activated was invoked.
As for actual activation of each component, since this function is dummy-implemented to return RTC::RTC_OK unconditionally, you need to implement this function by overriding it.
- Parameters
-
exec_handle ID of the participant ExecutionContext
- Returns
- The return code of ReturnCode_t type
Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.
◆ onDeactivated()
| def OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.onDeactivated | ( | self, | |
| exec_handle | |||
| ) |
Callback function to deactivate
This is a callback function that is executed when ComponentAction::on_deactivated was invoked.
As for actual deactivation of each component, since this function is dummy-implemented to return RTC::RTC_OK unconditionally, you need to implement this function by overriding it.
- Parameters
-
exec_handle ID of the participant ExecutionContext
- Returns
- The return code of ReturnCode_t type
Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.
◆ onFinalize()
| def OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.onFinalize | ( | self | ) |
[ComponentAction CORBA interface] Finalize RTC
The RTC is being destroyed. Any final RTC-specific tear-down logic should be performed here. As a result of this operation, onFinalize() callback function is called.
- Returns
- The return code of ReturnCode_t type
Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.
◆ onInitialize()
| def OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.onInitialize | ( | self | ) |
Initialization
Initialization the data flow type RT-Component. Write the actual initialization code in each concrete class.
Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.
◆ onReset()
| def OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.onReset | ( | self, | |
| exec_handle | |||
| ) |
Callback function to reset
This is a callback function that is executed when ComponentAction::on_reset was invoked.
As for actual reset of each component, since this function is dummy-implemented to return RTC::RTC_OK unconditionally, you need to implement this function by overriding it.
- Parameters
-
exec_handle ID of the participant ExecutionContext
- Returns
- The return code of ReturnCode_t type
Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.
◆ resetChildComp()
| def OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.resetChildComp | ( | self, | |
| rtobj | |||
| ) |
- Parameters
-
self rtobj RTC
◆ shutdown()
| def OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.shutdown | ( | self | ) |
- Parameters
-
self
Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.
The documentation for this class was generated from the following file:
- C:/docs/OpenRTM-aist-Python/OpenRTM_aist/PeriodicECSharedComposite.py
