OpenRTM-aist-Python 1.1.2
クラス | 公開メンバ関数 | 全メンバ一覧
OpenRTM_aist.OutPort.OutPort クラス

OutPort クラス [詳解]

OpenRTM_aist.OutPort.OutPort の継承関係図
OpenRTM_aist.OutPortBase.OutPortBase OpenRTM_aist.PortBase.PortBase OpenRTM_aist.DataPortStatus.DataPortStatus

クラス

class  subscribe
 

公開メンバ関数

def __init__
 コンストラクタ [詳解]
 
def write
 データ書き込み [詳解]
 
def setOnWrite
 データ書き込み処理のブロックモードの設定 [詳解]
 
def setOnWriteConvert
 OnWriteConvert コールバックの設定 [詳解]
 
def getPortDataType
 データ型名取得用メソッド [詳解]
 
- 基底クラス OpenRTM_aist.OutPortBase.OutPortBase に属する継承公開メンバ関数
def __init__
 コンストラクタ [詳解]
 
def __del__
 デストラクタ [詳解]
 
def init
 プロパティの初期化 [詳解]
 
def write
 データ書き込み [詳解]
 
def connect
 [CORBA interface] Port の接続を行う [詳解]
 
def properties
 プロパティを取得する [詳解]
 
def connectors
 Connector を取得const std::vector<OutPortConnector*>& OutPortBase::connectors()
 
def getConnectorProfiles
 ConnectorProfile を取得ConnectorBase::ConnectorInfoList OutPortBase::getConnectorProfiles()
 
def getConnectorIds
 ConnectorId を取得coil::vstring OutPortBase::getConnectorIds()
 
def getConnectorNames
 Connectorの名前を取得coil::vstring OutPortBase::getConnectorNames()
 
def getConnectorById
 ConnectorProfileをIDで取得 [詳解]
 
def getConnectorByName
 ConnectorProfileを名前で取得 [詳解]
 
def getConnectorProfileById
 ConnectorProfileをIDで取得bool OutPortBase::getConnectorProfileById(const char* id, ConnectorInfo& prof)
 
def getConnectorProfileByName
 ConnectorProfileを名前で取得bool OutPortBase::getConnectorProfileByName(const char* name, ConnectorInfo& prof)
 
def activateInterfaces
 OutPortを activates するvoid OutPortBase::activateInterfaces()
 
def deactivateInterfaces
 全ての Port のインターフェースを deactivates するvoid OutPortBase::deactivateInterfaces()
 
def addConnectorDataListener
 ConnectorDataListener リスナを追加する [詳解]
 
def removeConnectorDataListener
 ConnectorDataListener リスナを削除する [詳解]
 
def addConnectorListener
 ConnectorListener リスナを追加する [詳解]
 
def removeConnectorListener
 ConnectorDataListener リスナを削除する [詳解]
 
def configure
 OutPortの設定を行うvoid OutPortBase::configure()
 
def publishInterfaces
 Interface情報を公開するReturnCode_t OutPortBase::publishInterfaces(ConnectorProfile& cprof)
 
def subscribeInterfaces
 Interface情報を取得するReturnCode_t OutPortBase::subscribeInterfaces(const ConnectorProfile& cprof)
 
def unsubscribeInterfaces
 登録されているInterface情報を解除するvoid OutPortBase::unsubscribeInterfaces(const ConnectorProfile& connector_profile)
 
def initProviders
 OutPort provider の初期化void OutPortBase::initProviders()
 
def initConsumers
 InPort consumer の初期化void OutPortBase::initConsumers()
 
def createProvider
 OutPort provider の生成OutPortProvider* OutPortBase::createProvider(ConnectorProfile& cprof, coil::Properties& prop)
 
def createConsumer
 InPort consumer の生成InPortConsumer* OutPortBase::createConsumer(const ConnectorProfile& cprof, coil::Properties& prop)
 
def createConnector
 OutPortPushConnector の生成OutPortConnector* OutPortBase::createConnector(const ConnectorProfile& cprof, coil::Properties& prop, InPortConsumer* consumer)
 
- 基底クラス OpenRTM_aist.PortBase.PortBase に属する継承公開メンバ関数
def __init__
 コンストラクタ [詳解]
 
