CTR-Pia  5.4.3
Game Communication Engine
 全て クラス ネームスペース 関数 変数 型定義 列挙型 列挙型の値 ページ
クラス テンプレート nn::pia::clone::EventCloneElement< Value_, BufferSize >abstract

イベントの送受信を管理します。 [詳細]

+ nn::pia::clone::EventCloneElement< Value_, BufferSize >に対する継承グラフ

Public 型

typedef uint16_t Id
 クローンエレメントを識別するための ID の型です。
 
typedef Value_ Value
 このイベントで送られる引数の型です。
 
typedef SerializePolicy< ValueValueSerializePolicy
 Value をシリアライズするためのアルゴリズムです。
 

Public メソッド

 EventCloneElement ()
 デフォルトコンストラクタです。
 
virtual ~EventCloneElement ()
 デストラクタです。
 
ClockValue GetClock () const
 現在参照中のイベントの発行時刻を取得します。
 
const CloneBaseGetCloneBase () const
 このオブジェクトが登録されている CloneBase を取得します。
 
CloneBaseGetCloneBase ()
 このオブジェクトが登録されている非constな CloneBase を取得します。
 
Index GetEventIndex () const
 現在参照中のイベントのインデックスを取得します。
 
Id GetId () const
 ID を取得します。
 
const CloneProtocolGetProtocol () const
 このオブジェクトが登録されている CloneBase が登録されている CloneProtocol を取得します。
 
StationIndex GetSetterStationIndex () const
 現在参照中のイベントの発行元ステーションインデックスを取得します。
 
uint32_t GetUsingBufferNum () const
 現在のイベントバッファの使用数を取得します。
 
const ValueGetValue () const
 現在参照中のイベントの値を指すポインタを取得します。
 
const ValueHandleNext ()
 次のイベントを参照します。
 
bool IsEventDropped () const
 イベントの取りこぼしエラーが発生したかどうかを取得します。
 
bool IsReadyToSetValue () const
 値を設定できる状態かどうかを判定します。
 
bool IsRegisteredWithCloneBase () const
 CloneBase に登録されているかどうかを判定します。
 
bool IsRegisteredWithProtocol () const
 CloneProtocol に登録されているかどうかを判定します。
 
Result SetValue (const Value &value)
 イベントを発行します。
 
void Trace (uint64_t flag) const
 デバッグに有用な情報をプリントします。
 

プロファイリング

enum  Type {
  Type_Unreliable = 0x1000,
  Type_Reliable = 0x2000,
  Type_Event = 0x3000,
  Type_Reckoning = 0x4000,
  Type_ReliableLarge = 0x5000
}
 クローンエレメントの種類を表す列挙型です。 [詳細]
 
Result SetProfiler (CloneProfilerBase *pSendProfiler, CloneProfilerBase *pReceiveProfiler)
 送受信のプロファイリング管理オブジェクトを設定します。
 
const CloneProfilerBaseGetSendProfiler () const
 設定されている送信プロファイリング管理オブジェクトを取得します。
 
const CloneProfilerBaseGetReceiveProfiler () const
 設定されている受信プロファイリング管理オブジェクトを取得します。
 
void ResetProfiler ()
 送受信のプロファイリングされた結果をリセットします。
 
uint32_t GetProfiledLatestSendCount (StationIndex stationIndex) const
 直近の CloneProfiler::LATEST_BUFFER_SIZE 回の common::Scheduler::Dispatch の間に送信したクローンエレメントデータの個数を取得します。
 
uint32_t GetProfiledLatestSendNoCompressedSize (StationIndex stationIndex) const
 直近の CloneProfiler::LATEST_BUFFER_SIZE 回の common::Scheduler::Dispatch の間に送信したクローンエレメントデータの圧縮前のサイズ(バイト)を取得します。
 
uint32_t GetProfiledLatestSendUnicastCount (StationIndex stationIndex) const
 直近の CloneProfiler::LATEST_BUFFER_SIZE 回の common::Scheduler::Dispatch の間にユニキャストで送信したクローンエレメントデータの個数を取得します。
 
