OpenRTM-aist  1.2.1
公開メンバ関数 | 限定公開メンバ関数 | 全メンバ一覧
RTC::OutPortPushConnector クラス

OutPortPushConnector クラス [詳解]

#include <OutPortPushConnector.h>

RTC::OutPortPushConnector の継承関係図
Inheritance graph
[凡例]
RTC::OutPortPushConnector 連携図
Collaboration graph
[凡例]

公開メンバ関数

DATAPORTSTATUS_ENUM OutPortPushConnector (ConnectorInfo info, InPortConsumer *consumer, ConnectorListeners &listeners, CdrBufferBase *buffer=0)
 コンストラクタ [詳解]
 
virtual ~OutPortPushConnector ()
 デストラクタ [詳解]
 
virtual ReturnCode write (cdrMemoryStream &data)
 データの書き込み [詳解]
 
virtual ReturnCode disconnect ()
 接続解除 [詳解]
 
virtual void activate ()
 アクティブ化 [詳解]
 
virtual void deactivate ()
 非アクティブ化 [詳解]
 
virtual CdrBufferBase * getBuffer ()
 Buffer を取得する [詳解]
 
- 基底クラス RTC::OutPortConnector に属する継承公開メンバ関数
DATAPORTSTATUS_ENUM OutPortConnector (ConnectorInfo &info, ConnectorListeners &listeners)
 コンストラクタ [詳解]
 
virtual ~OutPortConnector ()
 デストラクタ [詳解]
 
const ConnectorInfo & profile ()
 Profile 取得 [詳解]
 
const char * id ()
 Connector ID 取得 [詳解]
 
const char * name ()
 Connector 名取得 [詳解]
 
virtual void setEndian (const bool endian_type)
 endianタイプ設定 [詳解]
 
virtual bool isLittleEndian ()
 endian 設定を返す [詳解]
 
template<class DataType >
ReturnCode write (DataType &data)
 データ型の変換テンプレート [詳解]
 
bool setInPort (InPortBase *directInPort)
 
virtual void setPullDirectMode ()
 ダイレクト接続モードに設定 [詳解]
 
virtual bool pullDirectMode ()
 ダイレクト接続モードかの判定 [詳解]
 
- 基底クラス RTC::ConnectorBase に属する継承公開メンバ関数
virtual ~ConnectorBase ()
 デストラクタ [詳解]
 

限定公開メンバ関数

virtual PublisherBase * createPublisher (ConnectorInfo &info)
 Publisherの生成 [詳解]
 
virtual CdrBufferBase * createBuffer (ConnectorInfo &info)
 Bufferの生成 [詳解]
 
void onConnect ()
 接続確立時にコールバックを呼ぶ [詳解]
 
void onDisconnect ()
 接続切断時にコールバックを呼ぶ [詳解]
 

その他の継承メンバ

- 基底クラス RTC::DataPortStatus に属する継承公開型
enum  Enum {
  PORT_OK = 0, 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
}
 
- 基底クラス RTC::DataPortStatus に属する継承静的公開メンバ関数
static const char * toString (DataPortStatus::Enum status)
 DataPortStatus リターンコードを文字列に変換 [詳解]
 
- 基底クラス RTC::OutPortConnector に属する継承限定公開変数類
Logger rtclog
 ロガーストリーム [詳解]
 
ConnectorInfo m_profile
 Port の PortProfile. [詳解]
 
bool m_littleEndian
 接続エンディアン [詳解]
 
cdrMemoryStream m_cdr
 cdrストリーム [詳解]
 
PortBase * m_directInPort
 同一プロセス上のピアInPortのポインタ [詳解]
 
ConnectorListeners & m_listeners
 ConnectorListenrs への参照 [詳解]
 
ConnectorListeners * m_inPortListeners
 InPort 側の ConnectorListenrs への参照 [詳解]
 
bool m_directMode
 

詳解

OutPortPushConnector クラス

OutPort の push 型データフローのための Connector クラス。このオブ ジェクトは、接続時に dataflow_type に push が指定された場合、 OutPort によって生成・所有され、InPortPushConnector と対になって、 データポートの push 型のデータフローを実現する。一つの接続に対して、 一つのデータストリームを提供する唯一の Connector が対応する。 Connector は 接続時に生成される UUID 形式の ID により区別される。

