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

トレースのクラスです。 [詳細]

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

Public メソッド

void ClearFlag (uint64_t flags)
 指定したトレースフラグを非アクティブに設定します。
 
void ClearFlag (void)
 TraceFlagAlways を除き、トレースフラグを全てクリアします。
 
bool IsFlagSet (uint64_t flag) const
 特定のフラグが設定されているかどうかを返します。
 
bool IsPrintTime () const
 時刻表示の ON / OFF を取得します。
 
void ResetBaseTime ()
 時刻表示の基準時刻を現在の時刻にします。
 
void SetFlag (uint64_t flags)
 トレースフラグをアクティブに設定します。
 
void SetPrintTime (bool isPrint)
 時刻表示の ON / OFF を切り替えます。 ON の時は "[Pia:12345] ..." のように基準時刻からの経過時間をミリ秒単位で表示します。
 

Static Public メソッド

static Result CreateInstance (void)
 Trace クラスのインスタンスを作成します(シングルトンパターン)。
 
static void DestroyInstance (void)
 Trace クラスのインスタンスを破棄します(シングルトンパターン)。
 
static TraceGetInstance (void)
 Trace クラスのインスタンスを得ます(シングルトンパターン)
 

説明

トレースのクラスです。

Releaseビルドでは、トレースのコードは無効化されます。

関数

void nn::pia::common::Trace::ClearFlag ( uint64_t  flags)
inline

指定したトレースフラグを非アクティブに設定します。

指定したトレースフラグを非アクティブに設定します。 ただし、 TraceFlagAlways は除きます。

引数
[in]flags非アクティブにする TraceFlag の論理和です。
static Result nn::pia::common::Trace::CreateInstance ( void  )
static

Trace クラスのインスタンスを作成します(シングルトンパターン)。

この API は、 nn::pia::common::BeginSetup() を呼び出してから、 nn::pia::common::EndSetup() を呼び出すまでの間に呼び出す必要があります。

戻り値
インスタンスの作成に成功すれば、成功の Result が返されます。この関数がエラーを返さないようにアプリケーションを実装する必要があります。
返るエラーの一覧:

ResultAlreadyExists 既にインスタンスは作成されています。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

ResultNotInitialized common モジュールが初期化されていません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

ResultInvalidState BeginSetup()EndSetup() 間で呼び出されていません。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。

static void nn::pia::common::Trace::DestroyInstance ( void  )
static

Trace クラスのインスタンスを破棄します(シングルトンパターン)。

Trace クラスのインスタンスを破棄します。インスタンスが作成されて いない状態の時にこのAPIを呼び出した場合は、何も起こらずに返ります。

static Trace* nn::pia::common::Trace::GetInstance ( void  )
inlinestatic

Trace クラスのインスタンスを得ます(シングルトンパターン)

事前に CreateInstance でインスタンスを作成していなかった場合は、 NULLポインタが返されます。

戻り値
Trace インスタンスへのポインタ。
bool nn::pia::common::Trace::IsFlagSet ( uint64_t  flag) const
inline

特定のフラグが設定されているかどうかを返します。

なお、 IsFlasSet ( TraceFlagNever ) の結果は true となります。 引数で複数のフラグを指定した際は、指定したフラグのいずれかが設定されていれば true が返されます。

戻り値
特定のフラグが設定されていれば true 、そうでなければ false を返します。
引数
[in]flag問い合わせるトレースフラグ。
bool nn::pia::common::Trace::IsPrintTime ( ) const
inline

時刻表示の ON / OFF を取得します。

戻り値
時刻表示が ON になっていれば true を返します。
void nn::pia::common::Trace::SetFlag ( uint64_t  flags)
inline

トレースフラグをアクティブに設定します。

このメソッドを使用して、追加のトレースフラグをアクティブに設定します。

引数
[in]flagsアクティブにする TraceFlag の論理和です。
void nn::pia::common::Trace::SetPrintTime ( bool  isPrint)
inline

時刻表示の ON / OFF を切り替えます。 ON の時は "[Pia:12345] ..." のように基準時刻からの経過時間をミリ秒単位で表示します。

引数
[in]isPrinttrue なら時刻を表示します。