uint32_t GetProfiledLatestSendUnicastSize (StationIndex stationIndex) const
 直近の CloneProfiler::LATEST_BUFFER_SIZE 回の common::Scheduler::Dispatch の間にユニキャストで送信したクローンエレメントデータの圧縮前のサイズ(バイト)を取得します。
 
uint32_t GetProfiledLatestResendCount (StationIndex stationIndex) const
 直近の CloneProfiler::LATEST_BUFFER_SIZE 回の common::Scheduler::Dispatch の間に再送したクローンエレメントデータの個数を取得します。
 
uint32_t GetProfiledLatestResendSize (StationIndex stationIndex) const
 直近の CloneProfiler::LATEST_BUFFER_SIZE 回の common::Scheduler::Dispatch の間に再送したクローンエレメントデータの圧縮前のサイズ(バイト)を取得します。
 
uint32_t GetProfiledLatestSendSystemCount (StationIndex stationIndex) const
 直近の CloneProfiler::LATEST_BUFFER_SIZE 回の common::Scheduler::Dispatch の間に送信したシステム用クローンエレメントデータの個数を取得します。
 
uint32_t GetProfiledLatestSendSystemSize (StationIndex stationIndex) const
 直近の CloneProfiler::LATEST_BUFFER_SIZE 回の common::Scheduler::Dispatch の間に送信したシステム用クローンエレメントデータの圧縮前のサイズ(バイト)を取得します。
 
uint32_t GetProfiledTotalSendCount (StationIndex stationIndex) const
 ResetProfiler 以降に送信したクローンエレメントデータの個数を取得します。
 
uint32_t GetProfiledTotalSendNoCompressedSize (StationIndex stationIndex) const
 ResetProfiler 以降に送信したクローンエレメントデータの圧縮前のサイズ(バイト)を取得します。
 
uint32_t GetProfiledTotalSendUnicastCount (StationIndex stationIndex) const
 ResetProfiler 以降にユニキャストで送信したクローンエレメントデータの個数を取得します。
 
uint32_t GetProfiledTotalSendUnicastSize (StationIndex stationIndex) const
 ResetProfiler 以降にユニキャストで送信したクローンエレメントデータの圧縮前のサイズ(バイト)を取得します。
 
uint32_t GetProfiledTotalResendCount (StationIndex stationIndex) const
 ResetProfiler 以降に再送したクローンエレメントデータの個数を取得します。
 
uint32_t GetProfiledTotalResendSize (StationIndex stationIndex) const
 ResetProfiler 以降に再送したクローンエレメントデータの圧縮前のサイズ(バイト)を取得します。
 
uint32_t GetProfiledTotalSendSystemCount (StationIndex stationIndex) const
 ResetProfiler 以降に送信したシステム用クローンエレメントデータの個数を取得します。
 
uint32_t GetProfiledTotalSendSystemSize (StationIndex stationIndex) const
 ResetProfiler 以降に送信したシステム用クローンエレメントデータの圧縮前のサイズ(バイト)を取得します。
 
uint32_t GetProfiledLatestReceiveCount (StationIndex stationIndex) const
 直近の CloneProfiler::LATEST_BUFFER_SIZE 回の common::Scheduler::Dispatch の間に受信したクローンエレメントデータの個数を取得します。
 
uint32_t GetProfiledLatestReceiveNoCompressedSize (StationIndex stationIndex) const
 直近の CloneProfiler::LATEST_BUFFER_SIZE 回の common::Scheduler::Dispatch の間に受信したクローンエレメントデータの圧縮前のサイズ(バイト)を取得します。
 
uint32_t GetProfiledLatestReceiveSystemCount (StationIndex stationIndex) const
 直近の CloneProfiler::LATEST_BUFFER_SIZE 回の common::Scheduler::Dispatch の間に受信したシステム用クローンエレメントデータの個数を取得します。
 
uint32_t GetProfiledLatestReceiveSystemSize (StationIndex stationIndex) const
 直近の CloneProfiler::LATEST_BUFFER_SIZE 回の common::Scheduler::Dispatch の間に受信したシステム用クローンエレメントデータの圧縮前のサイズ(バイト)を取得します。
 
