RTC::OutPort< DataType > クラステンプレート

OutPort テンプレートクラス [詳解]

#include <OutPort.h>

RTC::OutPort< DataType > の継承関係図

RTC::OutPort< DataType > 連携図

公開メンバ関数
	OutPort (const char *name, DataType &value)
	コンストラクタ
	~OutPort () override
	デストラクタ
virtual bool	write (DataType &value)
	データ書き込み
bool	write () override
	データ書き込み
bool	operator<< (DataType &value)
	データ書き込み
DataPortStatus	getStatus (int index)
	特定のコネクタへの書き込みステータスを得る
DataPortStatusList	getStatusList ()
	特定のコネクタへの書き込みステータスリストを得る
void	setOnWrite (OnWrite< DataType > *on_write)
	OnWrite コールバックの設定
void	setOnWriteConvert (OnWriteConvert< DataType > *on_wconvert)
	OnWriteConvert コールバックの設定
void	read (DataType &data) override
	データをダイレクトに読み込む
bool	isEmpty () override
	新規データが無いことを確認
bool	isNew () override
	新規データの存在確認
基底クラス RTC::OutPortBase に属する継承公開メンバ関数
	OutPortBase (const char *name, const char *data_type)
	コンストラクタ
	~OutPortBase () override
	デストラクタ
void	init (coil::Properties &prop)
	プロパティの初期化
coil::Properties &	properties ()
	プロパティを取得する
const std::vector< OutPortConnector * > &	connectors ()
	Connector を取得
ConnectorInfoList	getConnectorProfiles ()
	ConnectorProfile を取得
coil::vstring	getConnectorIds ()
	ConnectorId を取得
coil::vstring	getConnectorNames ()
	Connectorの名前を取得
OutPortConnector *	getConnectorById (const char *id)
	ConnectorProfileをIDで取得
OutPortConnector *	getConnectorByName (const char *name)
	ConnectorProfileを名前で取得
bool	getConnectorProfileById (const char *id, ConnectorInfo &prof)
	ConnectorProfileをIDで取得
bool	getConnectorProfileByName (const char *name, ConnectorInfo &prof)
	ConnectorProfileを名前で取得
void	activateInterfaces () override
	全ての Port のインターフェースを activate する
void	deactivateInterfaces () override
	全ての Port のインターフェースを deactivate する
void	addConnectorDataListener (ConnectorDataListenerType type, ConnectorDataListener *listener, bool autoclean=true)
	ConnectorDataListener リスナを追加する
void	removeConnectorDataListener (ConnectorDataListenerType type, ConnectorDataListener *listener)
	ConnectorDataListener リスナを削除する
void	addConnectorListener (ConnectorListenerType type, ConnectorListener *listener, bool autoclean=true)
	ConnectorListener リスナを追加する
void	removeConnectorListener (ConnectorListenerType type, ConnectorListener *listener)
	ConnectorDataListener リスナを削除する
bool	isLittleEndian ()
	endian 設定を返す
ReturnCode_t	connect (ConnectorProfile &connector_profile) override
	[CORBA interface] Port の接続を行う
virtual ConnectorListenersBase *	getListeners ()
	リスナホルダを取得する
基底クラス RTC::PortBase に属する継承公開メンバ関数
	PortBase (const char *name="")
	コンストラクタ
	~PortBase () override
	デストラクタ
PortProfile *	get_port_profile () override
	[CORBA interface] PortProfileを取得する
const PortProfile &	getPortProfile () const
	PortProfile を取得する。
ConnectorProfileList *	get_connector_profiles () override
	[CORBA interface] ConnectorProfileListを取得する
ConnectorProfile *	get_connector_profile (const char *connector_id) override
	[CORBA interface] ConnectorProfile を取得する
ReturnCode_t	connect (ConnectorProfile &connector_profile) override
	[CORBA interface] Port の接続を行う
ReturnCode_t	notify_connect (ConnectorProfile &connector_profile) override
	[CORBA interface] Port の接続通知を行う
