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

OutPortConnector 基底クラス [詳解]

#include <OutPortConnector.h>

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

公開メンバ関数

DATAPORTSTATUS_ENUM OutPortConnector (ConnectorInfo &info, ConnectorListeners &listeners)
 コンストラクタ [詳解]
 
virtual ~OutPortConnector ()
 デストラクタ [詳解]
 
const ConnectorInfo & profile ()
 Profile 取得 [詳解]
 
const char * id ()
 Connector ID 取得 [詳解]
 
const char * name ()
 Connector 名取得 [詳解]
 
virtual ReturnCode disconnect ()=0
 接続解除関数 [詳解]
 
virtual CdrBufferBase * getBuffer ()=0
 Buffer を取得する [詳解]
 
virtual ReturnCode write (cdrMemoryStream &data)=0
 write 関数 [詳解]
 
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 void activate ()=0
 アクティブ化 [詳解]
 
virtual void deactivate ()=0
 非アクティブ化 [詳解]
 

限定公開変数類

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
 

その他の継承メンバ

- 基底クラス 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 リターンコードを文字列に変換 [詳解]
 

詳解

OutPortConnector 基底クラス

OutPort の Push/Pull 各種 Connector を派生させるための 基底クラス。

から
1.0.0

構築子と解体子

DATAPORTSTATUS_ENUM RTC::OutPortConnector::OutPortConnector ( ConnectorInfo &  info,
ConnectorListeners &  listeners 
)

コンストラクタ

virtual RTC::OutPortConnector::~OutPortConnector ( )
virtual

デストラクタ

関数詳解

virtual ReturnCode RTC::OutPortConnector::disconnect ( )
pure virtual

接続解除関数

Connector が保持している接続を解除する

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

RTC::OutPortPushConnector, RTC::OutPortPullConnectorで実装されています。

virtual CdrBufferBase* RTC::OutPortConnector::getBuffer ( )
pure virtual

Buffer を取得する

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

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

RTC::OutPortPushConnector, RTC::OutPortPullConnectorで実装されています。

const char* RTC::OutPortConnector::id ( )
virtual

Connector ID 取得

Connector ID を取得する

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

virtual bool RTC::OutPortConnector::isLittleEndian ( )
virtual

endian 設定を返す

endian 設定のbool値を返す。

戻り値
m_littleEndian がlittleの場合true、bigの場合false を返す。

参照元 write().

const char* RTC::OutPortConnector::name ( )
virtual

Connector 名取得

Connector 名を取得する

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

const ConnectorInfo& RTC::OutPortConnector::profile ( )
virtual

Profile 取得

Connector Profile を取得する

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

virtual bool RTC::OutPortConnector::pullDirectMode ( )
virtual

ダイレクト接続モードかの判定

戻り値
True：ダイレクト接続モード,false：それ以外

参照元 write().

virtual void RTC::OutPortConnector::setEndian ( const bool  endian_type)
virtual

endianタイプ設定

endianタイプを設定する

bool RTC::OutPortConnector::setInPort ( InPortBase *  directInPort)

参照元 write().

virtual void RTC::OutPortConnector::setPullDirectMode ( )
virtual

ダイレクト接続モードに設定

参照元 write().

virtual ReturnCode RTC::OutPortConnector::write ( cdrMemoryStream &  data)
pure virtual

write 関数

OutPort からデータを Buffer へ write する関数

RTC::OutPortPushConnector, RTC::OutPortPullConnectorで実装されています。

参照元 write().

template<class DataType >
ReturnCode RTC::OutPortConnector::write ( DataType &  data)
inline

データ型の変換テンプレート

Timed* から CdrMemoryStream に変換する。

参照先 RTC::PortBase::getDirectPort(), isLittleEndian(), RTC::DirectInPortBase< DataType >::isNew(), m_cdr, m_directInPort, m_inPortListeners, m_listeners, m_profile, RTC::ON_BUFFER_OVERWRITE, RTC::ON_BUFFER_WRITE, RTC::ON_RECEIVED, RTC::ON_RECEIVER_FULL, RTC::DataPortStatus::PORT_OK, pullDirectMode(), RTC_PARANOID, RTC_TRACE, setInPort(), setPullDirectMode(), RTC::DirectInPortBase< DataType >::write(), write() (計20項目).

メンバ詳解

cdrMemoryStream RTC::OutPortConnector::m_cdr
protected

cdrストリーム

参照元 write().

PortBase* RTC::OutPortConnector::m_directInPort
protected

同一プロセス上のピアInPortのポインタ

参照元 write().

bool RTC::OutPortConnector::m_directMode
protected
ConnectorListeners* RTC::OutPortConnector::m_inPortListeners
protected

InPort 側の ConnectorListenrs への参照

参照元 write().

ConnectorListeners& RTC::OutPortConnector::m_listeners
protected

ConnectorListenrs への参照

参照元 write().

bool RTC::OutPortConnector::m_littleEndian
protected

接続エンディアン

ConnectorInfo RTC::OutPortConnector::m_profile
protected

Port の PortProfile.

参照元 write().

Logger RTC::OutPortConnector::rtclog
protected

ロガーストリーム

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