uint32_t GetProfiledTotalReceiveCount (StationIndex stationIndex) const
 ResetProfiler 以降に受信したクローンエレメントデータの個数を取得します。
 
uint32_t GetProfiledTotalReceiveNoCompressedSize (StationIndex stationIndex) const
 ResetProfiler 以降に受信したクローンエレメントデータの圧縮前のサイズ(バイト)を取得します。
 
uint32_t GetProfiledTotalReceiveSystemCount (StationIndex stationIndex) const
 ResetProfiler 以降に受信したシステム用クローンエレメントデータの個数を取得します。
 
uint32_t GetProfiledTotalReceiveSystemSize (StationIndex stationIndex) const
 ResetProfiler 以降に受信したシステム用クローンエレメントデータの圧縮前のサイズ(バイト)を取得します。
 
virtual Type GetType () const =0
 クローンエレメントの種類を取得します。
 

説明

template<typename Value_, uint32_t BufferSize>
class nn::pia::clone::EventCloneElement< Value_, BufferSize >

イベントの送受信を管理します。

Template Parameters
Value_イベント発行時に指定する値の型です。値が必要ない場合でも何らかの値を設定する必要があります。
BufferSizeイベントバッファのサイズです。正の値を指定する必要があります。

列挙型

クローンエレメントの種類を表す列挙型です。

列挙型の値:
Type_Unreliable 

UnreliableCloneElement.

Type_Reliable 

ReliableCloneElement.

Type_Event 

EventCloneElement.

Type_Reckoning 

ReckoningCloneElement.

Type_ReliableLarge 

ReliableLargeCloneElement.

関数

template<typename Value_ , uint32_t BufferSize>
ClockValue nn::pia::clone::EventCloneElement< Value_, BufferSize >::GetClock ( ) const
inline

現在参照中のイベントの発行時刻を取得します。

戻り値
現在参照中のイベントの発行時刻です。参照中のイベントが無い場合は InvalidClock を返します。
const CloneBase* nn::pia::clone::CloneElementBase::GetCloneBase ( ) const
inlineinherited

このオブジェクトが登録されている CloneBase を取得します。

戻り値
このオブジェクトが登録されている CloneBase です。
CloneBase* nn::pia::clone::CloneElementBase::GetCloneBase ( )
inlineinherited

このオブジェクトが登録されている非constな CloneBase を取得します。

戻り値
このオブジェクトが登録されている CloneBase です。
template<typename Value_ , uint32_t BufferSize>
Index nn::pia::clone::EventCloneElement< Value_, BufferSize >::GetEventIndex ( ) const
inline

現在参照中のイベントのインデックスを取得します。

戻り値
現在参照中のイベントのインデックスです。参照中のイベントが無い場合は 0 を返します。
Id nn::pia::clone::CloneElementBase::GetId ( ) const
inlineinherited

ID を取得します。

戻り値
CloneBase に登録する際に指定した ID です。 CloneBase に登録されていない場合は 0 を返します。 (登録する際に ID を 0 と指定していた場合、有効な値として 0 を返す場合もあります。)
uint32_t nn::pia::clone::CloneElementBase::GetProfiledLatestReceiveCount ( StationIndex  stationIndex) const
inherited

直近の CloneProfiler::LATEST_BUFFER_SIZE 回の common::Scheduler::Dispatch の間に受信したクローンエレメントデータの個数を取得します。

引数
[in]stationIndexプロファイリング対象の StationIndex です。
戻り値
直近の CloneProfiler::LATEST_BUFFER_SIZE 回の common::Scheduler::Dispatch の間に受信したクローンエレメントデータの個数です。 受信プロファイリング管理オブジェクトが設定されていない場合は 0xFFFFFFFF を返します。
参照
SetProfiler
uint32_t nn::pia::clone::CloneElementBase::GetProfiledLatestReceiveNoCompressedSize ( StationIndex  stationIndex) const
inherited

直近の CloneProfiler::LATEST_BUFFER_SIZE 回の common::Scheduler::Dispatch の間に受信したクローンエレメントデータの圧縮前のサイズ(バイト)を取得します。

