OpenRTM-aist 2.0.2
読み取り中…
検索中…
一致する文字列を見つけられません
公開メンバ関数 | 限定公開変数類 | 全メンバ一覧
RTC::OutPortConnector クラスabstract

OutPortConnector 基底クラス [詳解]

#include <OutPortConnector.h>

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

公開メンバ関数

 OutPortConnector (ConnectorInfo &info, ConnectorListenersBase *listeners)
 コンストラクタ
 
 ~OutPortConnector () override
 デストラクタ
 
const ConnectorInfo & profile () override
 Profile 取得
 
const char * id () override
 Connector ID 取得
 
const char * name () override
 Connector 名取得
 
DataPortStatus disconnect () override=0
 接続解除関数
 
CdrBufferBase * getBuffer () override=0
 Buffer を取得する
 
virtual DataPortStatus write (ByteDataStreamBase *data)=0
 write 関数
 
virtual void setEndian (bool endian_type)
 endianタイプ設定
 
virtual bool isLittleEndian ()
 endian 設定を返す
 
template<class DataType >
DataPortStatus write (DataType &data)
 データ型の変換テンプレート
 
virtual BufferStatus read (ByteData &data)
 
bool setInPort (InPortBase *directInPort)
 
virtual void setPullDirectMode ()
 ダイレクト接続モードに設定
 
virtual bool pullDirectMode ()
 ダイレクト接続モードかの判定
 
virtual void unsubscribeInterface (const coil::Properties &prop)
 コンシューマのインターフェースの登録を取り消す
 
- 基底クラス RTC::ConnectorBase に属する継承公開メンバ関数
virtual ~ConnectorBase ()=default
 デストラクタ
 
virtual void activate ()=0
 アクティブ化
 
virtual void deactivate ()=0
 非アクティブ化
 

限定公開変数類

Logger rtclog
 ロガーストリーム
 
ConnectorInfo m_profile
 Port の PortProfile
 
bool m_littleEndian
 接続エンディアン
 
PortBase * m_directInPort
 同一プロセス上のピアInPortのポインタ
 
ConnectorListenersBase * m_listeners
 ConnectorListenrs への参照
 
ConnectorListenersBase * m_inPortListeners
 InPort 側の ConnectorListenrs への参照
 
bool m_directMode
 ダイレクト接続のフラグ Trueでダイレクト接続モード
 
std::string m_marshaling_type
 シリアライザの名前
 
ByteDataStreamBase * m_cdr
 

詳解

OutPortConnector 基底クラス

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

から
1.0.0

構築子と解体子

◆ OutPortConnector()

RTC::OutPortConnector::OutPortConnector ( ConnectorInfo & info,
ConnectorListenersBase * listeners )

コンストラクタ

◆ ~OutPortConnector()

RTC::OutPortConnector::~OutPortConnector ( )
override

デストラクタ

関数詳解

◆ disconnect()

DataPortStatus RTC::OutPortConnector::disconnect ( )
overridepure virtual

接続解除関数

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

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

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

◆ getBuffer()

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

Buffer を取得する

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

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

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

◆ id()

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

Connector ID 取得

Connector ID を取得する

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

◆ isLittleEndian()

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

endian 設定を返す

endian 設定のbool値を返す。

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

参照元 write().

◆ name()

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

Connector 名取得

Connector 名を取得する

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

◆ profile()

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

Profile 取得

Connector Profile を取得する

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

◆ pullDirectMode()

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

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

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

◆ read()

virtual BufferStatus RTC::OutPortConnector::read ( ByteData & data)
virtual

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

◆ setEndian()

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

endianタイプ設定

endianタイプを設定する

◆ setInPort()

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

◆ setPullDirectMode()

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

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

◆ unsubscribeInterface()

virtual void RTC::OutPortConnector::unsubscribeInterface ( const coil::Properties & prop)
virtual

コンシューマのインターフェースの登録を取り消す

引数
propコネクタプロファイルのプロパティ

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

◆ write() [1/2]

virtual DataPortStatus RTC::OutPortConnector::write ( ByteDataStreamBase * data)
pure virtual

write 関数

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

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

参照元 write().

◆ write() [2/2]

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

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

Timed* から CdrMemoryStream に変換する。

参照先 RTC::createSerializer(), RTC::PortBase::getDirectPort(), RTC::ByteDataStreamBase::isLittleEndian(), isLittleEndian(), RTC::DirectInPortBase< DataType >::isNew(), m_cdr, m_directInPort, m_inPortListeners, m_listeners, m_marshaling_type, m_profile, RTC::ConnectorListenersBase::notifyIn(), RTC::ConnectorListenersBase::notifyOut(), RTC::ON_BUFFER_OVERWRITE, RTC::ON_BUFFER_WRITE, RTC::ON_RECEIVED, RTC::ON_RECEIVER_FULL, RTC::PORT_ERROR, RTC::PORT_OK, RTC_ERROR, RTC_PARANOID, RTC_TRACE, RTC::ByteDataStream< DataType >::serialize(), RTC::DirectInPortBase< DataType >::write(), write() (計25項目).

メンバ詳解

◆ m_cdr

ByteDataStreamBase* RTC::OutPortConnector::m_cdr
protected

参照元 write().

◆ m_directInPort

PortBase* RTC::OutPortConnector::m_directInPort
protected

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

参照元 write().

◆ m_directMode

bool RTC::OutPortConnector::m_directMode
protected

ダイレクト接続のフラグ Trueでダイレクト接続モード

◆ m_inPortListeners

ConnectorListenersBase* RTC::OutPortConnector::m_inPortListeners
protected

InPort 側の ConnectorListenrs への参照

参照元 write().

◆ m_listeners

ConnectorListenersBase* RTC::OutPortConnector::m_listeners
protected

ConnectorListenrs への参照

参照元 write().

◆ m_littleEndian

bool RTC::OutPortConnector::m_littleEndian
protected

接続エンディアン

◆ m_marshaling_type

std::string RTC::OutPortConnector::m_marshaling_type
protected

シリアライザの名前

参照元 write().

◆ m_profile

ConnectorInfo RTC::OutPortConnector::m_profile
protected

Port の PortProfile

参照元 write().

◆ rtclog

Logger RTC::OutPortConnector::rtclog
protected

ロガーストリーム

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