OutPortPushConnector は以下の三つのオブジェクトを所有し管理する。

OutPort に書き込まれたデータは OutPortPushConnector::write() に渡 され、Connector は Publisher にデータを書き込む。Publisher はその 特性に従ってデータを Buffer から取得し InPortConsumer に対して push することで InPort にデータが転送される。

から
1.0.0

構築子と解体子

DATAPORTSTATUS_ENUM RTC::OutPortPushConnector::OutPortPushConnector ( ConnectorInfo  info,
InPortConsumer *  consumer,
ConnectorListeners &  listeners,
CdrBufferBase *  buffer = 0 
)

コンストラクタ

OutPortPushConnector のコンストラクタはオブジェクト生成時に下記 を引数にとる。ConnectorInfo は接続情報を含み、この情報に従いパブ リッシャやバッファ等を生成する。InPort インターフェースに対する コンシューマオブジェクトへのポインタを取り、所有権を持つので、 OutPortPushConnector は InPortConsumer の解体責任を持つ。各種イ ベントに対するコールバック機構を提供する ConnectorListeners を持 ち、適切なタイミングでコールバックを呼び出す。データバッファがも し OutPortBase から提供される場合はそのポインタを取る。

引数
infoConnectorInfo
consumerInPortConsumer
listenersConnectorListeners 型のリスナオブジェクトリスト
bufferCdrBufferBase 型のバッファ
virtual RTC::OutPortPushConnector::~OutPortPushConnector ( )
virtual

デストラクタ

disconnect() が呼ばれ、consumer, publisher, buffer が解体・削除される。

関数詳解

virtual void RTC::OutPortPushConnector::activate ( )
virtual

アクティブ化

このコネクタをアクティブ化する

RTC::ConnectorBaseを実装しています。

virtual CdrBufferBase* RTC::OutPortPushConnector::createBuffer ( ConnectorInfo &  info)
protectedvirtual

Bufferの生成

与えられた接続情報に基づきバッファを生成する。

引数
info接続情報
戻り値
バッファへのポインタ
virtual PublisherBase* RTC::OutPortPushConnector::createPublisher ( ConnectorInfo &  info)
protectedvirtual

Publisherの生成

与えられた接続情報に基づきパブリッシャを生成する。

引数
info接続情報
戻り値
パブリッシャへのポインタ
virtual void RTC::OutPortPushConnector::deactivate ( )
virtual

非アクティブ化

このコネクタを非アクティブ化する

RTC::ConnectorBaseを実装しています。

virtual ReturnCode RTC::OutPortPushConnector::disconnect ( )
virtual

接続解除

consumer, publisher, buffer が解体・削除される。

RTC::OutPortConnectorを実装しています。

virtual CdrBufferBase* RTC::OutPortPushConnector::getBuffer ( )
virtual

Buffer を取得する

Connector が保持している Buffer を返す

RTC::OutPortConnectorを実装しています。

void RTC::OutPortPushConnector::onConnect ( )
protected

接続確立時にコールバックを呼ぶ

void RTC::OutPortPushConnector::onDisconnect ( )
protected

接続切断時にコールバックを呼ぶ

virtual ReturnCode RTC::OutPortPushConnector::write ( cdrMemoryStream &  data)
virtual

データの書き込み

Publisherに対してデータを書き込み、これにより対応するInPortへデー タが転送される。正常終了した場合 PORT_OK が返される。それ以外の 場合、エラー値として、CONNECTION_LOST, BUFFER_FULL, BUFFER_ERROR, PORT_ERROR, BUFFER_TIMEOUT, PRECONDITION_NO_MET が 返される。

戻り値
PORT_OK 正常終了 CONNECTION_LOST 接続がロストした BUFFER_FULL バッファが一杯である BUFFER_ERROR バッファエラー BUFFER_TIMEOUT バッファへの書き込みがタイムアウトした PRECONDITION_NOT_MET 事前条件を満たさない PORT_ERROR その他のエラー

RTC::OutPortConnectorを実装しています。

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