引数
[in]stationIndexプロファイリング対象の StationIndex です。
戻り値
直近の CloneProfiler::LATEST_BUFFER_SIZE 回の common::Scheduler::Dispatch の間に受信したクローンエレメントデータの圧縮前のサイズ(バイト)です。 受信プロファイリング管理オブジェクトが設定されていない場合は 0xFFFFFFFF を返します。
参照
SetProfiler
uint32_t nn::pia::clone::CloneElementBase::GetProfiledLatestReceiveSystemCount ( StationIndex  stationIndex) const
inherited

直近の CloneProfiler::LATEST_BUFFER_SIZE 回の common::Scheduler::Dispatch の間に受信したシステム用クローンエレメントデータの個数を取得します。

引数
[in]stationIndexプロファイリング対象の StationIndex です。
戻り値
直近の CloneProfiler::LATEST_BUFFER_SIZE 回の common::Scheduler::Dispatch の間に受信したシステム用クローンエレメントデータの個数です。 受信プロファイリング管理オブジェクトが設定されていない場合は 0xFFFFFFFF を返します。
参照
SetProfiler
uint32_t nn::pia::clone::CloneElementBase::GetProfiledLatestReceiveSystemSize ( StationIndex  stationIndex) const
inherited

直近の CloneProfiler::LATEST_BUFFER_SIZE 回の common::Scheduler::Dispatch の間に受信したシステム用クローンエレメントデータの圧縮前のサイズ(バイト)を取得します。

引数
[in]stationIndexプロファイリング対象の StationIndex です。
戻り値
直近の CloneProfiler::LATEST_BUFFER_SIZE 回の common::Scheduler::Dispatch の間に受信したシステム用クローンエレメントデータの圧縮前のサイズ(バイト)です。 受信プロファイリング管理オブジェクトが設定されていない場合は 0xFFFFFFFF を返します。
参照
SetProfiler
uint32_t nn::pia::clone::CloneElementBase::GetProfiledLatestResendCount ( StationIndex  stationIndex) const
inherited

直近の CloneProfiler::LATEST_BUFFER_SIZE 回の common::Scheduler::Dispatch の間に再送したクローンエレメントデータの個数を取得します。

引数
[in]stationIndexプロファイリング対象の StationIndex です。
戻り値
直近の CloneProfiler::LATEST_BUFFER_SIZE 回の common::Scheduler::Dispatch の間に再送したクローンエレメントデータの個数です。 送信プロファイリング管理オブジェクトが設定されていない場合は 0xFFFFFFFF を返します。
参照
SetProfiler
uint32_t nn::pia::clone::CloneElementBase::GetProfiledLatestResendSize ( StationIndex  stationIndex) const
inherited

直近の CloneProfiler::LATEST_BUFFER_SIZE 回の common::Scheduler::Dispatch の間に再送したクローンエレメントデータの圧縮前のサイズ(バイト)を取得します。

引数
[in]stationIndexプロファイリング対象の StationIndex です。
戻り値
直近の CloneProfiler::LATEST_BUFFER_SIZE 回の common::Scheduler::Dispatch の間に再送したクローンエレメントデータの圧縮前のサイズ(バイト)です。 送信プロファイリング管理オブジェクトが設定されていない場合は 0xFFFFFFFF を返します。
参照
SetProfiler
uint32_t nn::pia::clone::CloneElementBase::GetProfiledLatestSendCount ( StationIndex  stationIndex) const
inherited

直近の CloneProfiler::LATEST_BUFFER_SIZE 回の common::Scheduler::Dispatch の間に送信したクローンエレメントデータの個数を取得します。

引数
[in]stationIndexプロファイリング対象の StationIndex です。
戻り値
直近の CloneProfiler::LATEST_BUFFER_SIZE 回の common::Scheduler::Dispatch の間に送信したクローンエレメントデータの個数です。 送信プロファイリング管理オブジェクトが設定されていない場合は 0xFFFFFFFF を返します。
参照
SetProfiler
uint32_t nn::pia::clone::CloneElementBase::GetProfiledLatestSendNoCompressedSize ( StationIndex  stationIndex) const
inherited

