パッケージ jp.go.aist.rtm.RTC.port

インタフェースの概要
ConnectionCallback callback functor base classes ConnectCallback Callback interface for connect/notify_connect() funcs This is the interface for callback functor for connect/notify_connect() invocation in Port.
InPortConsumer 入力ポートコンシューマが提供すべき機能のインタフェースです。
InPortProvider InPortに対して何を提供しているかを宣言するインタフェースです。
OnConnect  
OnDisconnect  
OnOverflow<DataType> InPort/OutPortのバッファにデータが書き込まれる際、 バッファオーバフローによりバッファへの書き込みが行えない場合に 呼び出されるコールバックメソッド
OnRead<DataType> InPort/OutPortのバッファからデータが読み出される直前に呼び出される コールバックインタフェースです。
OnReadConvert<DataType> InPort/OutPortのバッファからデータが読み出される際に呼び出されるコールバックインタフェースです。
OnReadTimeout<DataType> InPort/OutPortのバッファからデータが読み出される直前に呼び出される コールバックインタフェースです。
OnUnderflow<DataType> InPort/OutPortのバッファからデータが読み出される際、 読み出すべきデータがない場合に 呼び出されるコールバックインタフェース 本コールバックの戻り値が読み出しの代替データとして 使用されるため、データアンダーフロー時のデフォルト読み出し値を与える フィルタとして機能する。
OnWrite<DataType> InPort/OutPortのバッファにデータが書き込まれる直前に呼び出される コールバックインタフェース
OnWriteConvert<DataType> InPort/OutPortのバッファにデータが書き込まれる際に呼び出されるコールバックインタフェースです。
OnWriteTimeout<DataType> InPort/OutPortのバッファにデータが書き込まれる直前に呼び出されるコールバックインタフェースです。
OutPortConsumer 出力ポートコンシューマが提供すべき機能のインタフェースです。
OutPortProvider OutPortに対して何を提供しているかを宣言するインタフェースです。
 

クラスの概要
ConnectorBase Connector 基底クラス InPort/OutPort, Push/Pull 各種 Connector を派生させるための 基底クラス。
ConnectorBase.ConnectorInfo ConnectorInfo local representation of Connector profile ConnectorProfile struct for ConnectorBase and its subclasses.
ConnectorBase.ConnectorInfoHolder ConnectorInfoHoldedr
ConnectorDataListener ConnectorDataListener クラス データポートの Connector において発生する各種イベントに対するコー ルバックを実現するリスナクラスの基底クラス。
ConnectorDataListenerArgument ConnectorDataListener クラス
ConnectorDataListenerHolder ConnectorDataListener holder class This class manages one ore more instances of ConnectorDataListener class.
ConnectorDataListenerT<DataType> ConnectorDataListenerTクラス データポートの Connector において発生する各種イベントに対するコー ルバックを実現するリスナクラスの基底クラス。
ConnectorDataListenerType ConnectorDataListener のタイプ
  • ON_BUFFER_WRITE: バッファ書き込み時
  • ON_BUFFER_FULL: バッファフル時
  • ON_BUFFER_WRITE_TIMEOUT: バッファ書き込みタイムアウト時
  • ON_BUFFER_OVERWRITE: バッファ上書き時
  • ON_BUFFER_READ: バッファ読み出し時
  • ON_SEND: InProtへの送信時
  • ON_RECEIVED: InProtへの送信完了時
  • ON_RECEIVER_FULL: InProt側バッファフル時
  • ON_RECEIVER_TIMEOUT: InProt側バッファタイムアウト時
  • ON_RECEIVER_ERROR: InProt側エラー時
ConnectorListener  
ConnectorListenerHolder ConnectorListener holder class This class manages one ore more instances of ConnectorListener class.
ConnectorListeners  
ConnectorListenerType ConnectorListener のタイプ
  • ON_BUFFER_EMPTY: バッファが空の場合
  • ON_BUFFER_READTIMEOUT: バッファが空でタイムアウトした場合
  • ON_SENDER_EMPTY: OutPort側バッファが空
  • ON_SENDER_TIMEOUT: OutPort側タイムアウト時
  • ON_SENDER_ERROR: OutPort側エラー時
  • ON_CONNECT: 接続確立時
  • ON_DISCONNECT: 接続切断時
CorbaConsumer<OBJECT_TYPE> CORBAを通信手段とするコンシューマの実装クラスです。
CorbaConsumerBase CORBAを通信手段とするコンシューマ実装のためのベースクラスです。
CorbaPort CORBAを通信手段とするPortクラスです。
InPort<DataType> 入力ポートのためのベース実装クラスです。
InPortBase InPort 用 Port
InPortConnector InPortConnector 基底クラス InPort の Push/Pull 各種 Connector を派生させるための基底クラス。
InPortCorbaCdrConsumer InPortCorbaCdrConsumer クラス データ転送に CORBA の OpenRTM::InPortCdr インターフェースを利用し た、push 型データフロー型を実現する InPort コンシューマクラス。
InPortCorbaCdrProvider InPortCorbaCdrProvider クラス データ転送に CORBA の OpenRTM::InPortCdr インターフェースを利用し た、push 型データフロー型を実現する InPort プロバイダクラス。
InPortPullConnector InPortPullConnector クラス {@.ja InPort の pull 型データフローのための Connector クラス。
InPortPushConnector  
InPortTcpSockConsumer<DataType> 通信手段に TCP ソケットを利用した入力ポートコンシューマの実装クラスです。
OutPort<DataType> 出力ポートの実装。
OutPortBase 出力ポートのベース実装クラス Publisherの登録やPublisherへのデータ更新通知などの実装を提供する。
OutPortConnector OutPortConnector 基底クラス OutPort の Push/Pull 各種 Connector を派生させるための 基底クラス。
OutPortCorbaCdrConsumer OutPortCorbaCdrConsumer クラス データ転送に CORBA の OpenRTM::OutPortCdr インターフェースを利用し た、pull 型データフロー型を実現する OutPort コンシューマクラス。
OutPortCorbaCdrProvider OutPortCorbaCdrProvider クラス データ転送に CORBA の OpenRTM::OutPortCdr インターフェースを利用し た、pull 型データフロー型を実現する OutPort プロバイダクラス。
OutPortPullConnector OutPortPullConnector クラス {@.ja OutPort の pull 型データフローのための Connector クラス。
OutPortPushConnector  
PortAdmin Portの管理を行うクラスです。
PortBase Port の基底クラス {@.ja RTC::Port の基底となるクラス。
 

列挙型の概要
ReturnCode DataPortStatus リターンコード {@.ja データポート関連のクラスで共通のリターンコード PORT_OK: 正常終了 PORT_ERROR: 異常終了 BUFFER_ERROR: バッファエラー BUFFER_FULL: バッファフル BUFFER_EMPTY: バッファエンプティ BUFFER_TIMEOUT: バッファタイムアウト SEND_FULL: データを送ったが相手側がバッファフル状態 SEND_TIMEOUT: データを送ったが相手側がタイムアウトした RECV_EMPTY: データを受信しようとしたがデータが空状態 RECV_TIMEOUT: データを受信しようとしたがタイムうとした INVALID_ARGS: 不正な引数 PRECONDITION_NOT_MET: 事前条件を満たしていない CONNECTION_LOST: 接続が切断された UNKNOWN_ERROR: 不明なエラー データポートのデータ経路上のエラー発生個所から呼び出し側へエラー 情報を伝えるためにこのエラーコードを使用する。