OpenRTM-aist-Python 1.1.2
|
InPort 用 Port. [詳解]
公開メンバ関数 | |
def | __init__ (self, name, data_type) |
コンストラクタ [詳解] | |
def | __del__ (self, PortBase=OpenRTM_aist.PortBase) |
デストラクタ [詳解] | |
def | init (self, prop) |
プロパティの初期化 [詳解] | |
def | read (self) |
RTObject_impl::readAll()から呼ばれる仮想関数 [詳解] | |
def | properties (self) |
プロパティを取得する [詳解] | |
def | connectors (self) |
Connector を取得 [詳解] | |
def | getConnectorProfiles (self) |
ConnectorProfile を取得 [詳解] | |
def | getConnectorIds (self) |
ConnectorId を取得 [詳解] | |
def | getConnectorNames (self) |
Connectorの名前を取得 [詳解] | |
def | getConnectorById (self, id) |
ConnectorProfileをIDで取得 [詳解] | |
def | getConnectorByName (self, name) |
ConnectorProfileを名前で取得 [詳解] | |
def | getConnectorProfileById (self, id, prof) |
ConnectorProfileをIDで取得 [詳解] | |
def | getConnectorProfileByName (self, name, prof) |
ConnectorProfileを名前で取得 [詳解] | |
def | connect (self, connector_profile) |
[CORBA interface] Port の接続を行う [詳解] | |
def | activateInterfaces (self) |
InPortを activates する [詳解] | |
def | deactivateInterfaces (self) |
全ての Port のインターフェースを deactivates する [詳解] | |
def | addConnectorDataListener (self, listener_type, listener, autoclean=True) |
ConnectorDataListener リスナを追加する [詳解] | |
def | removeConnectorDataListener (self, listener_type, listener) |
ConnectorDataListener リスナを削除する [詳解] | |
def | addConnectorListener (self, listener_type, listener, autoclean=True) |
ConnectorListener リスナを追加する [詳解] | |
def | removeConnectorListener (self, listener_type, listener) |
ConnectorDataListener リスナを削除する [詳解] | |
def | publishInterfaces (self, cprof) |
Interface情報を公開する [詳解] | |
def | subscribeInterfaces (self, cprof) |
Interfaceに接続する [詳解] | |
def | unsubscribeInterfaces (self, connector_profile) |
Interfaceへの接続を解除する [詳解] | |
def | initProviders (self) |
InPort provider の初期化void initProviders();. | |
def | initConsumers (self) |
OutPort consumer の初期化void initConsumers();. | |
def | createProvider (self, cprof, prop) |
InPort provider の生成 [詳解] | |
def | createConsumer (self, cprof, prop) |
OutPort consumer の生成 [詳解] | |
def | createConnector (self, cprof, prop, provider_=None, consumer_=None) |
InPortPushConnector の生成 [詳解] | |
基底クラス OpenRTM_aist.PortBase.PortBase に属する継承公開メンバ関数 | |
def | __init__ (self, name=None) |
コンストラクタ [詳解] | |
def | __del__ (self) |
デストラクタ [詳解] | |
def | get_port_profile (self) |
[CORBA interface] PortProfileを取得する [詳解] | |
def | getPortProfile (self) |
PortProfile を取得する。 [詳解] | |
def | get_connector_profiles (self) |
[CORBA interface] ConnectorProfileListを取得する [詳解] | |
def | get_connector_profile (self, connector_id) |
[CORBA interface] ConnectorProfile を取得する [詳解] | |
def | connect (self, connector_profile) |
[CORBA interface] Port の接続を行う [詳解] | |
def | notify_connect (self, connector_profile) |
[CORBA interface] Port の接続通知を行う [詳解] | |
def | disconnect (self, connector_id) |
[CORBA interface] Port の接続を解除する [詳解] | |
def | notify_disconnect (self, connector_id) |
[CORBA interface] Port の接続解除通知を行う [詳解] | |
def | disconnect_all (self) |
[CORBA interface] Port の全接続を解除する [詳解] | |
def | setName (self, name) |
Port の名前を設定する [詳解] | |
def | getName (self) |
Port の名前を取得するconst char* PortBase::getName() const. | |
def | getProfile (self) |
PortProfileを取得する [詳解] | |
def | setPortRef (self, port_ref) |
Port のオブジェクト参照を設定する [詳解] | |
def | getPortRef (self) |
Port のオブジェクト参照を取得する [詳解] | |
def | setOwner (self, owner) |
Port の owner の RTObject を指定する [詳解] | |
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) |
PortConnectListeners のホルダをセットする [詳解] | |
def | publishInterfaces (self, connector_profile) |
Interface 情報を公開する(サブクラス実装用) [詳解] | |
def | connectNext (self, connector_profile) |
次の Port に対して notify_connect() をコールする [詳解] | |
def | disconnectNext (self, connector_profile) |
次の Port に対して notify_disconnect() をコールする [詳解] | |
def | subscribeInterfaces (self, connector_profile) |
Interface 情報を取得する(サブクラス実装用) [詳解] | |
def | unsubscribeInterfaces (self, connector_profile) |
Interface の接続を解除する(サブクラス実装用) [詳解] | |
def | setConnectionLimit (self, limit_value) |
接続の最大数を設定する。 [詳解] | |
def | isEmptyId (self, connector_profile) |
ConnectorProfile の connector_id フィールドが空かどうか判定 [詳解] | |
def | getUUID (self) |
UUIDを生成する [詳解] | |
def | setUUID (self, connector_profile) |
UUIDを生成し ConnectorProfile にセットする [詳解] | |
def | isExistingConnId (self, id_) |
id が既存の ConnectorProfile のものかどうか判定する [詳解] | |
def | findConnProfile (self, id_) |
id を持つ ConnectorProfile を探す [詳解] | |
def | findConnProfileIndex (self, id_) |
id を持つ ConnectorProfile を探す [詳解] | |
def | updateConnectorProfile (self, connector_profile) |
ConnectorProfile の追加もしくは更新 [詳解] | |
def | eraseConnectorProfile (self, id_) |
ConnectorProfile を削除する [詳解] | |
def | appendInterface (self, instance_name, type_name, pol) |
PortInterfaceProfile に インターフェースを登録する [詳解] | |
def | deleteInterface (self, name, pol) |
PortInterfaceProfile からインターフェース登録を削除する [詳解] | |
def | addProperty (self, key, value) |
PortProfile の properties に NameValue 値を追加する [詳解] | |
def | appendProperty (self, key, value) |
PortProfile の properties に NameValue 値を要素に追加する [詳解] | |
def | updateConnectors (self) |
存在しないポートをdisconnectする。 [詳解] | |
def | checkPorts (self, ports) |
ポートの存在を確認する。 [詳解] | |
基底クラス OpenRTM_aist.DataPortStatus.DataPortStatus に属する継承公開メンバ関数 | |
def | toString (status) |
DataPortStatus リターンコードを文字列に変換 [詳解] | |
その他の継承メンバ | |
基底クラス OpenRTM_aist.DataPortStatus.DataPortStatus に属する継承静的公開変数類 | |
int | PORT_OK = 0 |
brief DataPortStatus リターンコード [詳解] | |
InPort 用 Port.
データ入力ポートの実装クラス。
def OpenRTM_aist.InPortBase.InPortBase.__init__ | ( | self, | |
name, | |||
data_type | |||
) |
コンストラクタ
コンストラクタ
name | ポート名称 |
inport | 当該データ入力ポートに関連付けるInPortオブジェクト InPortオブジェクトで扱うデータ型、バッファタイプも指定する |
prop | ポート設定用プロパティ |
InPortBase(const char* name, const char* data_type);
def OpenRTM_aist.InPortBase.InPortBase.__del__ | ( | self, | |
PortBase = OpenRTM_aist.PortBase |
|||
) |
デストラクタ
デストラクタ
def OpenRTM_aist.InPortBase.InPortBase.activateInterfaces | ( | self | ) |
def OpenRTM_aist.InPortBase.InPortBase.addConnectorDataListener | ( | self, | |
listener_type, | |||
listener, | |||
autoclean = True |
|||
) |
ConnectorDataListener リスナを追加する
バッファ書き込みまたは読み出しイベントに関連する各種リスナを設定する。
設定できるリスナのタイプとコールバックイベントは以下の通り
リスナは ConnectorDataListener を継承し、以下のシグニチャを持つ operator() を実装している必要がある。
ConnectorDataListener:: operator()(const ConnectorProfile&, const cdrStream&)
デフォルトでは、この関数に与えたリスナオブジェクトの所有権は OutPortに移り、OutPort解体時もしくは、 removeConnectorDataListener() により削除時に自動的に解体される。 リスナオブジェクトの所有権を呼び出し側で維持したい場合は、第3引 数に false を指定し、自動的な解体を抑制することができる。
listener_type | リスナタイプ |
listener | リスナオブジェクトへのポインタ |
autoclean | リスナオブジェクトの自動的解体を行うかどうかのフラグ |
void addConnectorDataListener(ConnectorDataListenerType type, ConnectorDataListener* listener, bool autoclean)
def OpenRTM_aist.InPortBase.InPortBase.addConnectorListener | ( | self, | |
listener_type, | |||
listener, | |||
autoclean = True |
|||
) |
ConnectorListener リスナを追加する
バッファ書き込みまたは読み出しイベントに関連する各種リスナを設定する。
設定できるリスナのタイプは
リスナは以下のシグニチャを持つ operator() を実装している必要がある。
ConnectorListener::operator()(const ConnectorProfile&)
デフォルトでは、この関数に与えたリスナオブジェクトの所有権は OutPortに移り、OutPort解体時もしくは、 removeConnectorListener() により削除時に自動的に解体される。 リスナオブジェクトの所有権を呼び出し側で維持したい場合は、第3引 数に false を指定し、自動的な解体を抑制することができる。
listener_type | リスナタイプ |
listener | リスナオブジェクトへのポインタ |
autoclean | リスナオブジェクトの自動的解体を行うかどうかのフラグ |
void addConnectorListener(ConnectorListenerType type, ConnectorListener* listener, bool autoclean)
def OpenRTM_aist.InPortBase.InPortBase.connect | ( | self, | |
connector_profile | |||
) |
[CORBA interface] Port の接続を行う
与えられた ConnectoionProfile の情報に基づき、Port間の接続を確立 する。この関数は主にアプリケーションプログラムやツールから呼び出 すことを前提としている。
connector_profile | ConnectorProfile |
def OpenRTM_aist.InPortBase.InPortBase.connectors | ( | self | ) |
Connector を取得
現在所有しているコネクタを取得する。
const std::vector<InPortConnector*>& connectors();
def OpenRTM_aist.InPortBase.InPortBase.createConnector | ( | self, | |
cprof, | |||
prop, | |||
provider_ = None , |
|||
consumer_ = None |
|||
) |
InPortPushConnector の生成
Connector を生成し、生成が成功すれば m_connectors に保存する。 生成に失敗した場合 0 を返す。
InPortConnector* createConnector(ConnectorProfile& cprof, coil::Properties& prop, InPortProvider* provider);
def OpenRTM_aist.InPortBase.InPortBase.createConsumer | ( | self, | |
cprof, | |||
prop | |||
) |
OutPort consumer の生成
OutPortConsumer を生成する。 生成に失敗した場合 0 を返す。
OutPortConsumer* createConsumer(const ConnectorProfile& cprof, coil::Properties& prop);
def OpenRTM_aist.InPortBase.InPortBase.createProvider | ( | self, | |
cprof, | |||
prop | |||
) |
InPort provider の生成
InPortProvider を生成し、情報を ConnectorProfile に公開する。 生成に失敗した場合 0 を返す。
InPortProvider* createProvider(ConnectorProfile& cprof, coil::Properties& prop);
def OpenRTM_aist.InPortBase.InPortBase.deactivateInterfaces | ( | self | ) |
全ての Port のインターフェースを deactivates する
Port に登録されている全てのインターフェースを deactivate する。
void deactivateInterfaces();
def OpenRTM_aist.InPortBase.InPortBase.getConnectorById | ( | self, | |
id | |||
) |
ConnectorProfileをIDで取得
現在所有しているコネクタをIDで取得する。
id | Connector ID |
InPortConnector* getConnectorById(const char* id);
def OpenRTM_aist.InPortBase.InPortBase.getConnectorByName | ( | self, | |
name | |||
) |
ConnectorProfileを名前で取得
現在所有しているコネクタを名前で取得する。
name | Connector name |
InPortConnector* getConnectorByName(const char* name);
def OpenRTM_aist.InPortBase.InPortBase.getConnectorIds | ( | self | ) |
def OpenRTM_aist.InPortBase.InPortBase.getConnectorNames | ( | self | ) |
def OpenRTM_aist.InPortBase.InPortBase.getConnectorProfileById | ( | self, | |
id, | |||
prof | |||
) |
ConnectorProfileをIDで取得
現在所有しているコネクタをIDで取得する。
id | Connector ID |
prof | ConnectorProfile |
bool getConnectorProfileById(const char* id, ConnectorInfo& prof);
def OpenRTM_aist.InPortBase.InPortBase.getConnectorProfileByName | ( | self, | |
name, | |||
prof | |||
) |
ConnectorProfileを名前で取得
現在所有しているコネクタを名前で取得する。
name | Connector name |
prof | ConnectorProfile |
bool getConnectorProfileByName(const char* name, ConnectorInfo& prof);
def OpenRTM_aist.InPortBase.InPortBase.getConnectorProfiles | ( | self | ) |
ConnectorProfile を取得
現在所有しているコネクタのProfileを取得する。
ConnectorInfoList getConnectorProfiles();
def OpenRTM_aist.InPortBase.InPortBase.init | ( | self, | |
prop | |||
) |
プロパティの初期化
指定されたプロパティで初期化する。
prop | 設定するプロパティ |
void init(coil::Properties& prop);
def OpenRTM_aist.InPortBase.InPortBase.properties | ( | self | ) |
プロパティを取得する
InPortのプロパティを取得する。
def OpenRTM_aist.InPortBase.InPortBase.publishInterfaces | ( | self, | |
cprof | |||
) |
Interface情報を公開する
Interface情報を公開する。 引数の ConnectorProfile に格納されている dataflow_type が push 型 の場合は、指定された interface_type の InPortProvider に関する情報 を ConnectorProfile::properties に書込み呼び出し側に戻す。
dataport.dataflow_type
connector_profile | コネクタプロファイル |
ReturnCode_t publishInterfaces(ConnectorProfile& connector_profile);
def OpenRTM_aist.InPortBase.InPortBase.read | ( | self | ) |
def OpenRTM_aist.InPortBase.InPortBase.removeConnectorDataListener | ( | self, | |
listener_type, | |||
listener | |||
) |
ConnectorDataListener リスナを削除する
設定した各種リスナを削除する。
listener_type | リスナタイプ |
listener | リスナオブジェクトへのポインタ |
void removeConnectorDataListener(ConnectorDataListenerType type, ConnectorDataListener* listener)
def OpenRTM_aist.InPortBase.InPortBase.removeConnectorListener | ( | self, | |
listener_type, | |||
listener | |||
) |
ConnectorDataListener リスナを削除する
設定した各種リスナを削除する。
listener_type | リスナタイプ |
listener | リスナオブジェクトへのポインタ |
void removeConnectorListener(ConnectorListenerType type, ConnectorListener* listener)
def OpenRTM_aist.InPortBase.InPortBase.subscribeInterfaces | ( | self, | |
cprof | |||
) |
Interfaceに接続する
Interfaceに接続する。 Portが所有するConsumerに適合するProviderに関する情報を ConnectorProfile::properties から抽出し、 ConsumerにCORBAオブジェクト参照を設定する。
connector_profile | コネクタ・プロファイル |
ReturnCode_t subscribeInterfaces(const ConnectorProfile& connector_profile);
def OpenRTM_aist.InPortBase.InPortBase.unsubscribeInterfaces | ( | self, | |
connector_profile | |||
) |
Interfaceへの接続を解除する
Interfaceへの接続を解除する。 与えられたConnectorProfileに関連するConsumerに設定された全てのObjectを 解放し接続を解除する。
connector_profile | コネクタ・プロファイル |
void unsubscribeInterfaces(const ConnectorProfile& connector_profile);