直近の CloneProfiler::LATEST_BUFFER_SIZE 回の common::Scheduler::Dispatch の間に送信したクローンエレメントデータの圧縮前のサイズ(バイト)を取得します。

引数
[in]stationIndexプロファイリング対象の StationIndex です。
戻り値
直近の CloneProfiler::LATEST_BUFFER_SIZE 回の common::Scheduler::Dispatch の間に送信したクローンエレメントデータの圧縮前のサイズ(バイト)です。 送信プロファイリング管理オブジェクトが設定されていない場合は 0xFFFFFFFF を返します。
参照
SetProfiler
uint32_t nn::pia::clone::CloneElementBase::GetProfiledLatestSendSystemCount ( StationIndex  stationIndex) const
inherited

直近の CloneProfiler::LATEST_BUFFER_SIZE 回の common::Scheduler::Dispatch の間に送信したシステム用クローンエレメントデータの個数を取得します。

引数
[in]stationIndexプロファイリング対象の StationIndex です。
戻り値
直近の CloneProfiler::LATEST_BUFFER_SIZE 回の common::Scheduler::Dispatch の間に送信したシステム用クローンエレメントデータの個数です。 送信プロファイリング管理オブジェクトが設定されていない場合は 0xFFFFFFFF を返します。
参照
SetProfiler
uint32_t nn::pia::clone::CloneElementBase::GetProfiledLatestSendSystemSize ( StationIndex  stationIndex) const
inherited

直近の CloneProfiler::LATEST_BUFFER_SIZE 回の common::Scheduler::Dispatch の間に送信したシステム用クローンエレメントデータの圧縮前のサイズ(バイト)を取得します。

引数
[in]stationIndexプロファイリング対象の StationIndex です。
戻り値
直近の CloneProfiler::LATEST_BUFFER_SIZE 回の common::Scheduler::Dispatch の間に送信したシステム用クローンエレメントデータの圧縮前のサイズ(バイト)です。 送信プロファイリング管理オブジェクトが設定されていない場合は 0xFFFFFFFF を返します。
参照
SetProfiler
uint32_t nn::pia::clone::CloneElementBase::GetProfiledLatestSendUnicastCount ( StationIndex  stationIndex) const
inherited

直近の CloneProfiler::LATEST_BUFFER_SIZE 回の common::Scheduler::Dispatch の間にユニキャストで送信したクローンエレメントデータの個数を取得します。

引数
[in]stationIndexプロファイリング対象の StationIndex です。
戻り値
直近の CloneProfiler::LATEST_BUFFER_SIZE 回の common::Scheduler::Dispatch の間にユニキャストで送信したクローンエレメントデータの個数です。 送信プロファイリング管理オブジェクトが設定されていない場合は 0xFFFFFFFF を返します。
参照
SetProfiler
uint32_t nn::pia::clone::CloneElementBase::GetProfiledLatestSendUnicastSize ( StationIndex  stationIndex) const
inherited

直近の CloneProfiler::LATEST_BUFFER_SIZE 回の common::Scheduler::Dispatch の間にユニキャストで送信したクローンエレメントデータの圧縮前のサイズ(バイト)を取得します。

引数
[in]stationIndexプロファイリング対象の StationIndex です。
戻り値
直近の CloneProfiler::LATEST_BUFFER_SIZE 回の common::Scheduler::Dispatch の間にユニキャストで送信したクローンエレメントデータの圧縮前のサイズ(バイト)です。 送信プロファイリング管理オブジェクトが設定されていない場合は 0xFFFFFFFF を返します。
参照
SetProfiler
uint32_t nn::pia::clone::CloneElementBase::GetProfiledTotalReceiveCount ( StationIndex  stationIndex) const
inherited

ResetProfiler 以降に受信したクローンエレメントデータの個数を取得します。

引数
[in]stationIndexプロファイリング対象の StationIndex です。
戻り値
ResetProfiler() 以降に受信したクローンエレメントデータの個数です。 受信プロファイリング管理オブジェクトが設定されていない場合は 0xFFFFFFFF を返します。
参照
SetProfiler, ResetProfiler
uint32_t nn::pia::clone::CloneElementBase::GetProfiledTotalReceiveNoCompressedSize ( StationIndex  stationIndex) const
inherited

