OpenRTM_aist.OutPort.OutPort クラス

OutPort クラス [詳解]

OpenRTM_aist.OutPort.OutPort の継承関係図

クラス
class	subscribe

公開メンバ関数
def	__init__ (self, name, value, buffer=None)
	コンストラクタ [詳解]
def	write (self, value=None)
	データ書き込み [詳解]
def	setOnWrite (self, on_write)
	データ書き込み処理のブロックモードの設定 [詳解]
def	setOnWriteConvert (self, on_wconvert)
	OnWriteConvert コールバックの設定 [詳解]
def	getPortDataType (self)
	データ型名取得用メソッド [詳解]
基底クラス OpenRTM_aist.OutPortBase.OutPortBase に属する継承公開メンバ関数
def	__init__ (self, name, data_type)
	コンストラクタ [詳解]
def	__del__ (self, PortBase=OpenRTM_aist.PortBase)
	デストラクタ [詳解]
def	init (self, prop)
	プロパティの初期化 [詳解]
def	write (self)
	データ書き込み [詳解]
def	connect (self, connector_profile)
	[CORBA interface] Port の接続を行う [詳解]
def	properties (self)
	プロパティを取得する [詳解]
def	connectors (self)
	Connector を取得const std::vector<OutPortConnector*>& OutPortBase::connectors()
def	getConnectorProfiles (self)
	ConnectorProfile を取得ConnectorBase::ConnectorInfoList OutPortBase::getConnectorProfiles()
def	getConnectorIds (self)
	ConnectorId を取得coil::vstring OutPortBase::getConnectorIds()
def	getConnectorNames (self)
	Connectorの名前を取得coil::vstring OutPortBase::getConnectorNames()
def	getConnectorById (self, id)
	ConnectorProfileをIDで取得 [詳解]
def	getConnectorByName (self, name)
	ConnectorProfileを名前で取得 [詳解]
def	getConnectorProfileById (self, id, prof)
	ConnectorProfileをIDで取得bool OutPortBase::getConnectorProfileById(const char* id, ConnectorInfo& prof)
def	getConnectorProfileByName (self, name, prof)
	ConnectorProfileを名前で取得bool OutPortBase::getConnectorProfileByName(const char* name, ConnectorInfo& prof)
def	activateInterfaces (self)
	OutPortを activates するvoid OutPortBase::activateInterfaces()
def	deactivateInterfaces (self)
	全ての Port のインターフェースを deactivates するvoid OutPortBase::deactivateInterfaces()
def	addConnectorDataListener (self, listener_type, listener, autoclean=True)
	ConnectorDataListener リスナを追加する [詳解]
def	removeConnectorDataListener (self, listener_type, listener)
	ConnectorDataListener リスナを削除する [詳解]
def	addConnectorListener (self, callback_type, listener, autoclean=True)
	ConnectorListener リスナを追加する [詳解]
def	removeConnectorListener (self, callback_type, listener)
	ConnectorDataListener リスナを削除する [詳解]
def	configure (self)
	OutPortの設定を行うvoid OutPortBase::configure()
def	publishInterfaces (self, cprof)
	Interface情報を公開するReturnCode_t OutPortBase::publishInterfaces(ConnectorProfile& cprof)
def	subscribeInterfaces (self, cprof)
	Interface情報を取得するReturnCode_t OutPortBase::subscribeInterfaces(const ConnectorProfile& cprof)
def	unsubscribeInterfaces (self, connector_profile)
	登録されているInterface情報を解除するvoid OutPortBase::unsubscribeInterfaces(const ConnectorProfile& connector_profile)
def	initProviders (self)
	OutPort provider の初期化void OutPortBase::initProviders()
def	initConsumers (self)
	InPort consumer の初期化void OutPortBase::initConsumers()
def	createProvider (self, cprof, prop)
	OutPort provider の生成OutPortProvider* OutPortBase::createProvider(ConnectorProfile& cprof, coil::Properties& prop)
def	createConsumer (self, cprof, prop)
	InPort consumer の生成InPortConsumer* OutPortBase::createConsumer(const ConnectorProfile& cprof, coil::Properties& prop)
def	createConnector (self, cprof, prop, provider_=None, consumer_=None)
	OutPortPushConnector の生成OutPortConnector* OutPortBase::createConnector(const ConnectorProfile& cprof, coil::Properties& prop, InPortConsumer* consumer)
基底クラス 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 リターンコード [詳解]

詳解

OutPort クラス

OutPort 用クラス

から

0.2.0

構築子と解体子

def OpenRTM_aist.OutPort.OutPort.__init__	(		self,
			name,
			value,
			buffer = None
	)

コンストラクタ

コンストラクタ

引数

self
name	ポート名
value	このポートにバインドされるデータ変数
buffer_	バッファ

メソッド詳解

def OpenRTM_aist.OutPort.OutPort.getPortDataType

(

self

)

データ型名取得用メソッド

データの型名を取得するため、InPortCorbaProviderから呼ばれる。

引数

self

戻り値

バッファに設定されているデータの型名

def OpenRTM_aist.OutPort.OutPort.setOnWrite	(		self,
			on_write
	)

データ書き込み処理のブロックモードの設定

書き込み処理に対してブロックモードを設定する。 ブロックモードを指定した場合、バッファに書き込む領域ができるか タイムアウトが発生するまで write() メソッドの呼びだしがブロックされる。

引数

self
block	ブロックモードフラグ

def setWriteBlock(self, block): self._writeBlock = block

書き込み処理のタイムアウト時間の設定

write() のタイムアウト時間を usec で設定する。 write() はブロックモードでなければならない。

引数

self
timeout	タイムアウト時間 [usec]

def setWriteTimeout(self, timeout): self._writeTimeout = timeout

OnWrite コールバックの設定

データ書き込み直前に呼ばれる OnWrite コールバックファンクタを設定する。

引数

self
on_write	OnWrite コールバックファンクタ

def OpenRTM_aist.OutPort.OutPort.setOnWriteConvert	(		self,
			on_wconvert
	)

OnWriteConvert コールバックの設定

データ書き込み時に呼ばれる OnWriteConvert コールバックファンクタを設定 する。 このコールバック関数の処理結果が書き込まれる。 このため書き込みデータのフィルタリングが可能となる。

引数

self
on_wconvert	OnWriteConvert コールバックファンクタ

def OpenRTM_aist.OutPort.OutPort.write	(		self,
			value = None
	)

データ書き込み

ポートへデータを書き込む。

• コールバックファンクタ OnWrite がセットされている場合、 OutPort が保持するバッファに書き込む前に OnWrite が呼ばれる。
• OutPort が保持するバッファがオーバーフローを検出できるバッファであり、 かつ、書き込む際にバッファがオーバーフローを検出した場合、 コールバックファンクタ OnOverflow が呼ばれる。
• コールバックファンクタ OnWriteConvert がセットされている場合、 バッファ書き込み時に、 OnWriteConvert の operator() の戻り値が バッファに書き込まれる。

引数

self
value	書き込み対象データ

戻り値

書き込み処理結果(書き込み成功:true、書き込み失敗:false)

virtual bool write(const DataType& value)

データ書き込み

ポートへデータを書き込む。 設定された値をポートに書き込む。

引数

self
value	書き込み対象データ

戻り値

書き込み処理結果(書き込み成功:true、書き込み失敗:false)

bool operator<<(DataType& value)

---

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

• /tmp/workspace/03_openrtm-python-build-tags/OpenRTM_aist/OutPort.py