OpenRTM-aist-Python 2.0.2
|
クラス | |
class | connector_cleanup |
公開メンバ関数 | |
__init__ (self, name, data_type) | |
__del__ (self, PortBase=OpenRTM_aist.PortBase) | |
init (self, prop) | |
write (self) | |
connect (self, connector_profile) | |
notify_connect (self, connector_profile) | |
properties (self) | |
connectors (self) | |
getConnectorProfiles (self) | |
getConnectorIds (self) | |
getConnectorNames (self) | |
getConnectorById (self, id) | |
getConnectorByName (self, name) | |
getConnectorProfileById (self, id) | |
getConnectorProfileByName (self, name) | |
activateInterfaces (self) | |
deactivateInterfaces (self) | |
addConnectorDataListener (self, listener_type, listener) | |
removeConnectorDataListener (self, listener_type, listener) | |
addConnectorListener (self, callback_type, listener) | |
removeConnectorListener (self, callback_type, listener) | |
configure (self) | |
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_) | |
getLocalInPort (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) | |
OutPort 基底クラス
OutPort の基底クラス。
Properties: port.outport プロパティは
以下に指定したものが渡される。 (port.outport.[name]が優先される) さらに、一部のプロパティは接続時に ConnectorProfile により 渡される場合があり、その場合は ConnectorProfile が優先される。
dataport.dataflow_type dataport.interface_type dataport.subscription_type
[buffer]
[publihser]
[interface]
OutPort 側の connect() では以下のシーケンスで処理が行われる。
OpenRTM_aist.OutPortBase.OutPortBase.__init__ | ( | self, | |
name, | |||
data_type ) |
コンストラクタ
コンストラクタ。
self | |
name | ポート名 |
OutPortBase.OutPortBase(const char* name, const char* data_type)
OpenRTM_aist.PortBase.PortBaseを再実装しています。
OpenRTM_aist.CSPOutPort.CSPOutPort, OpenRTM_aist.OutPort.OutPortで再実装されています。
OpenRTM_aist.OutPortBase.OutPortBase.__del__ | ( | self, | |
PortBase = OpenRTM_aist.PortBase ) |
デストラクタ
デストラクタ。 登録された全ての Publisher を削除する。
self |
OpenRTM_aist.PortBase.PortBaseを再実装しています。
OpenRTM_aist.CSPOutPort.CSPOutPort, OpenRTM_aist.OutPort.OutPortで再実装されています。
OpenRTM_aist.OutPortBase.OutPortBase.activateInterfaces | ( | self | ) |
OutPortを activates する
OpenRTM_aist.OutPortBase.OutPortBase.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 listener_type, ConnectorDataListener* listener);
OpenRTM_aist.OutPortBase.OutPortBase.addConnectorListener | ( | self, | |
callback_type, | |||
listener ) |
ConnectorListener リスナを追加する
バッファ書き込みまたは読み出しイベントに関連する各種リスナを設定する。
設定できるリスナのタイプは
リスナは以下のシグニチャを持つ operator() を実装している必要がある。
ConnectorListener.operator()(const ConnectorProfile&)
デフォルトでは、この関数に与えたリスナオブジェクトの所有権は OutPortに移り、OutPort解体時もしくは、 removeConnectorListener() により削除時に自動的に解体される。 リスナオブジェクトの所有権を呼び出し側で維持したい場合は、第3引 数に false を指定し、自動的な解体を抑制することができる。
listener_type | リスナタイプ |
listener | リスナオブジェクトへのポインタ |
void addConnectorListener(ConnectorListenerType callback_type, ConnectorListener* listener);
OpenRTM_aist.OutPortBase.OutPortBase.configure | ( | self | ) |
OutPortの設定を行う
OpenRTM_aist.OutPortBase.OutPortBase.connect | ( | self, | |
connector_profile ) |
[CORBA interface] Port の接続を行う
与えられた ConnectoionProfile の情報に基づき、Port間の接続を確立 する。この関数は主にアプリケーションプログラムやツールから呼び出 すことを前提としている。
connector_profile | ConnectorProfile |
OpenRTM_aist.PortBase.PortBaseを再実装しています。
OpenRTM_aist.OutPortBase.OutPortBase.connectors | ( | self | ) |
Connector を取得
const std.vector<OutPortConnector*>& OutPortBase.connectors()
OpenRTM_aist.OutPortBase.OutPortBase.createConnector | ( | self, | |
cprof, | |||
prop, | |||
provider_ = None, | |||
consumer_ = None ) |
OutPortPushConnector の生成
OutPortConnector* OutPortBase.createConnector(const ConnectorProfile& cprof, coil.Properties& prop, InPortConsumer* consumer)
OpenRTM_aist.OutPortBase.OutPortBase.createConsumer | ( | self, | |
cprof, | |||
prop ) |
InPort consumer の生成
InPortConsumer* OutPortBase.createConsumer(const ConnectorProfile& cprof, coil.Properties& prop)
OpenRTM_aist.OutPortBase.OutPortBase.createDuplexConnector | ( | self, | |
cprof, | |||
prop, | |||
provider_ ) |
InPortDuplexConnector の生成
双方向通信用コネクタを生成し、生成が成功すれば m_connectors に保存する。
cprof | コネクタプロファイル |
prop | コネクタプロファイルをプロパティに変換 |
provider_ | プロバイダ |
OpenRTM_aist.OutPortBase.OutPortBase.createProvider | ( | self, | |
cprof, | |||
prop ) |
OutPort provider の生成
OutPortProvider* OutPortBase.createProvider(ConnectorProfile& cprof, coil.Properties& prop)
OpenRTM_aist.OutPortBase.OutPortBase.deactivateInterfaces | ( | self | ) |
全ての Port のインターフェースを deactivates する
OpenRTM_aist.OutPortBase.OutPortBase.getConnectorById | ( | self, | |
id ) |
ConnectorProfileをIDで取得
現在所有しているコネクタをIDで取得する。
id | Connector ID |
OutPortConnector* getConnectorById(const char* id);
OpenRTM_aist.OutPortBase.OutPortBase.getConnectorByName | ( | self, | |
name ) |
ConnectorProfileを名前で取得
現在所有しているコネクタを名前で取得する。
name | Connector name |
OutPortConnector* getConnectorByName(const char* name);
OpenRTM_aist.OutPortBase.OutPortBase.getConnectorIds | ( | self | ) |
ConnectorId を取得
coil.vstring OutPortBase.getConnectorIds()
OpenRTM_aist.OutPortBase.OutPortBase.getConnectorNames | ( | self | ) |
Connectorの名前を取得
coil.vstring OutPortBase.getConnectorNames()
OpenRTM_aist.OutPortBase.OutPortBase.getConnectorProfileById | ( | self, | |
id ) |
ConnectorProfileをIDで取得
bool OutPortBase.getConnectorProfileById(const char* id, ConnectorInfo& prof)
OpenRTM_aist.OutPortBase.OutPortBase.getConnectorProfileByName | ( | self, | |
name ) |
ConnectorProfileを名前で取得
bool OutPortBase.getConnectorProfileByName(const char* name, ConnectorInfo& prof)
OpenRTM_aist.OutPortBase.OutPortBase.getConnectorProfiles | ( | self | ) |
ConnectorProfile を取得
ConnectorBase.ConnectorInfoList OutPortBase.getConnectorProfiles()
OpenRTM_aist.OutPortBase.OutPortBase.getLocalInPort | ( | self, | |
profile ) |
ローカルのピアInPortを取得
self | |
profile | コネクタプロファイル |
InPortBase* getLocalInPort(const ConnectorInfo& profile)
OpenRTM_aist.OutPortBase.OutPortBase.init | ( | self, | |
prop ) |
プロパティの初期化
OutPortのプロパティを初期化する
void init(coil.Properties& prop);
OpenRTM_aist.CSPOutPort.CSPOutPortで再実装されています。
OpenRTM_aist.OutPortBase.OutPortBase.initConsumers | ( | self | ) |
InPort consumer の初期化
OpenRTM_aist.OutPortBase.OutPortBase.initProviders | ( | self | ) |
OutPort provider の初期化
OpenRTM_aist.OutPortBase.OutPortBase.notify_connect | ( | self, | |
connector_profile ) |
self | |
connector_profile |
OpenRTM_aist.PortBase.PortBaseを再実装しています。
OpenRTM_aist.CSPOutPort.CSPOutPortで再実装されています。
OpenRTM_aist.OutPortBase.OutPortBase.properties | ( | self | ) |
OpenRTM_aist.OutPortBase.OutPortBase.publishInterfaces | ( | self, | |
cprof ) |
Interface情報を公開する
ReturnCode_t OutPortBase.publishInterfaces(ConnectorProfile& cprof)
OpenRTM_aist.PortBase.PortBaseを再実装しています。
OpenRTM_aist.OutPortBase.OutPortBase.removeConnectorDataListener | ( | self, | |
listener_type, | |||
listener ) |
ConnectorDataListener リスナを削除する
設定した各種リスナを削除する。
listener_type | リスナタイプ |
listener | リスナオブジェクトへのポインタ |
void removeConnectorDataListener(ConnectorDataListenerType listener_type, ConnectorDataListener* listener);
OpenRTM_aist.OutPortBase.OutPortBase.removeConnectorListener | ( | self, | |
callback_type, | |||
listener ) |
ConnectorDataListener リスナを削除する
設定した各種リスナを削除する。
listener_type | リスナタイプ |
listener | リスナオブジェクトへのポインタ |
void removeConnectorListener(ConnectorListenerType callback_type, ConnectorListener* listener);
OpenRTM_aist.OutPortBase.OutPortBase.subscribeInterfaces | ( | self, | |
cprof ) |
Interface情報を取得する
ReturnCode_t OutPortBase.subscribeInterfaces(const ConnectorProfile& cprof)
OpenRTM_aist.PortBase.PortBaseを再実装しています。
OpenRTM_aist.OutPortBase.OutPortBase.unsubscribeInterfaces | ( | self, | |
connector_profile ) |
登録されているInterface情報を解除する
void OutPortBase.unsubscribeInterfaces(const ConnectorProfile& connector_profile)
OpenRTM_aist.PortBase.PortBaseを再実装しています。
OpenRTM_aist.OutPortBase.OutPortBase.write | ( | self | ) |
データ書き込み
ポートへデータを書き込む。 バインドされた変数に設定された値をポートに書き込む。
virtual bool write() = 0;
OpenRTM_aist.CSPOutPort.CSPOutPort, OpenRTM_aist.OutPort.OutPortで再実装されています。