ResetProfiler 以降に受信したクローンエレメントデータの圧縮前のサイズ(バイト)を取得します。

引数
[in]stationIndexプロファイリング対象の StationIndex です。
戻り値
ResetProfiler() 以降に受信したクローンエレメントデータの圧縮前のサイズ(バイト)です。 受信プロファイリング管理オブジェクトが設定されていない場合は 0xFFFFFFFF を返します。
参照
SetProfiler, ResetProfiler
uint32_t nn::pia::clone::CloneElementBase::GetProfiledTotalReceiveSystemCount ( StationIndex  stationIndex) const
inherited

ResetProfiler 以降に受信したシステム用クローンエレメントデータの個数を取得します。

引数
[in]stationIndexプロファイリング対象の StationIndex です。
戻り値
ResetProfiler() 以降に受信したシステム用クローンエレメントデータの個数です。 受信プロファイリング管理オブジェクトが設定されていない場合は 0xFFFFFFFF を返します。
参照
SetProfiler, ResetProfiler
uint32_t nn::pia::clone::CloneElementBase::GetProfiledTotalReceiveSystemSize ( StationIndex  stationIndex) const
inherited

ResetProfiler 以降に受信したシステム用クローンエレメントデータの圧縮前のサイズ(バイト)を取得します。

引数
[in]stationIndexプロファイリング対象の StationIndex です。
戻り値
ResetProfiler() 以降に受信したシステム用クローンエレメントデータの圧縮前のサイズ(バイト)です。 受信プロファイリング管理オブジェクトが設定されていない場合は 0xFFFFFFFF を返します。
参照
SetProfiler, ResetProfiler
uint32_t nn::pia::clone::CloneElementBase::GetProfiledTotalResendCount ( StationIndex  stationIndex) const
inherited

ResetProfiler 以降に再送したクローンエレメントデータの個数を取得します。

引数
[in]stationIndexプロファイリング対象の StationIndex です。
戻り値
ResetProfiler() 以降に再送したクローンエレメントデータの個数です。 送信プロファイリング管理オブジェクトが設定されていない場合は 0xFFFFFFFF を返します。
参照
SetProfiler, ResetProfiler
uint32_t nn::pia::clone::CloneElementBase::GetProfiledTotalResendSize ( StationIndex  stationIndex) const
inherited

ResetProfiler 以降に再送したクローンエレメントデータの圧縮前のサイズ(バイト)を取得します。

引数
[in]stationIndexプロファイリング対象の StationIndex です。
戻り値
ResetProfiler() 以降に再送したクローンエレメントデータの圧縮前のサイズ(バイト)です。 送信プロファイリング管理オブジェクトが設定されていない場合は 0xFFFFFFFF を返します。
参照
SetProfiler, ResetProfiler
uint32_t nn::pia::clone::CloneElementBase::GetProfiledTotalSendCount ( StationIndex  stationIndex) const
inherited

ResetProfiler 以降に送信したクローンエレメントデータの個数を取得します。

引数
[in]stationIndexプロファイリング対象の StationIndex です。
戻り値
ResetProfiler() 以降に送信したクローンエレメントデータの個数です。 送信プロファイリング管理オブジェクトが設定されていない場合は 0xFFFFFFFF を返します。
参照
SetProfiler, ResetProfiler
uint32_t nn::pia::clone::CloneElementBase::GetProfiledTotalSendNoCompressedSize ( StationIndex  stationIndex) const
inherited

ResetProfiler 以降に送信したクローンエレメントデータの圧縮前のサイズ(バイト)を取得します。

引数
[in]stationIndexプロファイリング対象の StationIndex です。
戻り値
ResetProfiler() 以降に送信したクローンエレメントデータの圧縮前のサイズ(バイト)です。 送信プロファイリング管理オブジェクトが設定されていない場合は 0xFFFFFFFF を返します。
参照
SetProfiler, ResetProfiler
uint32_t nn::pia::clone::CloneElementBase::GetProfiledTotalSendSystemCount ( StationIndex  stationIndex) const
inherited

ResetProfiler 以降に送信したシステム用クローンエレメントデータの個数を取得します。

