Diarkis C++Client Library API Document
公開メンバ関数 | フレンド | 全メンバ一覧
Diarkis::System::Result 構造体

特定の結果値に関する情報を含んでいます。 別のResult構造体と比較することができます。デバッグ体験を向上させるためにテキスト形式で出力することも可能です。 [詳解]

#include <result.h>

公開メンバ関数

 Result () noexcept
 未設定のResult構造体を構築します。 [詳解]
 
 Result (uint32_t uid, bool isAlias=false)
 適切に設定されたResult構造体を構築します。 [詳解]
 
 operator uint32_t () const
 結果構造体を数値値にキャストします。 [詳解]
 
bool operator== (const Result &other) const
 この結果が他の結果と同じかどうかをチェックします。 [詳解]
 
bool operator!= (const Result &other) const
 この結果が他のものと異なるかどうかをチェックします。 [詳解]
 
bool operator== (const uint32_t other) const
 数値表現が他と同じかどうかを確認します。 [詳解]
 
bool operator!= (const uint32_t other) const
 数値の表現が他と異なるかどうかを確認します。 [詳解]
 
Diarkis::StdString ToString () const
 結果値の文字列表現を提供します。 << 演算子と同じ出力を生成します。 [詳解]
 
void Reset ()
 結果をデフォルトの未設定値にリセットします。 [詳解]
 
const char * GetVariableName () const
 ソースコードで定義された変数名を取得します。 [詳解]
 
const char * GetFullyQualifiedVariableName () const
 ソースコードで定義されたネームスペースと接頭辞付きの完全修飾変数名を取得します。 [詳解]
 
const char * GetDescription () const
 結果値に関連するより長く詳細なメッセージを取得します。 [詳解]
 
ResultStatus GetStatus () const
 結果値の状態を取得します。 [詳解]
 
const char * GetStatusString () const
 結果値の状態の文字列表現を取得します。 [詳解]
 
bool IsTemporary () const
 結果値が一時的かどうかをチェックします（ステータスがTEMPORARYの場合）。 [詳解]
 
bool IsFatal () const
 結果値が致命的かどうかを確認します (ステータスがFATALの場合)。 [詳解]
 
bool MatchAny (std::initializer_list< Result > args)
 現在の結果が引数として渡された結果のいずれかと一致するかどうかを確認します。 [詳解]
 

フレンド

DIARKIS_EXPORT friend std::ostream & operator<< (std::ostream &os, const Result &result)
 C++の文字列ストリームメカニズムを使用して、結果値の完全な文字列表現を出力することを許可します。 [詳解]
 

詳解

特定の結果値に関する情報を含んでいます。 別のResult構造体と比較することができます。デバッグ体験を向上させるためにテキスト形式で出力することも可能です。

構築子と解体子

◆ Result() [1/2]

Diarkis::System::Result::Result ( )
explicitnoexcept

未設定のResult構造体を構築します。

◆ Result() [2/2]

Diarkis::System::Result::Result ( uint32_t  uid,
bool  isAlias = false 
)
explicit

適切に設定されたResult構造体を構築します。

引数
uid
isAlias

関数詳解

◆ operator uint32_t()

Diarkis::System::Result::operator uint32_t ( ) const
explicit

結果構造体を数値値にキャストします。

戻り値
uint32_t 結果の符号なし32ビット数値表現。

◆ operator==() [1/2]

bool Diarkis::System::Result::operator== ( const Result &  other) const

この結果が他の結果と同じかどうかをチェックします。

引数
other等しいかチェックする他の結果。
戻り値
両方が等しい場合はtrue。
両方が異なる場合はfalse。

◆ operator!=() [1/2]

bool Diarkis::System::Result::operator!= ( const Result &  other) const

この結果が他のものと異なるかどうかをチェックします。

引数
other不等しいかどうかをチェックする他の結果値。
戻り値
両方が異なる場合はtrue。
両方が等しい場合はfalse。

◆ operator==() [2/2]

bool Diarkis::System::Result::operator== ( const uint32_t  other) const

数値表現が他と同じかどうかを確認します。

引数
other等しさを確認する他の結果。
戻り値
両者が等しい場合はtrueを返します。
両者が異なる場合はfalseを返します。

◆ operator!=() [2/2]

bool Diarkis::System::Result::operator!= ( const uint32_t  other) const

数値の表現が他と異なるかどうかを確認します。

引数
other等しくないかを確認する他の結果値。
戻り値
両方が異なる場合はtrue。
両方が等しい場合はfalse。

◆ ToString()

Diarkis::StdString Diarkis::System::Result::ToString ( ) const

結果値の文字列表現を提供します。 << 演算子と同じ出力を生成します。

戻り値
Diarkis::StdString 結果値の文字列表現。

◆ Reset()

void Diarkis::System::Result::Reset ( )

結果をデフォルトの未設定値にリセットします。

◆ GetVariableName()

const char* Diarkis::System::Result::GetVariableName ( ) const

ソースコードで定義された変数名を取得します。

戻り値
const char* ソースコードで定義された変数名。
被呼び出し関係図:

◆ GetFullyQualifiedVariableName()

const char* Diarkis::System::Result::GetFullyQualifiedVariableName ( ) const

ソースコードで定義されたネームスペースと接頭辞付きの完全修飾変数名を取得します。

戻り値
const char* ソースコードで定義されたネームスペースと接頭辞付きの完全修飾変数名。
被呼び出し関係図:

◆ GetDescription()

const char* Diarkis::System::Result::GetDescription ( ) const

結果値に関連するより長く詳細なメッセージを取得します。

戻り値
const char* 結果値に関連するより長く詳細なメッセージ。
被呼び出し関係図:

◆ GetStatus()

ResultStatus Diarkis::System::Result::GetStatus ( ) const

結果値の状態を取得します。

戻り値
ResultStatus 結果値の状態。

◆ GetStatusString()

const char* Diarkis::System::Result::GetStatusString ( ) const

結果値の状態の文字列表現を取得します。

戻り値
const char* 結果値の状態の文字列表現。
被呼び出し関係図:

◆ IsTemporary()

bool Diarkis::System::Result::IsTemporary ( ) const

結果値が一時的かどうかをチェックします（ステータスがTEMPORARYの場合）。

戻り値
ステータスがTEMPORARYの場合はtrue。
ステータスがTEMPORARYでない場合はfalse。

◆ IsFatal()

bool Diarkis::System::Result::IsFatal ( ) const

結果値が致命的かどうかを確認します (ステータスがFATALの場合)。

戻り値
ステータスがFATALの場合はtrue。
ステータスがFATALでない場合はfalse。

◆ MatchAny()

bool Diarkis::System::Result::MatchAny ( std::initializer_list< Result >  args)

現在の結果が引数として渡された結果のいずれかと一致するかどうかを確認します。

引数
args一致を確認するすべての結果。構文 { RESULT1、RESULT2、RESULT3 } を使用します。
戻り値
現在の結果が引数として渡された結果のいずれかと一致する場合はtrue。
現在の結果が引数として渡された結果のいずれとも一致しない場合はfalse。

フレンドと関連関数の詳解

◆ operator<<

DIARKIS_EXPORT friend std::ostream& operator<< ( std::ostream &  os,
const Result &  result 
)
friend

C++の文字列ストリームメカニズムを使用して、結果値の完全な文字列表現を出力することを許可します。

引数
osチェーンされた出力ストリーム。
result文字列表現をストリームする結果値。
戻り値
std::ostream& チェーン目的のために渡された出力ストリーム。
この構造体詳解は次のファイルから抽出されました: