CTR-Pia  5.4.3
Game Communication Engine
 全て クラス ネームスペース 関数 変数 型定義 列挙型 列挙型の値 ページ
クラス nn::pia::common::Watermark

Piaライブラリ内部のリソース使用量のピーク値などを計測するために用意されたクラスです(サポート対象外)。 [詳細]

+ nn::pia::common::Watermarkに対する継承グラフ

Public メソッド

 Watermark (void)
 デフォルトコンストラクタです。 インスタンスは Update() 機能が無効にされた状態で構築されます。
 
 ~Watermark (void)
 デストラクタです。
 
int64_t GetLatestValue (void) const
 最後の Update() で渡された、最新の値を取得します。
 
int64_t GetMaxValue (void) const
 これまでの Update() における最大値を返します。
 
int64_t GetMinValue (void) const
 これまでの Update() における最小値を返します。
 
const char * GetName (void) const
 インスタンスに付けられた名前を得ます。
 
int64_t GetUpdateCount (void) const
 これまでに Update() が呼ばれた回数を返します。
 
bool IsUpdateEnabled (void) const
 Update() 機能が有効な状態であるかどうかを返します。
 
void Reset (void)
 インスタンスが保持していた最大値、最小値、最新の値、 Update() 呼び出し回数を初期状態に戻します。
 
void SetName (const char *pName)
 インスタンスに名前を設定します。
 
void SetUpdateDisabled (void)
 Update() による値の更新を無効にします。
 
void SetUpdateEnabled (void)
 Update() による値の更新を有効にします。
 
void Trace (uint64_t flag) const
 デバッグに有用な情報をプリントします。
 
void Update (int64_t value)
 値を更新します。
 

Static Public 変数

static const uint32_t MaxNameLength = 63
 SetName() で設定可能な名前の最大長です。
 

説明

Piaライブラリ内部のリソース使用量のピーク値などを計測するために用意されたクラスです(サポート対象外)。

関数

int64_t nn::pia::common::Watermark::GetLatestValue ( void  ) const
inline

最後の Update() で渡された、最新の値を取得します。

参照
Update, GetMinValue, GetMaxValue, GetUpdateCount
int64_t nn::pia::common::Watermark::GetMaxValue ( void  ) const
inline

これまでの Update() における最大値を返します。

参照
Update, GetMinValue, GetLatestValue, GetUpdateCount
int64_t nn::pia::common::Watermark::GetMinValue ( void  ) const
inline

これまでの Update() における最小値を返します。

参照
Update, GetMaxValue, GetLatestValue, GetUpdateCount
const char* nn::pia::common::Watermark::GetName ( void  ) const
inline

インスタンスに付けられた名前を得ます。

戻り値
名前が格納された文字配列を指すポインタ。
参照
SetName
int64_t nn::pia::common::Watermark::GetUpdateCount ( void  ) const
inline

これまでに Update() が呼ばれた回数を返します。

参照
Update, GetMaxValue, GetMinValue, GetLatestValue
bool nn::pia::common::Watermark::IsUpdateEnabled ( void  ) const
inline

Update() 機能が有効な状態であるかどうかを返します。

戻り値
Update() による値の更新が有効に設定されていれば true 、無効に設定されていれば false を返します。
参照
SetUpdateEnabled, SetUpdateDisabled
void nn::pia::common::Watermark::Reset ( void  )

インスタンスが保持していた最大値、最小値、最新の値、 Update() 呼び出し回数を初期状態に戻します。

SetName() で設定した名前と、 Update() 機能の有効/無効については何も変更を加えません。

参照
SetName, SetUpdateEnabled, SetUpdateDisabled, IsUpdateEnabled
void nn::pia::common::Watermark::SetName ( const char *  pName)

インスタンスに名前を設定します。

引数
[in]pName設定する名前。 NUL 文字で終端される文字列で、文字列長は MaxNameLength 以下でなくてはなりません。 無効なポインタが指定されたり、長すぎる名前が指定された場合は、アサート停止します。
参照
GetName
void nn::pia::common::Watermark::SetUpdateDisabled ( void  )
inline

Update() による値の更新を無効にします。

更新が無効な状態では、 Update() を呼び出しても、最大値/最小値/最新の値/ Update() 呼び出し回数などの値は更新されません。

参照
SetUpdateEnabled, IsUpdateEnabled
void nn::pia::common::Watermark::SetUpdateEnabled ( void  )
inline

Update() による値の更新を有効にします。

更新が有効な状態で Update() を呼び出すと、必要に応じて最大値/最小値が更新され、 GetLatestValue() で取得可能な値が更新され、 Update() の呼び出し回数カウンタが インクリメントされます。

参照
SetUpdateDisabled, IsUpdateEnabled
void nn::pia::common::Watermark::Trace ( uint64_t  flag) const

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

引数
[in]flagトレースフラグの論理和。詳細はTraceFlag 型を参照してください。
void nn::pia::common::Watermark::Update ( int64_t  value)

値を更新します。

Update() 機能が有効に設定された状態でこの関数を呼び出すと、 これまでの最大値、最小値、最新の値、 Update() 呼び出し回数などの 値が適切に更新されます。 Update() 機能が無効に設定された状態でこの関数を呼び出した場合には、 何もせずに返ります。

引数
[in]value監視対象の値。
参照
SetUpdateEnabled, SetUpdateDisabled, IsUpdateEnabled, GetMaxValue, GetMinValue, GetLatestValue, GetUpdateCount

変数

const uint32_t nn::pia::common::Watermark::MaxNameLength = 63
static

SetName() で設定可能な名前の最大長です。

参照
SetName