引数
[in]stationIndexプロファイリング対象の StationIndex です。
戻り値
ResetProfiler() 以降に送信したシステム用クローンエレメントデータの個数です。 送信プロファイリング管理オブジェクトが設定されていない場合は 0xFFFFFFFF を返します。
参照
SetProfiler, ResetProfiler
uint32_t nn::pia::clone::CloneElementBase::GetProfiledTotalSendSystemSize ( StationIndex  stationIndex) const
inherited

ResetProfiler 以降に送信したシステム用クローンエレメントデータの圧縮前のサイズ(バイト)を取得します。

引数
[in]stationIndexプロファイリング対象の StationIndex です。
戻り値
ResetProfiler() 以降に送信したシステム用クローンエレメントデータの圧縮前のサイズ(バイト)です。 送信プロファイリング管理オブジェクトが設定されていない場合は 0xFFFFFFFF を返します。
参照
SetProfiler, ResetProfiler
uint32_t nn::pia::clone::CloneElementBase::GetProfiledTotalSendUnicastCount ( StationIndex  stationIndex) const
inherited

ResetProfiler 以降にユニキャストで送信したクローンエレメントデータの個数を取得します。

引数
[in]stationIndexプロファイリング対象の StationIndex です。
戻り値
ResetProfiler() 以降にユニキャストで送信したクローンエレメントデータの個数です。 送信プロファイリング管理オブジェクトが設定されていない場合は 0xFFFFFFFF を返します。
参照
SetProfiler, ResetProfiler
uint32_t nn::pia::clone::CloneElementBase::GetProfiledTotalSendUnicastSize ( StationIndex  stationIndex) const
inherited

ResetProfiler 以降にユニキャストで送信したクローンエレメントデータの圧縮前のサイズ(バイト)を取得します。

引数
[in]stationIndexプロファイリング対象の StationIndex です。
戻り値
ResetProfiler() 以降にユニキャストで送信したクローンエレメントデータの圧縮前のサイズ(バイト)です。 送信プロファイリング管理オブジェクトが設定されていない場合は 0xFFFFFFFF を返します。
参照
SetProfiler, ResetProfiler
const CloneProtocol* nn::pia::clone::CloneElementBase::GetProtocol ( ) const
inherited

このオブジェクトが登録されている CloneBase が登録されている CloneProtocol を取得します。

戻り値
このオブジェクトが登録されている CloneBase が登録されている CloneProtocol です。
const CloneProfilerBase* nn::pia::clone::CloneElementBase::GetReceiveProfiler ( ) const
inlineinherited

設定されている受信プロファイリング管理オブジェクトを取得します。

戻り値
設定されている受信プロファイリング管理オブジェクトです。設定されていない場合は NULL を返します。
参照
SetProfiler
const CloneProfilerBase* nn::pia::clone::CloneElementBase::GetSendProfiler ( ) const
inlineinherited

設定されている送信プロファイリング管理オブジェクトを取得します。

戻り値
設定されている送信プロファイリング管理オブジェクトです。設定されていない場合は NULL を返します。
参照
SetProfiler
template<typename Value_ , uint32_t BufferSize>
StationIndex nn::pia::clone::EventCloneElement< Value_, BufferSize >::GetSetterStationIndex ( ) const
inline

現在参照中のイベントの発行元ステーションインデックスを取得します。

戻り値
現在参照中のイベントの発行元ステーションインデックスです。参照中のイベントが無い場合は StationIndex_Invalid を返します。
virtual Type nn::pia::clone::CloneElementBase::GetType ( ) const
pure virtualinherited

クローンエレメントの種類を取得します。

戻り値
クローンエレメントの種類です。
uint32_t nn::pia::clone::EventCloneElementBase::GetUsingBufferNum ( ) const
inherited

現在のイベントバッファの使用数を取得します。

ReceiveClone、AtomicSharingClone、SequentialSharingClone に登録されている場合、 返り値が 0 にならない場合があります。 次のデータを受信時に、消してもよいデータがバッファから削除されます。

