OpenRTM_aist.EventPort.EventInPort の継承関係図
公開メンバ関数 | |
| def | __init__ (self, name, fsm) |
| def | __del__ (self) |
| def | name (self) |
| def | init (self, prop) |
| def | bindEvent0 (self, name, handler) |
| def | bindEvent1 (self, name, handler, data_type) |
 基底クラス OpenRTM_aist.InPortBase.InPortBase に属する継承公開メンバ関数 | |
| def | __init__ (self, name, data_type) |
| def | __del__ (self, PortBase=OpenRTM_aist.PortBase) |
| def | init (self, prop) |
| def | read (self) |
| def | properties (self) |
| def | connectors (self) |
| def | getConnectorProfiles (self) |
| def | getConnectorIds (self) |
| def | getConnectorNames (self) |
| def | getConnectorById (self, id) |
| def | getConnectorByName (self, name) |
| def | getConnectorProfileById (self, id) |
| def | getConnectorProfileByName (self, name) |
| def | connect (self, connector_profile) |
| def | notify_connect (self, connector_profile) |
| def | activateInterfaces (self) |
| def | deactivateInterfaces (self) |
| def | addConnectorDataListener (self, listener_type, listener) |
| def | removeConnectorDataListener (self, listener_type, listener) |
| def | addConnectorListener (self, listener_type, listener) |
| def | removeConnectorListener (self, listener_type, listener) |
| def | publishInterfaces (self, cprof) |
| def | subscribeInterfaces (self, cprof) |
| def | unsubscribeInterfaces (self, connector_profile) |
| def | initProviders (self) |
| def | initConsumers (self) |
| def | createProvider (self, cprof, prop) |
| def | createConsumer (self, cprof, prop) |
| def | createConnector (self, cprof, prop, provider_=None, consumer_=None) |
| def | createDuplexConnector (self, cprof, prop, provider_) |
| def | getLocalOutPort (self, profile) |
| 基底クラス OpenRTM_aist.PortBase.PortBase に属する継承公開メンバ関数 | |
| def | __init__ (self, name=None) |
| def | __del__ (self) |
| def | exit (self) |
| def | get_port_profile (self) |
| def | getPortProfile (self) |
| def | get_connector_profiles (self) |
| def | get_connector_profile (self, connector_id) |
| def | connect (self, connector_profile) |
| def | notify_connect (self, connector_profile) |
| def | disconnect (self, connector_id) |
| def | notify_disconnect (self, connector_id) |
| def | disconnect_all (self) |
| def | setName (self, name) |
| def | getName (self) |
| def | getProfile (self) |
| def | setPortRef (self, port_ref) |
| def | getPortRef (self) |
| def | setOwner (self, owner) |
| def | setOnPublishInterfaces (self, on_publish) |
| def | setOnSubscribeInterfaces (self, on_subscribe) |
| def | setOnConnected (self, on_connected) |
| def | setOnUnsubscribeInterfaces (self, on_subscribe) |
| def | setOnDisconnected (self, on_disconnected) |
| def | setPortConnectListenerHolder (self, portconnListeners) |
| def | publishInterfaces (self, connector_profile) |
| def | connectNext (self, connector_profile) |
| def | disconnectNext (self, connector_profile) |
| def | subscribeInterfaces (self, connector_profile) |
| def | unsubscribeInterfaces (self, connector_profile) |
| def | setConnectionLimit (self, limit_value) |
| def | isEmptyId (self, connector_profile) |
| def | getUUID (self) |
| def | setUUID (self, connector_profile) |
| def | isExistingConnId (self, id_) |
| def | findConnProfile (self, id_) |
| def | findConnProfileIndex (self, id_) |
| def | updateConnectorProfile (self, connector_profile) |
| def | eraseConnectorProfile (self, id_) |
| def | appendInterface (self, instance_name, type_name, pol) |
| def | deleteInterface (self, name, pol) |
| def | addProperty (self, key, value) |
| def | appendProperty (self, key, value) |
| def | updateConnectors (self) |
| def | checkPorts (self, ports) |
| def | isExistingMarshalingType (self, con_prop) |
| 基底クラス OpenRTM_aist.DataPortStatus.DataPortStatus に属する継承公開メンバ関数 | |
| def | toString (status) |
その他の継承メンバ | |
| 基底クラス OpenRTM_aist.DataPortStatus.DataPortStatus に属する継承静的公開変数類 | |
| int | PORT_OK = 0 |
| brief DataPortStatus リターンコード [詳解] | |
詳解
EventInPort テンプレートクラス
EventInPort の実装である EventInPort<T> のテンプレートクラス。 <T> はBasicDataType.idl にて定義されている型で、メンバとして Time 型の tm , および T型の data を持つ構造体でなくてはならない。 EventInPort は内部にリングバッファを持ち、外部から送信されたデータを順次 このリングバッファに格納する。リングバッファのサイズはデフォルトで8と なっているが、コンストラクタ引数によりサイズを指定することができる。 データはフラグによって未読、既読状態が管理され、isNew(), write(), read(), isFull(), isEmpty() 等のメソッドによりハンドリングすることができる。
OnRead系コールバック (読み出しに起因するイベントによりコールされる)
- void OnRead::operator(): EventInPort::read() を呼び出し読み出しを行う際にコールされる。
- DataType OnReadConvert::operator(DataType): EventInPort::read() を呼び出し、データをバッファから読みだす際に呼ばれ データの変換を行う。引数にはバッファから読み出された値が与えられ、 変換後のデータを戻り値として返す。この値がread()の返す値となる。
- から
- 2.0.0
構築子と解体子
◆ __init__()
| def OpenRTM_aist.EventPort.EventInPort.__init__ | ( | self, | |
| name, | |||
| fsm | |||
| ) |
コンストラクタ
コンストラクタ。 パラメータとして与えられる T 型の変数にバインドされる。
- 引数
-
name EventInPort 名。EventInPortBase:name() により参照される。 value この EventInPort にバインドされる T 型の変数
OpenRTM_aist.InPortBase.InPortBaseを再実装しています。
◆ __del__()
| def OpenRTM_aist.EventPort.EventInPort.__del__ | ( | self | ) |
メソッド詳解
◆ bindEvent0()
| def OpenRTM_aist.EventPort.EventInPort.bindEvent0 | ( | self, | |
| name, | |||
| handler | |||
| ) |
引数なしのイベントハンドラを登録する コネクタのON_RECEIVEDコールバック実行時にバッファに実行予定のイベントとして格納する バッファに格納したイベントはMachineのrun_event関数で実行する
- 引数
-
name イベント名 handler イベントハンドラ
◆ bindEvent1()
| def OpenRTM_aist.EventPort.EventInPort.bindEvent1 | ( | self, | |
| name, | |||
| handler, | |||
| data_type | |||
| ) |
引数1つのイベントハンドラを登録する コネクタのON_RECEIVEDコールバック実行時にバッファに実行予定のイベントとして格納する バッファに格納したイベントはMachineのrun_event関数で実行する
- 引数
-
name イベント名 handler イベントハンドラ data_type データ型
◆ init()
| def OpenRTM_aist.EventPort.EventInPort.init | ( | self, | |
| prop | |||
| ) |
初期化 InPortBaseの初期化のほかにバッファ初期化のためのコネクタコールバック関数の登録を行う
- 引数
-
prop 設定情報
OpenRTM_aist.InPortBase.InPortBaseを再実装しています。
◆ name()
| def OpenRTM_aist.EventPort.EventInPort.name | ( | self | ) |
ポート名称を取得する。
ポート名称を取得する。
- 戻り値
- ポート名称
このクラス詳解は次のファイルから抽出されました:
- C:/docs/OpenRTM-aist-Python/OpenRTM_aist/EventPort.py