ReturnCode_t	disconnect (const char *connector_id) override
	[CORBA interface] Port の接続を解除する
ReturnCode_t	notify_disconnect (const char *connector_id) override
	[CORBA interface] Port の接続解除通知を行う
ReturnCode_t	disconnect_all () override
	[CORBA interface] Port の全接続を解除する
void	setName (const char *name)
	Port の名前を設定する
const char *	getName () const
	Port の名前を取得する
const PortProfile &	getProfile () const
	PortProfileを取得する
void	setPortRef (PortService_ptr port_ref)
	Port のオブジェクト参照を設定する
PortService_ptr	getPortRef () const
	Port のオブジェクト参照を取得する
void	setOwner (RTObject_ptr owner)
	Port の owner の RTObject を指定する
void	setOnPublishInterfaces (ConnectionCallback *on_publish)
	インターフェースを公開する際に呼ばれるコールバックをセットする
void	setOnSubscribeInterfaces (ConnectionCallback *on_subscribe)
	インターフェースを取得する際に呼ばれるコールバックをセットする
void	setOnConnected (ConnectionCallback *on_connected)
	接続完了時に呼ばれるコールバックをセットする
void	setOnUnsubscribeInterfaces (ConnectionCallback *on_unsubscribe)
	インターフェースを解放する際に呼ばれるコールバックをセットする
void	setOnDisconnected (ConnectionCallback *on_disconnected)
	接続解除に呼ばれるコールバックをセットする
void	setOnConnectionLost (ConnectionCallback *on_connection_lost)
	ポートの接続がロストした場合に呼び出されるコールバックをセットする
void	setPortConnectListenerHolder (PortConnectListeners *portconnListeners)
	PortConnectListeners のホルダをセットする
virtual DirectPortBase *	getDirectPort ()
	direct通信用ポートオブジェクト取得

限定公開メンバ関数
void	initConnectorListeners () override
	コネクタリスナの初期化
基底クラス RTC::OutPortBase に属する継承限定公開メンバ関数
void	configure ()
	OutPortの設定を行う
ReturnCode_t	publishInterfaces (ConnectorProfile &cprof) override
	Interface 情報を公開する
ReturnCode_t	subscribeInterfaces (const ConnectorProfile &cprof) override
	Interface に接続する
void	unsubscribeInterfaces (const ConnectorProfile &connector_profile) override
	Interface の接続を解除する
void	initProviders ()
	OutPort provider の初期化
void	initConsumers ()
	InPort consumer の初期化
bool	checkEndian (const coil::Properties &prop, bool &littleEndian)
	シリアライザのエンディアンをチェックする
OutPortProvider *	createProvider (ConnectorProfile &cprof, coil::Properties &prop)
	OutPort provider の生成
InPortConsumer *	createConsumer (const ConnectorProfile &cprof, coil::Properties &prop)
	InPort consumer の生成
OutPortConnector *	createConnector (const ConnectorProfile &cprof, coil::Properties &prop, InPortConsumer *consumer)
	OutPortPushConnector の生成
OutPortConnector *	createConnector (const ConnectorProfile &cprof, coil::Properties &prop, OutPortProvider *provider)
	OutPortPullConnector の生成
ReturnCode_t	notify_connect (ConnectorProfile &connector_profile) override
InPortBase *	getLocalInPort (const ConnectorInfo &profile)
	ローカルのピアInPortを取得
基底クラス RTC::PortBase に属する継承限定公開メンバ関数
virtual ReturnCode_t	connectNext (ConnectorProfile &connector_profile)
	次の Port に対して notify_connect() をコールする
virtual ReturnCode_t	disconnectNext (ConnectorProfile &cprof)
	次の Port に対して notify_disconnect() をコールする
virtual void	setConnectionLimit (int limit_value)
	接続の最大数を設定する。
virtual ReturnCode_t	_publishInterfaces ()
	Interface情報を公開する
bool	isExistingConnId (const char *id)
	id が既存の ConnectorProfile のものかどうか判定する
ConnectorProfile	findConnProfile (const char *id)
	id を持つ ConnectorProfile を探す
CORBA::Long	findConnProfileIndex (const char *id)
	id を持つ ConnectorProfile を探す
void	updateConnectorProfile (const ConnectorProfile &connector_profile)
	ConnectorProfile の追加もしくは更新
bool	eraseConnectorProfile (const char *id)
	ConnectorProfile を削除する
bool	appendInterface (const char *instance_name, const char *type_name, PortInterfacePolarity pol)
	PortInterfaceProfile に インターフェースを登録する
bool	deleteInterface (const char *name, PortInterfacePolarity pol)
	PortInterfaceProfile からインターフェース登録を削除する
template<class ValueType >
void	addProperty (const char *key, ValueType value)
	PortProfile の properties に NameValue 値を追加する
void	appendProperty (const char *key, const char *value)
	PortProfile の properties に NameValue 値を要素に追加する
void	updateConnectors ()
	存在しないポートをdisconnectする。
bool	checkPorts (::RTC::PortServiceList &ports)
	ポートの存在を確認する。
void	onNotifyConnect (const char *portname, RTC::ConnectorProfile &profile)
void	onNotifyDisconnect (const char *portname, RTC::ConnectorProfile &profile)
void	onUnsubscribeInterfaces (const char *portname, RTC::ConnectorProfile &profile)
void	onPublishInterfaces (const char *portname, RTC::ConnectorProfile &profile, ReturnCode_t ret)
void	onConnectNextport (const char *portname, RTC::ConnectorProfile &profile, ReturnCode_t ret)
void	onSubscribeInterfaces (const char *portname, RTC::ConnectorProfile &profile, ReturnCode_t ret)
void	onConnected (const char *portname, RTC::ConnectorProfile &profile, ReturnCode_t ret)
void	onDisconnectNextport (const char *portname, RTC::ConnectorProfile &profile, ReturnCode_t ret)
void	onDisconnected (const char *portname, RTC::ConnectorProfile &profile, ReturnCode_t ret)
bool	isExistingMarshalingType (coil::Properties &con_prop)
	指定のシリアライザが使用可能かを判定する

その他の継承メンバ
基底クラス RTC::OutPortBase に属する継承公開型
using	ConnectorList = std::vector<OutPortConnector*>
基底クラス RTC::PortBase に属する継承静的限定公開メンバ関数
static bool	isEmptyId (const ConnectorProfile &connector_profile)
	ConnectorProfile の connector_id フィールドが空かどうか判定
static std::string	getUUID ()
	UUIDを生成する
static void	setUUID (ConnectorProfile &connector_profile)
	UUIDを生成し ConnectorProfile にセットする
基底クラス RTC::OutPortBase に属する継承限定公開変数類
std::vector< OutPortConnector * >	m_connectors
	接続リスト
coil::vstring	m_providerTypes
	利用可能provider
coil::vstring	m_consumerTypes
	利用可能consumer
bool	m_littleEndian
	接続エンディアン
ConnectorListenersBase *	m_listeners
	ConnectorDataListener リスナ
基底クラス RTC::PortBase に属する継承限定公開変数類
coil::Properties	m_properties
	プロパティ
Logger	rtclog
	ロガーストリーム
PortProfile	m_profile
	Port の PortProfile
RTC::PortService_var	m_objref
	Port の オブジェクト参照
std::mutex	m_profile_mutex
	PortProfile の mutex
std::mutex	m_connectorsMutex
std::string	m_ownerInstanceName = "unknown"
	インスタンス名
int	m_connectionLimit {-1}
	Port の接続の最大数
ConnectionCallback *	m_onPublishInterfaces {nullptr}
	Callback functor オブジェクト
ConnectionCallback *	m_onSubscribeInterfaces {nullptr}
	Callback functor オブジェクト
ConnectionCallback *	m_onConnected {nullptr}
	Callback functor オブジェクト
ConnectionCallback *	m_onUnsubscribeInterfaces {nullptr}
	Callback functor オブジェクト
