クラス テンプレート RTC::OutPort< DataType >
#include <OutPort.h>
Public メソッド | |
| OutPort (const char *name, DataType &value) | |
| コンストラクタ | |
| virtual | ~OutPort (void) |
| virtual bool | write (DataType &value) |
| データ書き込み | |
| bool | write () |
| データ書き込み | |
| bool | operator<< (DataType &value) |
| データ書き込み | |
| DataPortStatus::Enum | getStatus (int index) |
| 特定のコネクタへの書き込みステータスを得る | |
| DataPortStatusList | getStatusList () |
| 特定のコネクタへの書き込みステータスリストを得る | |
| void | setOnWrite (OnWrite< DataType > *on_write) |
| OnWrite コールバックの設定. | |
| void | setOnWriteConvert (OnWriteConvert< DataType > *on_wconvert) |
| OnWriteConvert コールバックの設定. | |
説明
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()()の戻り値がシリアライズされバッファに 書き込まれる。
OnBuffer系コールバック (バッファに起因するイベントによりコールされる)
2種類のコールバックファンクタのシグニチャ ConnectorDataCallback::operator()(ConnectorId, const cdrStream&) ConnectorCallback::operator()(ConnectorId)
- void OnBufferWrite::operator()(ConnectorId, cdrStream): BufferBase::write() コール時に単純に呼び出されるコールバック。 引数にはwrite()されるシリアライズ済みのデータが与えられる。
- void OnBufferFull::operator()(ConnectorId, cdrStream): BufferBase::write() コール時に、バッファがいっぱいの場合に 呼び出されるコールバック。コネクタのIDおよび書き込めなかったデータ が引数に与えられる。
- void OnBufferWriteTimeout::operator()(ConnectorId, cdrStream): ConnectorBase::write() コール時に、バッファがいっぱいで書込みが タイムアウトした場合に呼び出されるコールバック。コネクタのID および書き込めなかったデータが引数に与えられる。
- void OnBufferOverwrite::operator()(ConnectorId, cdrStream): BufferBase::write() コール時に、バッファが上書きモードに設定 されており、バッファがいっぱいの場合に呼び出されるコールバック。 コネクタのIDが引数に与えられる。
- void OnBufferRead::operator()(ConnectorId, cdrStream): BufferBase::read() コール時に単純に呼び出されるコールバック。 引数には read() で返されるシリアライズ済みのデータが与えられる。
- void OnBufferEmpty::operator()(ConnectorId): コネクタがバッファを読みだす際に、バッファが空の場合に呼び出される。 コネクタのIDが引数に与えられる。
- void OnBufferReadTimeout::operator()(ConnectorId): コネクタがバッファを読みだす際に、バッファが空でかつ、読み出しが タイムアウトした場合に呼び出されるコールバック。コネクタのID が引数に与えられる。
OnConnect系コールバック (接続に起因するイベントによりコールされる)
1種類のコールバックファンクタのシグニチャ ConnectionCallback::operator()(ConnectorProfile)
- void OnConnect::operator()(ConnectorProfile): ポートの接続時に呼び出されるコールバック。引数にConnectorProfile が与えられる。
- void OnDisconnect::operator()(ConnectorId): ポートの接続切断時に呼び出されるコールバック。引数にコネクタID が与えられる。
- void OnConnectionLost::operator()(ConnectorId): ポートの接続がロストした場合に呼び出されるコールバック。 引数にコネクタIDが与えられる。OutPortは、相手側InPortとの 接続をロストした場合、接続を強制的に切断するので、 引き続き OnDisconnect コールバックが呼び出される。
- void OnSend:operator()(ConnectorId, cdrStream): データがInPortに対して送られる際に呼び出されるコールバック。 引数にコネクタIDが与えられる。
- void OnReceived::operator()(ConnectorId, cdrStream): データの送信および受信が完了した際に呼び出されるコールバック。 引数には、コネクタIDが与えられる。
OnSender系コールバック (送信側に起因するイベントによりコールされる) 以下は、パブリッシャが存在する接続、すなわち dataflow type = push のときのみ有効。
- void OnSenderTimeout::operator()(ConnectorId, cdrStream): データがInPortに対して送られたが、送信がタイムアウトした際に 呼び出されるコールバック。引数にコネクタIDが与えられる。 InPortのプロバイダおよびコンシューマが対応している場合に限り有効。
- void OnSenderError::operator()(ConnectorId, cdrStream): データがInPortに対して送られたが、何らかのエラーをInPort側が 返した場合に呼び出されるコールバック。 引数には、コネクタIDが与えられる。
OnReceiver系コールバック (受信側に起因するイベントによりコールされる) 以下は、パブリッシャが存在する接続、すなわち dataflow type = push のときのみ有効。
- void OnReceiverFull::operator()(ConnectorId, cdrStream): データがInPortに送られるものの、InPort側のバッファがいっぱいの場合に これを通知するために呼ばれるコールバック。 引数には、コネクタIDが与えられる。
- void OnReceiverTimeout::operator()(ConnectorId, cdrStream): データがInPortに送られるものの、InPort側のバッファがいっぱいで タイムアウトした場合にこれを通知するために呼ばれるコールバック。 引数には、コネクタIDが与えられる。
- void OnReceiverError::operator()(ConnectorId, cdrStream): データがInPortに送られるものの、InPort側で何らかのエラーを返した 場合に呼び出されるコールバック。 引数には、コネクタIDが与えられる。
- から:
- 0.2.0
コンストラクタとデストラクタ
| RTC::OutPort< DataType >::OutPort | ( | const char * | name, | |
| DataType & | value | |||
| ) | [inline] |
コンストラクタ
コンストラクタ
- 引数:
-
name ポート名 value このポートにバインドされるデータ変数 length バッファ長(デフォルト値:8)
| virtual RTC::OutPort< DataType >::~OutPort | ( | void | ) | [inline, virtual] |
デストラクタ
関数
| DataPortStatus::Enum RTC::OutPort< DataType >::getStatus | ( | int | index | ) | [inline] |
| DataPortStatusList RTC::OutPort< DataType >::getStatusList | ( | ) | [inline] |
| bool RTC::OutPort< DataType >::operator<< | ( | DataType & | value | ) | [inline] |
データ書き込み
ポートへデータを書き込む。 設定された値をポートに書き込む。
- 引数:
-
value 書き込み対象データ
- 戻り値:
- 書き込み処理結果(書き込み成功:true、書き込み失敗:false)
| void RTC::OutPort< DataType >::setOnWrite | ( | OnWrite< DataType > * | on_write | ) | [inline] |
| void RTC::OutPort< DataType >::setOnWriteConvert | ( | OnWriteConvert< DataType > * | on_wconvert | ) | [inline] |
OnWriteConvert コールバックの設定.
write() 呼び出し時に、各コネクタに対してデータを書き込み直前に呼 ばれ、データ変換を行う OnWriteConvert コールバックファンクタを設 定する。引数に直近で書き込まれたデータが与えられ、戻り値に実際に コネクタまたはバッファに書き込まれるデータを返すファンクタを設定 する。この関数により設定されたファンクタオブジェクトの所有権は、 呼び出し側が持つ。したがっ const て、このファンクタオブジェクト の解体責任は呼び出し側にある。ファンクタの設定を解除する場合には 引数に 0 を渡すことで、コールバックが無効となる。 データ書き込み 時に呼ばれる OnWriteConvert コールバックファンクタを設定する。こ のコールバック関数の処理結果が書き込まれる。このため書き込みデー タのフィルタリングが可能となる。
- 引数:
-
on_wconvert OnWriteConvert コールバックファンクタ
| bool RTC::OutPort< DataType >::write | ( | ) | [inline, virtual] |
データ書き込み
ポートへデータを書き込む。 バインドされた変数に設定された値をポートに書き込む。
- 戻り値:
- 書き込み処理結果(書き込み成功:true、書き込み失敗:false)
RTC::OutPortBaseを実装しています。
| virtual bool RTC::OutPort< DataType >::write | ( | DataType & | value | ) | [inline, virtual] |
データ書き込み
ポートへデータを書き込む。
- コールバックファンクタ OnWrite がセットされている場合、 OutPort が保持するバッファに書き込む前に OnWrite が呼ばれる。
- OutPort が保持するバッファがオーバーフローを検出できるバッファであり、 かつ、書き込む際にバッファがオーバーフローを検出した場合、 コールバックファンクタ OnOverflow が呼ばれる。
- コールバックファンクタ OnWriteConvert がセットされている場合、 バッファ書き込み時に、 OnWriteConvert の operator() の戻り値が バッファに書き込まれる。
- 引数:
-
value 書き込み対象データ
- 戻り値:
- 書き込み処理結果(書き込み成功:true、書き込み失敗:false)
参照先 RTC::DataPortStatus::CONNECTION_LOST, RTC::PortBase::disconnect(), RTC::PortBase::findConnProfile(), CORBA_SeqUtil::for_each(), RTC::OutPortBase::m_connectors, RTC::PortBase::m_connectorsMutex, RTC::PortBase::m_onConnectionLost, RTC::DataPortStatus::PORT_OK, RTC_DEBUG, RTC_TRACE, と RTC_WARN.