def __del__
 デストラクタ [詳解]
 
def get_port_profile
 [CORBA interface] PortProfileを取得する [詳解]
 
def getPortProfile
 PortProfile を取得する。 [詳解]
 
def get_connector_profiles
 [CORBA interface] ConnectorProfileListを取得する [詳解]
 
def get_connector_profile
 [CORBA interface] ConnectorProfile を取得する [詳解]
 
def connect
 [CORBA interface] Port の接続を行う [詳解]
 
def notify_connect
 [CORBA interface] Port の接続通知を行う [詳解]
 
def disconnect
 [CORBA interface] Port の接続を解除する [詳解]
 
def notify_disconnect
 [CORBA interface] Port の接続解除通知を行う [詳解]
 
def disconnect_all
 [CORBA interface] Port の全接続を解除する [詳解]
 
def setName
 Port の名前を設定する [詳解]
 
def getName
 Port の名前を取得するconst char* PortBase::getName() const.
 
def getProfile
 PortProfileを取得する [詳解]
 
def setPortRef
 Port のオブジェクト参照を設定する [詳解]
 
def getPortRef
 Port のオブジェクト参照を取得する [詳解]
 
def setOwner
 Port の owner の RTObject を指定する [詳解]
 
def setOnPublishInterfaces
 インターフェースを公開する際に呼ばれるコールバックをセットする [詳解]
 
def setOnSubscribeInterfaces
 インターフェースを取得する際に呼ばれるコールバックをセットする [詳解]
 
def setOnConnected
 接続完了時に呼ばれるコールバックをセットする [詳解]
 
def setOnUnsubscribeInterfaces
 インターフェースを解放する際に呼ばれるコールバックをセットする [詳解]
 
def setOnDisconnected
 接続解除に呼ばれるコールバックをセットする [詳解]
 
def setPortConnectListenerHolder
 PortConnectListeners のホルダをセットする [詳解]
 
def publishInterfaces
 Interface 情報を公開する(サブクラス実装用) [詳解]
 
def connectNext
 次の Port に対して notify_connect() をコールする [詳解]
 
def disconnectNext
 次の Port に対して notify_disconnect() をコールする [詳解]
 
def subscribeInterfaces
 Interface 情報を取得する(サブクラス実装用) [詳解]
 
def unsubscribeInterfaces
 Interface の接続を解除する(サブクラス実装用) [詳解]
 
def setConnectionLimit
 接続の最大数を設定する。 [詳解]
 
def isEmptyId
 ConnectorProfile の connector_id フィールドが空かどうか判定 [詳解]
 
def getUUID
 UUIDを生成する [詳解]
 
def setUUID
 UUIDを生成し ConnectorProfile にセットする [詳解]
 
def isExistingConnId
 id が既存の ConnectorProfile のものかどうか判定する [詳解]
 
def findConnProfile
 id を持つ ConnectorProfile を探す [詳解]
 
def findConnProfileIndex
 id を持つ ConnectorProfile を探す [詳解]
 
def updateConnectorProfile
 ConnectorProfile の追加もしくは更新 [詳解]
 
def eraseConnectorProfile
 ConnectorProfile を削除する [詳解]
 
def appendInterface
 PortInterfaceProfile に インターフェースを登録する [詳解]
 
def deleteInterface
 PortInterfaceProfile からインターフェース登録を削除する [詳解]
 
def addProperty
 PortProfile の properties に NameValue 値を追加する [詳解]
 
def appendProperty
 PortProfile の properties に NameValue 値を要素に追加する [詳解]
 
def updateConnectors
 存在しないポートをdisconnectする。 [詳解]
 
def checkPorts
 ポートの存在を確認する。 [詳解]
 
- 基底クラス OpenRTM_aist.DataPortStatus.DataPortStatus に属する継承公開メンバ関数
def toString
 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_writeOnWrite コールバックファンクタ
def OpenRTM_aist.OutPort.OutPort.setOnWriteConvert (   self,
  on_wconvert 
)

OnWriteConvert コールバックの設定

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

引数
self
on_wconvertOnWriteConvert コールバックファンクタ
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)


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