AM Daemon ライブラリリファレンス
公開型 | 公開メンバ関数 | 静的公開メンバ関数 | 公開変数類 | 関連関数 | 全メンバ一覧
amdaemon::AimeId 構造体

AimeのUID値を保持する構造体。 [詳解]

#include <AimeId.h>

公開型

typedef std::uint32_t value_type
 内部値の表現型。 [詳解]
 

公開メンバ関数

bool valid () const
 有効な値であるか否かを取得する。 [詳解]
 
std::wstring toString () const
 文字列表現値を作成する。 [詳解]
 

静的公開メンバ関数

static AimeId make (value_type value)
 AimeId 値を作成する。 [詳解]
 
static AimeId zero ()
 ゼロ値の AimeId 値を作成する。 [詳解]
 
static AimeId makeInvalid ()
 無効な AimeId 値を作成する。 [詳解]
 

公開変数類

value_type value
 UID値。 [詳解]
 

関連関数

(これらはメソッドではありません)

bool operator== (const AimeId &l, const AimeId &r)
 等価比較演算子のオーバロード。 [詳解]
 
bool operator!= (const AimeId &l, const AimeId &r)
 非等価比較演算子のオーバロード。 [詳解]
 
bool operator< (const AimeId &l, const AimeId &r)
 小なり比較演算子のオーバロード。 [詳解]
 
bool operator> (const AimeId &l, const AimeId &r)
 大なり比較演算子のオーバロード。 [詳解]
 
bool operator<= (const AimeId &l, const AimeId &r)
 小なり等価比較演算子のオーバロード。 [詳解]
 
bool operator>= (const AimeId &l, const AimeId &r)
 大なり等価比較演算子のオーバロード。 [詳解]
 

詳解

AimeのUID値を保持する構造体。

覚え書き
memcpy 可能。

型定義メンバ詳解

typedef std::uint32_t amdaemon::AimeId::value_type

内部値の表現型。

関数詳解

static AimeId amdaemon::AimeId::make ( value_type  value)
inlinestatic

AimeId 値を作成する。

引数
[in]valueUID値。
戻り値
作成された AimeId 値。
static AimeId amdaemon::AimeId::zero ( )
inlinestatic

ゼロ値の AimeId 値を作成する。

戻り値
ゼロ値の AimeId 値。
static AimeId amdaemon::AimeId::makeInvalid ( )
inlinestatic

無効な AimeId 値を作成する。

戻り値
無効な AimeId 値。
bool amdaemon::AimeId::valid ( ) const
inline

有効な値であるか否かを取得する。

戻り値
true有効な値である場合。
false無効な値である場合。

内部値が 0 でも UINT32_MAX でもなければ true を返す。

AiMeLibの規定する無効なUID値は UINT32_MAX のみだが、 実際のアプリではゼロ埋め初期化する実装もよくあるため、 0 も無効値として扱う。

一般に開放されているAimeのUID値は 10000 以上であるため、 0 を無効値として扱うことにより実店舗で問題となることはない。

std::wstring amdaemon::AimeId::toString ( ) const
inline

文字列表現値を作成する。

戻り値
文字列表現値。

UID値を文字列化して返す。

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

bool operator== ( const AimeId l,
const AimeId r 
)
related

等価比較演算子のオーバロード。

引数
[in]l左辺値。
[in]r右辺値。
戻り値
比較結果値。
bool operator!= ( const AimeId l,
const AimeId r 
)
related

非等価比較演算子のオーバロード。

引数
[in]l左辺値。
[in]r右辺値。
戻り値
比較結果値。
bool operator< ( const AimeId l,
const AimeId r 
)
related

小なり比較演算子のオーバロード。

引数
[in]l左辺値。
[in]r右辺値。
戻り値
比較結果値。
bool operator> ( const AimeId l,
const AimeId r 
)
related

大なり比較演算子のオーバロード。

引数
[in]l左辺値。
[in]r右辺値。
戻り値
比較結果値。
bool operator<= ( const AimeId l,
const AimeId r 
)
related

小なり等価比較演算子のオーバロード。

引数
[in]l左辺値。
[in]r右辺値。
戻り値
比較結果値。
bool operator>= ( const AimeId l,
const AimeId r 
)
related

大なり等価比較演算子のオーバロード。

引数
[in]l左辺値。
[in]r右辺値。
戻り値
比較結果値。

メンバ詳解

value_type amdaemon::AimeId::value

UID値。


この構造体詳解は次のファイルから抽出されました: