OpenRTM-aist-Python 2.0.2
|
公開メンバ関数 | |
__init__ (self, name, data_type) | |
__del__ (self, PortBase=OpenRTM_aist.PortBase) | |
init (self, prop) | |
read (self) | |
properties (self) | |
connectors (self) | |
getConnectorProfiles (self) | |
getConnectorIds (self) | |
getConnectorNames (self) | |
getConnectorById (self, id) | |
getConnectorByName (self, name) | |
getConnectorProfileById (self, id) | |
getConnectorProfileByName (self, name) | |
connect (self, connector_profile) | |
notify_connect (self, connector_profile) | |
activateInterfaces (self) | |
deactivateInterfaces (self) | |
addConnectorDataListener (self, listener_type, listener) | |
removeConnectorDataListener (self, listener_type, listener) | |
addConnectorListener (self, listener_type, listener) | |
removeConnectorListener (self, listener_type, listener) | |
publishInterfaces (self, cprof) | |
subscribeInterfaces (self, cprof) | |
unsubscribeInterfaces (self, connector_profile) | |
initProviders (self) | |
initConsumers (self) | |
createProvider (self, cprof, prop) | |
createConsumer (self, cprof, prop) | |
createConnector (self, cprof, prop, provider_=None, consumer_=None) | |
createDuplexConnector (self, cprof, prop, provider_) | |
getLocalOutPort (self, profile) | |
![]() | |
exit (self) | |
get_port_profile (self) | |
getPortProfile (self) | |
get_connector_profiles (self) | |
get_connector_profile (self, connector_id) | |
disconnect (self, connector_id) | |
notify_disconnect (self, connector_id) | |
disconnect_all (self) | |
setName (self, name) | |
getName (self) | |
getProfile (self) | |
setPortRef (self, port_ref) | |
getPortRef (self) | |
setOwner (self, owner) | |
setOnPublishInterfaces (self, on_publish) | |
setOnSubscribeInterfaces (self, on_subscribe) | |
setOnConnected (self, on_connected) | |
setOnUnsubscribeInterfaces (self, on_subscribe) | |
setOnDisconnected (self, on_disconnected) | |
setPortConnectListenerHolder (self, portconnListeners) | |
connectNext (self, connector_profile) | |
disconnectNext (self, connector_profile) | |
setConnectionLimit (self, limit_value) | |
isEmptyId (self, connector_profile) | |
getUUID (self) | |
setUUID (self, connector_profile) | |
isExistingConnId (self, id_) | |
findConnProfile (self, id_) | |
findConnProfileIndex (self, id_) | |
updateConnectorProfile (self, connector_profile) | |
eraseConnectorProfile (self, id_) | |
appendInterface (self, instance_name, type_name, pol) | |
deleteInterface (self, name, pol) | |
addProperty (self, key, value) | |
appendProperty (self, key, value) | |
updateConnectors (self) | |
checkPorts (self, ports) | |
isExistingMarshalingType (self, con_prop) | |
![]() | |
toString (status) | |
その他の継承メンバ | |
![]() | |
int | PORT_OK = 0 |
brief DataPortStatus リターンコード | |
![]() | |
_publishInterfaces (self) | |
InPort 用 Port
データ入力ポートの実装クラス。
OpenRTM_aist.InPortBase.InPortBase.__init__ | ( | self, | |
name, | |||
data_type ) |
コンストラクタ
コンストラクタ
name | ポート名称 |
inport | 当該データ入力ポートに関連付けるInPortオブジェクト InPortオブジェクトで扱うデータ型、バッファタイプも指定する |
prop | ポート設定用プロパティ |
InPortBase(const char* name, const char* data_type);
OpenRTM_aist.PortBase.PortBaseを再実装しています。
OpenRTM_aist.CSPEventPort.CSPEventPort, OpenRTM_aist.CSPInPort.CSPInPort, OpenRTM_aist.EventPort.EventInPort, OpenRTM_aist.EventPort_pyfsm.EventInPort, OpenRTM_aist.InPort.InPortで再実装されています。
OpenRTM_aist.InPortBase.InPortBase.__del__ | ( | self, | |
PortBase = OpenRTM_aist.PortBase ) |
OpenRTM_aist.InPortBase.InPortBase.activateInterfaces | ( | self | ) |
OpenRTM_aist.InPortBase.InPortBase.addConnectorDataListener | ( | self, | |
listener_type, | |||
listener ) |
ConnectorDataListener リスナを追加する
バッファ書き込みまたは読み出しイベントに関連する各種リスナを設定する。
設定できるリスナのタイプとコールバックイベントは以下の通り
リスナは ConnectorDataListener を継承し、以下のシグニチャを持つ operator() を実装している必要がある。
ConnectorDataListener:: operator()(const ConnectorProfile&, const cdrStream&)
デフォルトでは、この関数に与えたリスナオブジェクトの所有権は OutPortに移り、OutPort解体時もしくは、 removeConnectorDataListener() により削除時に自動的に解体される。 リスナオブジェクトの所有権を呼び出し側で維持したい場合は、第3引 数に false を指定し、自動的な解体を抑制することができる。
listener_type | リスナタイプ |
listener | リスナオブジェクトへのポインタ |
void addConnectorDataListener(ConnectorDataListenerType type, ConnectorDataListener* listener)
OpenRTM_aist.InPortBase.InPortBase.addConnectorListener | ( | self, | |
listener_type, | |||
listener ) |
ConnectorListener リスナを追加する
バッファ書き込みまたは読み出しイベントに関連する各種リスナを設定する。
設定できるリスナのタイプは
リスナは以下のシグニチャを持つ operator() を実装している必要がある。
ConnectorListener.operator()(const ConnectorProfile&)
デフォルトでは、この関数に与えたリスナオブジェクトの所有権は OutPortに移り、OutPort解体時もしくは、 removeConnectorListener() により削除時に自動的に解体される。 リスナオブジェクトの所有権を呼び出し側で維持したい場合は、第3引 数に false を指定し、自動的な解体を抑制することができる。
listener_type | リスナタイプ |
listener | リスナオブジェクトへのポインタ |
void addConnectorListener(ConnectorListenerType type, ConnectorListener* listener)
OpenRTM_aist.InPortBase.InPortBase.connect | ( | self, | |
connector_profile ) |
[CORBA interface] Port の接続を行う
与えられた ConnectoionProfile の情報に基づき、Port間の接続を確立 する。この関数は主にアプリケーションプログラムやツールから呼び出 すことを前提としている。
connector_profile | ConnectorProfile |
OpenRTM_aist.PortBase.PortBaseを再実装しています。
OpenRTM_aist.InPortBase.InPortBase.connectors | ( | self | ) |
Connector を取得
現在所有しているコネクタを取得する。
const std.vector<InPortConnector*>& connectors();
OpenRTM_aist.InPortBase.InPortBase.createConnector | ( | self, | |
cprof, | |||
prop, | |||
provider_ = None, | |||
consumer_ = None ) |
Connector を生成し、生成が成功すれば m_connectors に保存する。 生成に失敗した場合 None を返す。
InPortConnector* createConnector(ConnectorProfile& cprof, coil.Properties& prop, InPortProvider* provider);
OpenRTM_aist.InPortBase.InPortBase.createConsumer | ( | self, | |
cprof, | |||
prop ) |
OutPort consumer の生成
OutPortConsumer を生成する。 生成に失敗した場合 0 を返す。
OutPortConsumer* createConsumer(const ConnectorProfile& cprof, coil.Properties& prop);
OpenRTM_aist.InPortBase.InPortBase.createDuplexConnector | ( | self, | |
cprof, | |||
prop, | |||
provider_ ) |
InPortDuplexConnector の生成
双方向通信用コネクタを生成し、生成が成功すれば m_connectors に保存する。
cprof | コネクタプロファイル |
prop | コネクタプロファイルをプロパティに変換 |
provider_ | プロバイダ |
OpenRTM_aist.InPortBase.InPortBase.createProvider | ( | self, | |
cprof, | |||
prop ) |
InPort provider の生成
InPortProvider を生成し、情報を ConnectorProfile に公開する。 生成に失敗した場合 0 を返す。
InPortProvider* createProvider(ConnectorProfile& cprof, coil.Properties& prop);
OpenRTM_aist.InPortBase.InPortBase.deactivateInterfaces | ( | self | ) |
全ての Port のインターフェースを deactivates する
Port に登録されている全てのインターフェースを deactivate する。
void deactivateInterfaces();
OpenRTM_aist.InPortBase.InPortBase.getConnectorById | ( | self, | |
id ) |
ConnectorProfileをIDで取得
現在所有しているコネクタをIDで取得する。
id | Connector ID |
InPortConnector* getConnectorById(const char* id);
OpenRTM_aist.InPortBase.InPortBase.getConnectorByName | ( | self, | |
name ) |
ConnectorProfileを名前で取得
現在所有しているコネクタを名前で取得する。
name | Connector name |
InPortConnector* getConnectorByName(const char* name);
OpenRTM_aist.InPortBase.InPortBase.getConnectorIds | ( | self | ) |
OpenRTM_aist.InPortBase.InPortBase.getConnectorNames | ( | self | ) |
OpenRTM_aist.InPortBase.InPortBase.getConnectorProfileById | ( | self, | |
id ) |
ConnectorProfileをIDで取得
現在所有しているコネクタをIDで取得する。
id | Connector ID |
prof | ConnectorProfile |
bool getConnectorProfileById(const char* id, ConnectorInfo& prof);
OpenRTM_aist.InPortBase.InPortBase.getConnectorProfileByName | ( | self, | |
name ) |
ConnectorProfileを名前で取得
現在所有しているコネクタを名前で取得する。
name | Connector name |
prof | ConnectorProfile |
bool getConnectorProfileByName(const char* name, ConnectorInfo& prof);
OpenRTM_aist.InPortBase.InPortBase.getConnectorProfiles | ( | self | ) |
ConnectorProfile を取得
現在所有しているコネクタのProfileを取得する。
ConnectorInfoList getConnectorProfiles();
OpenRTM_aist.InPortBase.InPortBase.getLocalOutPort | ( | self, | |
profile ) |
ローカルのピアOutPortを取得
self | |
profile | コネクタプロファイル |
OutPortBase* getLocalOutPort(const ConnectorInfo& profile)
OpenRTM_aist.InPortBase.InPortBase.init | ( | self, | |
prop ) |
プロパティの初期化
指定されたプロパティで初期化する。
prop | 設定するプロパティ |
void init(coil.Properties& prop);
OpenRTM_aist.CSPEventPort.CSPEventPort, OpenRTM_aist.CSPInPort.CSPInPort, OpenRTM_aist.EventPort.EventInPort, OpenRTM_aist.EventPort_pyfsm.EventInPortで再実装されています。
OpenRTM_aist.InPortBase.InPortBase.initConsumers | ( | self | ) |
OutPort consumer の初期化
void initConsumers();
OpenRTM_aist.InPortBase.InPortBase.initProviders | ( | self | ) |
InPort provider の初期化
void initProviders();
OpenRTM_aist.InPortBase.InPortBase.notify_connect | ( | self, | |
connector_profile ) |
self | |
connector_profile |
OpenRTM_aist.PortBase.PortBaseを再実装しています。
OpenRTM_aist.CSPEventPort.CSPEventPort, OpenRTM_aist.CSPInPort.CSPInPortで再実装されています。
OpenRTM_aist.InPortBase.InPortBase.properties | ( | self | ) |
プロパティを取得する
InPortのプロパティを取得する。
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);
OpenRTM_aist.PortBase.PortBaseを再実装しています。
OpenRTM_aist.InPortBase.InPortBase.read | ( | self | ) |
RTObject_impl.readAll()から呼ばれる仮想関数
DataPort からデータを読み出す
virtual bool read() = 0;
OpenRTM_aist.CSPEventPort.CSPEventPort, OpenRTM_aist.CSPInPort.CSPInPort, OpenRTM_aist.InPort.InPortで再実装されています。
OpenRTM_aist.InPortBase.InPortBase.removeConnectorDataListener | ( | self, | |
listener_type, | |||
listener ) |
ConnectorDataListener リスナを削除する
設定した各種リスナを削除する。
listener_type | リスナタイプ |
listener | リスナオブジェクトへのポインタ |
void removeConnectorDataListener(ConnectorDataListenerType type, ConnectorDataListener* listener)
OpenRTM_aist.InPortBase.InPortBase.removeConnectorListener | ( | self, | |
listener_type, | |||
listener ) |
ConnectorDataListener リスナを削除する
設定した各種リスナを削除する。
listener_type | リスナタイプ |
listener | リスナオブジェクトへのポインタ |
void removeConnectorListener(ConnectorListenerType type, ConnectorListener* listener)
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);
OpenRTM_aist.PortBase.PortBaseを再実装しています。
OpenRTM_aist.InPortBase.InPortBase.unsubscribeInterfaces | ( | self, | |
connector_profile ) |
Interfaceへの接続を解除する
Interfaceへの接続を解除する。 与えられたConnectorProfileに関連するConsumerに設定された全てのObjectを 解放し接続を解除する。
connector_profile | コネクタ・プロファイル |
void unsubscribeInterfaces(const ConnectorProfile& connector_profile);
OpenRTM_aist.PortBase.PortBaseを再実装しています。