ConnectionCallback *	m_onDisconnected {nullptr}
	Callback functor オブジェクト
ConnectionCallback *	m_onConnectionLost {nullptr}
	Callback functor オブジェクト
PortConnectListeners *	m_portconnListeners {nullptr}
	PortConnectListenerホルダ
DirectPortBase *	m_directport {nullptr}

詳解

template<class DataType>
class RTC::OutPort< DataType >

OutPort テンプレートクラス

OutPort テンプレートクラス、テンプレートの引数として、OutPortが 扱うデータ型 DataType をとる。

OnWrite系コールバック (書込みに起因するイベントによりコールされる)

• void OnWrite<DataType>::operator()(const DataType): OutPort::write() を呼び出し書き込みを行う際にコールされる。
• DataType OnWriteConvert<DataType>::operator()(const DataType): OutPort::write() を呼び出し、データをバッファに書き込む前に呼ばれ データの変換を行う。operator()()の戻り値がシリアライズされバッファに 書き込まれる。

から

0.2.0

構築子と解体子

OutPort()

template<class DataType >

RTC::OutPort< DataType >::OutPort ( const char * name, DataType & value )

inline

コンストラクタ

コンストラクタ

引数

name	ポート名
value	このポートにバインドされるデータ変数
length	バッファ長(デフォルト値:8)

参照先 RTC::OutPortBase::addConnectorDataListener(), RTC::PortBase::addProperty(), CdrMemoryStreamInit(), RTC::getSerializerList(), RTC::OutPort< DataType >::initConnectorListeners(), RTC::PortBase::m_directport, RTC::ON_BUFFER_WRITE, RTC::ON_SEND, RTC_DEBUG.

~OutPort()

template<class T >

RTC::OutPort< T >::~OutPort ( )

overridedefault

デストラクタ

デストラクタ

関数詳解

getStatus()

template<class DataType >

DataPortStatus RTC::OutPort< DataType >::getStatus ( int index )

inline

特定のコネクタへの書き込みステータスを得る

OutPort は接続ごとに Connector と呼ばれる仮想データチャネルを持 つ。write() 関数はこれら Connector に対してデータを書き込むが、 各 Connector は書き込みごとにステータスを返す。write() 関数では、 すべての Connector が正常終了したときのみ true を返し、それ以外 では false を返却する。この関数は write() が false の場合ステー タスを調べるのに使用することができる。

引数

index

Connector の index

戻り値

ステータス

getStatusList()

template<class DataType >

DataPortStatusList RTC::OutPort< DataType >::getStatusList ( )

inline

特定のコネクタへの書き込みステータスリストを得る

OutPort は接続ごとに Connector と呼ばれる仮想データチャネルを持 つ。write() 関数はこれら Connector に対してデータを書き込むが、 各 Connector は書き込みごとにステータスを返す。write() 関数では、 すべての Connector が正常終了したときのみ true を返し、それ以外 では false を返却する。この関数は write() が false の場合ステー タスを調べるのに使用することができる。

戻り値

ステータスリスト

initConnectorListeners()

template<class DataType >

void RTC::OutPort< DataType >::initConnectorListeners ( )

inlineoverrideprotectedvirtual

コネクタリスナの初期化

RTC::OutPortBaseを再実装しています。

参照先 RTC::OutPortBase::m_listeners.

参照元 RTC::OutPort< DataType >::OutPort().

isEmpty()

template<class DataType >

bool RTC::OutPort< DataType >::isEmpty ( )

inlineoverridevirtual

新規データが無いことを確認

戻り値

true：新規データなし

RTC::DirectOutPortBase< DataType >を実装しています。

isNew()

template<class DataType >

bool RTC::OutPort< DataType >::isNew ( )

inlineoverridevirtual

新規データの存在確認

戻り値

true：新規データあり

RTC::DirectOutPortBase< DataType >を実装しています。

operator<<()

template<class DataType >

bool RTC::OutPort< DataType >::operator<< ( DataType & value )

inline

データ書き込み

ポートへデータを書き込む。 設定された値をポートに書き込む。

引数

value

書き込み対象データ

戻り値

書き込み処理結果(書き込み成功:true、書き込み失敗:false)

参照先 RTC::OutPort< DataType >::write().

read()

template<class DataType >

void RTC::OutPort< DataType >::read ( DataType & data )

inlineoverridevirtual

データをダイレクトに読み込む

引数

data

読み込むデータ

RTC::DirectOutPortBase< DataType >を実装しています。

参照先 CORBA_Util::copyData().

setOnWrite()

template<class DataType >

void RTC::OutPort< DataType >::setOnWrite ( OnWrite< DataType > * on_write )

inline

OnWrite コールバックの設定

write() 呼び出し時に、各コネクタに対してデータを書き込む直前に呼 ばれる OnWrite コールバックファンクタを設定する。この関数により 設定されたファンクタオブジェクトの所有権は、呼び出し側が持つ。し たがっ const て、このファンクタオブジェクトの解体責任は呼び出し側にある。 ファンクタの設定を解除する場合には引数に 0 を渡すことで、コール バックが無効となる。

引数

on_write

OnWrite コールバックファンクタ

setOnWriteConvert()

template<class DataType >

void RTC::OutPort< DataType >::setOnWriteConvert ( OnWriteConvert< DataType > * on_wconvert )

inline

OnWriteConvert コールバックの設定

write() 呼び出し時に、各コネクタに対してデータを書き込み直前に呼 ばれ、データ変換を行う OnWriteConvert コールバックファンクタを設 定する。引数に直近で書き込まれたデータが与えられ、戻り値に実際に コネクタまたはバッファに書き込まれるデータを返すファンクタを設定 する。この関数により設定されたファンクタオブジェクトの所有権は、 呼び出し側が持つ。したがっ const て、このファンクタオブジェクト の解体責任は呼び出し側にある。ファンクタの設定を解除する場合には 引数に 0 を渡すことで、コールバックが無効となる。 データ書き込み 時に呼ばれる OnWriteConvert コールバックファンクタを設定する。こ のコールバック関数の処理結果が書き込まれる。このため書き込みデー タのフィルタリングが可能となる。

引数

on_wconvert

OnWriteConvert コールバックファンクタ

write() [1/2]

template<class DataType >

bool RTC::OutPort< DataType >::write ( )

inlineoverridevirtual

データ書き込み

ポートへデータを書き込む。 バインドされた変数に設定された値をポートに書き込む。

戻り値

書き込み処理結果(書き込み成功:true、書き込み失敗:false)

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

参照先 RTC::OutPort< DataType >::write().

参照元 RTC::OutPort< DataType >::operator<<(), RTC::OutPort< DataType >::write().

write() [2/2]

template<class DataType >

virtual bool RTC::OutPort< DataType >::write ( DataType & value )

inlinevirtual

データ書き込み

ポートへデータを書き込む。

• コールバックファンクタ OnWrite がセットされている場合、 OutPort が保持するバッファに書き込む前に OnWrite が呼ばれる。
• OutPort が保持するバッファがオーバーフローを検出できるバッファであり、 かつ、書き込む際にバッファがオーバーフローを検出した場合、 コールバックファンクタ OnOverflow が呼ばれる。
• コールバックファンクタ OnWriteConvert がセットされている場合、 バッファ書き込み時に、 OnWriteConvert の operator() の戻り値が バッファに書き込まれる。

引数

value

書き込み対象データ

戻り値

書き込み処理結果(書き込み成功:true、書き込み失敗:false)

参照先 RTC::CONNECTION_LOST, CORBA_Util::copyData(), RTC::PortBase::findConnProfile(), RTC::OutPortBase::m_connectors, RTC::PortBase::m_connectorsMutex, RTC::PortBase::m_onConnectionLost, RTC::PORT_OK, RTC_DEBUG, RTC_TRACE, RTC_WARN.

---

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

• OutPort.h