クラス RTC::PublisherPeriodic

PublisherPeriodic クラス [詳細]

#include <PublisherPeriodic.h>

RTC::PublisherPeriodicに対する継承グラフ

RTC::PublisherBase RTC::DataPortStatus

すべてのメンバ一覧

Public 型

typedef coil::Mutex Mutex
typedef coil::Condition< MutexCondition
typedef coil::Guard< coil::MutexGuard

Public メソッド

DATAPORTSTATUS_ENUM PublisherPeriodic ()
 コンストラクタ
virtual ~PublisherPeriodic (void)
 デストラクタ
virtual ReturnCode init (coil::Properties &prop)
 初期化
virtual ReturnCode setConsumer (InPortConsumer *consumer)
 InPortコンシューマのセット
virtual ReturnCode setBuffer (CdrBufferBase *buffer)
 バッファのセット
virtual ReturnCode setListener (ConnectorInfo &info, ConnectorListeners *listeners)
 リスナを設定する。
virtual ReturnCode write (const cdrMemoryStream &data, unsigned long sec, unsigned long usec)
 データを書き込む
virtual bool isActive ()
 アクティブ化確認
virtual ReturnCode activate ()
 アクティブ化
virtual ReturnCode deactivate ()
 非アクティブ化
virtual int svc (void)
 スレッド実行関数

Protected 型

enum  Policy { ALL, FIFO, SKIP, NEW }

Protected メソッド

void setPushPolicy (const coil::Properties &prop)
 PushPolicy の設定
bool createTask (const coil::Properties &prop)
 Task の設定
ReturnCode pushAll ()
 push "all" policy
ReturnCode pushFifo ()
 push "fifo" policy
ReturnCode pushSkip ()
 push "skip" policy
ReturnCode pushNew ()
 push "new" policy
ReturnCode convertReturn (BufferStatus::Enum status, const cdrMemoryStream &data)
 return code conversion (BufferStatus -> DataPortStatus)
ReturnCode invokeListener (DataPortStatus::Enum status, const cdrMemoryStream &data)
 DataPortStatusに従ってリスナへ通知する関数を呼び出す。
void onBufferWrite (const cdrMemoryStream &data)
 Connector data listener functions
void onBufferFull (const cdrMemoryStream &data)
 ON_BUFFER_FULLのリスナへ通知する。
void onBufferWriteTimeout (const cdrMemoryStream &data)
 ON_BUFFER_WRITE_TIMEOUTのリスナへ通知する。
void onBufferRead (const cdrMemoryStream &data)
 ON_BUFFER_READのリスナへ通知する。
void onSend (const cdrMemoryStream &data)
 ON_SENDのリスナへ通知する。
void onReceived (const cdrMemoryStream &data)
 ON_RECEIVEDのリスナへ通知する。
void onReceiverFull (const cdrMemoryStream &data)
 ON_RECEIVER_FULLのリスナへ通知する。
void onReceiverTimeout (const cdrMemoryStream &data)
 ON_RECEIVER_TIMEOUTのリスナへ通知する。
void onReceiverError (const cdrMemoryStream &data)
 ON_RECEIVER_ERRORのリスナへ通知する。
void onBufferEmpty ()
 Connector listener functions
void onSenderEmpty ()
 ON_SENDER_EMPTYのリスナへ通知する。
void onSenderError ()
 ON_SENDER_ERRORのリスナへ通知する。


説明

PublisherPeriodic クラス

一定周期でコンシューマの送出処理を呼び出す Publisher 定期的にデータ送信を実行する場合に使用する。


型定義


列挙型

列挙型の値:
ALL 
FIFO 
SKIP 
NEW 


コンストラクタとデストラクタ

DATAPORTSTATUS_ENUM RTC::PublisherPeriodic::PublisherPeriodic (  ) 

コンストラクタ

送出処理の呼び出し間隔を、Propertyオブジェクトの dataport.publisher.push_rateメンバに設定しておく必要がある。送出 間隔は、Hz単位の浮動小数文字列で指定。たとえば、1000.0Hzの場合は、 「1000.0」を設定。上記プロパティが未設定の場合は、「1000Hz」を設 定。

引数:
consumer データ送出を待つコンシューマ
property 本Publisherの駆動制御情報を設定したPropertyオブジェクト

virtual RTC::PublisherPeriodic::~PublisherPeriodic ( void   )  [virtual]

デストラクタ

デストラクタ


関数

virtual ReturnCode RTC::PublisherPeriodic::init ( coil::Properties prop  )  [virtual]

初期化

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

virtual ReturnCode RTC::PublisherPeriodic::setConsumer ( InPortConsumer consumer  )  [virtual]

InPortコンシューマのセット

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

virtual ReturnCode RTC::PublisherPeriodic::setBuffer ( CdrBufferBase buffer  )  [virtual]

バッファのセット

引数:
buffer CDRバッファ
戻り値:
PORT_OK 正常終了 INVALID_ARGS 不正な引数

virtual ReturnCode RTC::PublisherPeriodic::setListener ( ConnectorInfo info,
ConnectorListeners listeners 
) [virtual]

リスナを設定する。

引数:
info ConnectorInfo
listeners ConnectorListeners
戻り値:
PORT_OK 正常終了 INVALID_ARGS 不正な引数

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