戻り値
イベントバッファの使用数を返します。
template<typename Value_ , uint32_t BufferSize>
const Value* nn::pia::clone::EventCloneElement< Value_, BufferSize >::GetValue ( ) const
inline

現在参照中のイベントの値を指すポインタを取得します。

戻り値
現在参照中のイベントの値を指すポインタです。前回呼んだ HandleNext() の返り値と同じです。参照中のイベントが無い場合は NULL を返します。
template<typename Value_ , uint32_t BufferSize>
const Value* nn::pia::clone::EventCloneElement< Value_, BufferSize >::HandleNext ( )
inline

次のイベントを参照します。

参照中のイベントは、もう一度 HandleNext() を呼ぶまで同じものが参照できます。

戻り値
新たに参照するイベントの値です。次のイベントが無い場合は NULL を返します。
bool nn::pia::clone::EventCloneElementBase::IsEventDropped ( ) const
inlineinherited

イベントの取りこぼしエラーが発生したかどうかを取得します。

AtomicSharingClone で使用しているときにステーションの異常切断が発生すると、 受信するはずだったイベントを受信し損ねる場合があります。 いずれかの EventCloneElement でこのエラーが発生した場合、 CloneProtocol::GetError()CloneProtocol::ErrorType_EventDropped を返すようになります。

戻り値
イベントの取りこぼしエラーが発生していたら true を返します。
参照
CloneProtocol::GetError
bool nn::pia::clone::CloneElementBase::IsReadyToSetValue ( ) const
inherited

値を設定できる状態かどうかを判定します。

戻り値
値を設定できる状態なら true を返します。
bool nn::pia::clone::CloneElementBase::IsRegisteredWithCloneBase ( ) const
inlineinherited

CloneBase に登録されているかどうかを判定します。

戻り値
CloneBase に登録されていれば true を返します。
bool nn::pia::clone::CloneElementBase::IsRegisteredWithProtocol ( ) const
inherited

CloneProtocol に登録されているかどうかを判定します。

戻り値
CloneProtocol に登録されていれば true を返します。
void nn::pia::clone::CloneElementBase::ResetProfiler ( )
inherited

送受信のプロファイリングされた結果をリセットします。

参照
SetProfiler
Result nn::pia::clone::CloneElementBase::SetProfiler ( CloneProfilerBase pSendProfiler,
CloneProfilerBase pReceiveProfiler 
)
inherited

送受信のプロファイリング管理オブジェクトを設定します。

CloneProfiler を設定すると、クローンエレメントが行った送受信をプロファイリングできます。 ここでの計測は、このクローンエレメントが他のクローンエレメントと行うすべてのデータのやり取りが計上されるため、 自ステーション内でのクローンエレメント間のデータのやり取りも値に含まれます。

圧縮を有効にしていた場合でも、計測されるサイズは非圧縮状態でのサイズです。

引数に NULL を指定すると、既に設定してある CloneProfiler を解除する事ができます。

引数
[in]pSendProfiler送信のプロファイリングを管理する CloneProfiler を指定します。 必要ない場合は NULL を指定する必要があります。
[in]pReceiveProfiler受信のプロファイリングを管理する CloneProfiler を指定します。 必要ない場合は NULL を指定する必要があります。
戻り値
成功すれば、IsSuccess() が true を返す Result が返されます。この関数がエラーを返さないようにアプリケーションを実装する必要があります。
返るエラーの一覧:
ResultInvalidArgument 引数が不正です。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。
template<typename Value_ , uint32_t BufferSize>
Result nn::pia::clone::EventCloneElement< Value_, BufferSize >::SetValue ( const Value value)

イベントを発行します。

引数
[in]valueイベントの値です。
戻り値
成功すれば、IsSuccess() が true を返す Result が返されます。
返るエラーの一覧:

ResultInvalidState 登録しているクローンが送信可能状態ではありません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

ResultBufferIsFull バッファがいっぱいで発行できません。アプリケーションで適切にハンドリングしてください。

void nn::pia::clone::EventCloneElementBase::Trace ( uint64_t  flag) const
inherited

デバッグに有用な情報をプリントします。

引数
[in]flagトレースフラグの論理和。詳細は TraceFlag 型を参照してください。