Public Member Functions | Private Attributes | List of all members
OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite Class Reference

PeriodicECSharedComposite class. More...

Inheritance diagram for OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite:
Inheritance graph
[legend]

Public Member Functions

def __del__ (self)
 Destructor. More...
 
def __init__ (self, manager)
 Constructor. More...
 
def onActivated (self, exec_handle)
 Callback function to activate. More...
 
def onDeactivated (self, exec_handle)
 Callback function to deactivate. More...
 
def onFinalize (self)
 [ComponentAction CORBA interface] Finalize RTC More...
 
def onInitialize (self)
 Initialization. More...
 
def onReset (self, exec_handle)
 Callback function to reset. More...
 
- 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 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 finalizeContexts (self)
 
def finalizePorts (self)
 Unregister the All Portse. 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_context (self, ec_id)
 [CORBA interface] Get ExecutionContextList. More...
 
def get_context_handle (self, cxt)
 
def get_device_profile (self)
 [SDO interface] Getting SDO DeviceProfile More...
 
def get_monitoring (self)
 [SDO interface] Get Monitoring object More...
 
def get_organizations (self)
 [SDO interface] Getting Organizations More...
 
def get_owned_contexts (self)
 [CORBA interface] Get ExecutionContextList. More...
 
def get_owned_organizations (self)
 [SDO interface] Getting Organizations More...
 
def get_participating_contexts (self)
 [CORBA interface] Get participating ExecutionContextList. 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, _id)
 [SDO interface] Getting specified SDO Service's reference More...
 
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 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 initialize (self)
 Initialize the RTC that realizes this interface. 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 on_aborting (self, ec_id)
 [ComponentAction CORBA interface] Transition Error State More...
 
def on_activated (self, ec_id)
 [ComponentAction CORBA interface] Activate RTC More...
 
def on_deactivated (self, ec_id)
 [ComponentAction CORBA interface] Deactivate RTC More...
 
def on_error (self, ec_id)
 [ComponentAction CORBA interface] Error Processing of RTC More...
 
def on_execute (self, ec_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, ec_id)
 [DataFlowComponentAction CORBA interface] Notify rate chenged More...
 
def on_reset (self, ec_id)
 [ComponentAction CORBA interface] Resetting RTC More...
 
def on_shutdown (self, ec_id)
 [ComponentAction CORBA interface] ShutDown RTC More...
 
def on_startup (self, ec_id)
 [ComponentAction CORBA interface] StartUp RTC More...
 
def on_state_update (self, ec_id)
 [DataFlowComponentAction CORBA interface] Secondary Periodic Operation of RTC 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

 _members
 
 _objref
 
 _org
 
 _ref
 
 _rtcout
 

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

Definition at line 617 of file PeriodicECSharedComposite.py.

Constructor & Destructor Documentation

◆ __init__()

def OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.__init__ (   self,
  manager 
)

Constructor.

Constructor

Parameters
managerManager object

Definition at line 637 of file PeriodicECSharedComposite.py.

◆ __del__()

def OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.__del__ (   self)

Destructor.

Destructor

Definition at line 672 of file PeriodicECSharedComposite.py.

Member Function Documentation

◆ 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_handleID of the participant ExecutionContext
Returns
The return code of ReturnCode_t type

Definition at line 759 of file PeriodicECSharedComposite.py.

◆ 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_handleID of the participant ExecutionContext
Returns
The return code of ReturnCode_t type

Definition at line 813 of file PeriodicECSharedComposite.py.

◆ 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

Definition at line 891 of file PeriodicECSharedComposite.py.

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

Definition at line 692 of file PeriodicECSharedComposite.py.

◆ 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_handleID of the participant ExecutionContext
Returns
The return code of ReturnCode_t type

Definition at line 855 of file PeriodicECSharedComposite.py.

Member Data Documentation

◆ _members

OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite._members
private

Definition at line 645 of file PeriodicECSharedComposite.py.

◆ _objref

OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite._objref
private

Definition at line 640 of file PeriodicECSharedComposite.py.

◆ _org

OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite._org
private

Definition at line 641 of file PeriodicECSharedComposite.py.

◆ _ref

OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite._ref
private

Definition at line 639 of file PeriodicECSharedComposite.py.

◆ _rtcout

OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite._rtcout
private

Definition at line 647 of file PeriodicECSharedComposite.py.


The documentation for this class was generated from the following file:


openrtm_aist_python
Author(s): Shinji Kurihara
autogenerated on Mon Feb 28 2022 23:01:08