virtual ReturnCode RTC::PublisherPeriodic::write ( const cdrMemoryStream &  data,
unsigned long  sec,
unsigned long  usec 
) [virtual]

データを書き込む

引数:
data 書き込むデータ
sec タイムアウト時間
nsec タイムアウト時間
戻り値:
リターンコード

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

virtual bool RTC::PublisherPeriodic::isActive (  )  [virtual]

アクティブ化確認

アクティブ化されているか確認する。

戻り値:
状態確認結果(アクティブ状態:true、非アクティブ状態:false)

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

virtual ReturnCode RTC::PublisherPeriodic::activate (  )  [virtual]

アクティブ化

戻り値:
リターンコード

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

virtual ReturnCode RTC::PublisherPeriodic::deactivate (  )  [virtual]

非アクティブ化

戻り値:
リターンコード

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

virtual int RTC::PublisherPeriodic::svc ( void   )  [virtual]

スレッド実行関数

ACE_Task::svc() のオーバーライド

void RTC::PublisherPeriodic::setPushPolicy ( const coil::Properties prop  )  [protected]

PushPolicy の設定

bool RTC::PublisherPeriodic::createTask ( const coil::Properties prop  )  [protected]

Task の設定

ReturnCode RTC::PublisherPeriodic::pushAll (  )  [protected]

push "all" policy

ReturnCode RTC::PublisherPeriodic::pushFifo (  )  [protected]

push "fifo" policy

ReturnCode RTC::PublisherPeriodic::pushSkip (  )  [protected]

push "skip" policy

ReturnCode RTC::PublisherPeriodic::pushNew (  )  [protected]

push "new" policy

ReturnCode RTC::PublisherPeriodic::convertReturn ( BufferStatus::Enum  status,
const cdrMemoryStream &  data 
) [protected]

return code conversion (BufferStatus -> DataPortStatus)

ReturnCode RTC::PublisherPeriodic::invokeListener ( DataPortStatus::Enum  status,
const cdrMemoryStream &  data 
) [protected]

DataPortStatusに従ってリスナへ通知する関数を呼び出す。

引数:
status DataPortStatus
data cdrMemoryStream
戻り値:
リターンコード

void RTC::PublisherPeriodic::onBufferWrite ( const cdrMemoryStream &  data  )  [inline, protected]

Connector data listener functions

ON_BUFFER_WRITEのリスナへ通知する。

引数:
data cdrMemoryStream

参照先 RTC::ON_BUFFER_WRITE.

void RTC::PublisherPeriodic::onBufferFull ( const cdrMemoryStream &  data  )  [inline, protected]

ON_BUFFER_FULLのリスナへ通知する。

引数:
data cdrMemoryStream

参照先 RTC::ON_BUFFER_FULL.

void RTC::PublisherPeriodic::onBufferWriteTimeout ( const cdrMemoryStream &  data  )  [inline, protected]

ON_BUFFER_WRITE_TIMEOUTのリスナへ通知する。

引数:
data cdrMemoryStream

参照先 RTC::ON_BUFFER_WRITE_TIMEOUT.

void RTC::PublisherPeriodic::onBufferRead ( const cdrMemoryStream &  data  )  [inline, protected]

ON_BUFFER_READのリスナへ通知する。

引数:
data cdrMemoryStream

参照先 RTC::ON_BUFFER_READ.

void RTC::PublisherPeriodic::onSend ( const cdrMemoryStream &  data  )  [inline, protected]

ON_SENDのリスナへ通知する。

引数:
data cdrMemoryStream

参照先 RTC::ON_SEND.

void RTC::PublisherPeriodic::onReceived ( const cdrMemoryStream &  data  )  [inline, protected]

ON_RECEIVEDのリスナへ通知する。

引数:
data cdrMemoryStream

参照先 RTC::ON_RECEIVED.

void RTC::PublisherPeriodic::onReceiverFull ( const cdrMemoryStream &  data  )  [inline, protected]

ON_RECEIVER_FULLのリスナへ通知する。

引数:
data cdrMemoryStream

参照先 RTC::ON_RECEIVER_FULL.

void RTC::PublisherPeriodic::onReceiverTimeout ( const cdrMemoryStream &  data  )  [inline, protected]

ON_RECEIVER_TIMEOUTのリスナへ通知する。

引数:
data cdrMemoryStream

参照先 RTC::ON_RECEIVER_TIMEOUT.

void RTC::PublisherPeriodic::onReceiverError ( const cdrMemoryStream &  data  )  [inline, protected]

ON_RECEIVER_ERRORのリスナへ通知する。

引数:
data cdrMemoryStream

参照先 RTC::ON_RECEIVER_ERROR.

void RTC::PublisherPeriodic::onBufferEmpty (  )  [inline, protected]

Connector listener functions

ON_BUFFER_EMPTYのリスナへ通知する。

参照先 RTC::ON_BUFFER_EMPTY.

void RTC::PublisherPeriodic::onSenderEmpty (  )  [inline, protected]

ON_SENDER_EMPTYのリスナへ通知する。

参照先 RTC::ON_SENDER_EMPTY.

void RTC::PublisherPeriodic::onSenderError (  )  [inline, protected]

ON_SENDER_ERRORのリスナへ通知する。

参照先 RTC::ON_SENDER_ERROR.


OpenRTMに対してThu Jan 28 13:25:27 2010に生成されました。  doxygen 1.5.5