OpenRTM-aist-Python 2.0.0
公開メンバ関数 | 全メンバ一覧
OpenRTM_aist.DataFlowComponentBase.DataFlowComponentBase クラス

[詳解]

OpenRTM_aist.DataFlowComponentBase.DataFlowComponentBase の継承関係図
OpenRTM_aist.RTObject.RTObject_impl OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite

公開メンバ関数

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)
 
- 基底クラス 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)
 
def setInstanceName (self, instance_name)
 
def getTypeName (self)
 
def getDescription (self)
 
def getVersion (self)
 
def getVendor (self)
 
def getCategory (self)
 
def getNamingNames (self)
 
def setObjRef (self, rtobj)
 
def getObjRef (self)
 
def setProperties (self, prop)
 
def getProperties (self)
 
def bindParameter (self, param_name, var, def_val, trans=None)
 
def getConfigService (self)
 
def updateParameters (self, config_set)
 
def registerPort (self, port)
 
def registerInPort (self, name, inport)
 
def registerOutPort (self, name, 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 [詳解]
 
def getGlobalContextOptions (self, global_ec_props)
 getting global EC options from rtc.conf [詳解]
 
def getContextOptions (self, ec_args)
 getting EC options [詳解]
 
def findExistingEC (self, ec_arg)
 fiding existing EC from the factory [詳解]
 
def createContexts (self, ec_args)
 creating, initializing and binding context [詳解]
 
def setINSObjRef (self, obj)
 omniINSPOAから取得したオブジェクトを登録 [詳解]
 

詳解

DataFlowComponentBase クラス

データフロー型RTComponentの基底クラス。 各種データフロー型RTComponentを実装する場合は、本クラスを継承する形で実装 する。

から
0.4.0

構築子と解体子

◆ __init__()

def OpenRTM_aist.DataFlowComponentBase.DataFlowComponentBase.__init__ (   self,
  manager = None,
  orb = None,
  poa = None 
)

コンストラクタ

コンストラクタ

引数
self
managerマネージャオブジェクト

OpenRTM_aist.RTObject.RTObject_implを再実装しています。

OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedCompositeで再実装されています。

メソッド詳解

◆ init()

def OpenRTM_aist.DataFlowComponentBase.DataFlowComponentBase.init (   self)

初期化(サブクラス実装用)

データフロー型 RTComponent の初期化を実行する。 実際の初期化処理は、各具象クラス内に記述する。

引数
self

◆ on_execute()

def OpenRTM_aist.DataFlowComponentBase.DataFlowComponentBase.on_execute (   self,
  ec_id 
)

[DataFlowComponentAction CORBA interface] RTC の定常処理(第一周期)

以下の状態が保持されている場合に、設定された周期で定期的に呼び出される。

  • RTC は Alive 状態である。
  • 指定された ExecutionContext が Running 状態である。 本オペレーションは、Two-Pass Execution の第一周期で実行される。 このオペレーション呼び出しの結果として onExecute() コールバック関数が呼び 出される。

制約

  • 指定された ExecutionContext の ExecutionKind は、 PERIODIC でなければな らない
引数
self
ec_id定常処理対象 ExecutionContext の ID
戻り値
ReturnCode_t 型のリターンコード

◆ on_rate_changed()

def OpenRTM_aist.DataFlowComponentBase.DataFlowComponentBase.on_rate_changed (   self,
  ec_id 
)

[DataFlowComponentAction CORBA interface] 実行周期変更通知

本オペレーションは、ExecutionContext の実行周期が変更されたことを通知する 際に呼び出される。 このオペレーション呼び出しの結果として onRateChanged() コールバック関数が 呼び出される。

制約

  • 指定された ExecutionContext の ExecutionKind は、 PERIODIC でなければな らない
引数
self
ec_id定常処理対象 ExecutionContext の ID
戻り値
ReturnCode_t 型のリターンコード

◆ on_state_update()

def OpenRTM_aist.DataFlowComponentBase.DataFlowComponentBase.on_state_update (   self,
  ec_id 
)

[DataFlowComponentAction CORBA interface] RTC の定常処理(第二周期)

以下の状態が保持されている場合に、設定された周期で定期的に呼び出される。

  • RTC は Alive 状態である。
  • 指定された ExecutionContext が Running 状態である。 本オペレーションは、Two-Pass Execution の第二周期で実行される。 このオペレーション呼び出しの結果として onStateUpdate() コールバック関数が 呼び出される。

制約

  • 指定された ExecutionContext の ExecutionKind は、 PERIODIC でなければな らない
引数
self
ec_id定常処理対象 ExecutionContext の ID
戻り値
ReturnCode_t 型のリターンコード

このクラス詳解は次のファイルから抽出されました: