初期化処理やポーリング処理によって取得したAime関連情報を保持するクラス。 [詳解]

#include <AimeResult.h>

公開メンバ関数
	AimeResult (InnerIndexHolder)
	コンストラクタ。 [詳解]

bool	valid () const
	有効な情報が保持されているか否かを取得する。 [詳解]

bool	isReaderDetected () const
	Aimeリーダーが接続されているか否かを取得する。 [詳解]

const wchar_t *	getHardVersion () const
	Aimeリーダーのハードウェアバージョンを取得する。 [詳解]

const wchar_t *	getFirmVersion () const
	Aimeリーダーのファームウェアバージョンを取得する。 [詳解]

const AimeOfflineId &	getOfflineId () const
	読み取ったAimeのオフラインIDを取得する。 [詳解]

bool	isMobile () const
	読み取ったAimeがFeliCaモバイル(おサイフケータイ)であるか否かを取得する。 [詳解]

const AccessCode &	getAccessCode () const
	読み取ったAimeのアクセスコードを取得する。 [詳解]

const AimeId &	getAimeId () const
	読み取ったAimeのUID値を取得する。 [詳解]

bool	isSegaIdRegistered () const
	読み取ったAimeが SEGA ID に紐付いているか否かを取得する。 [詳解]

const wchar_t *	getSegaIdAuthKey () const
	読み取ったAimeに紐付く SEGA ID への認証キーを取得する。 [詳解]

std::size_t	getRelatedAimeIdCount () const
	SEGA ID に紐付くUID値の個数を取得する。 [詳解]

const AimeId &	getRelatedAimeId (std::size_t index) const
	SEGA ID に紐付くUID値を取得する。 [詳解]

詳解

初期化処理やポーリング処理によって取得したAime関連情報を保持するクラス。

参照: AimeUnit

このクラスのインスタンスをアプリ側で直接生成することはできない。 AimeUnit クラスのメンバ関数 AimeUnit::getResult から取得すること。

構築子と解体子

amdaemon::AimeResult::AimeResult ( InnerIndexHolder )

explicit

コンストラクタ。

覚え書き: アプリ側からは利用できない。

関数詳解

bool amdaemon::AimeResult::valid ( ) const

有効な情報が保持されているか否かを取得する。

戻り値

true	有効な情報が保持されている場合。
false	有効な情報が保持されていない場合。

bool amdaemon::AimeResult::isReaderDetected ( ) const

Aimeリーダーが接続されているか否かを取得する。

戻り値

true	Aimeリーダーが接続されている場合。
false	Aimeリーダーが接続されていないか、未チェックである場合。

メンバ関数 valid が true を返すのであれば必ず有意な値を返す。

const wchar_t* amdaemon::AimeResult::getHardVersion ( ) const

Aimeリーダーのハードウェアバージョンを取得する。

戻り値: ハードウェアバージョン。未取得の場合は空文字列。

この関数はすべてのポーリング処理コマンドで有意な値を返す。ただしメンバ関数 isReaderDetected が false を返す場合、この関数は空文字列を返す。

表示等に利用する場合、値をキャッシュせず直接この関数の戻り値を利用すること。ポーリング処理開始直後からしばらくは空文字列となるが、 Aimeリーダーが正しく接続されていればすぐに有効な値を返すようになる。

特に電子マネー対応タイトルでは、第3世代以降のAimeリーダーが接続されているか判別するために、この関数の戻り値をゲームテストモード等で表示することを推奨する。

const wchar_t* amdaemon::AimeResult::getFirmVersion ( ) const

Aimeリーダーのファームウェアバージョンを取得する。

戻り値: ファームウェアバージョン。未取得の場合は空文字列。

この関数はすべてのポーリング処理コマンドで有意な値を返す。ただしメンバ関数 isReaderDetected が false を返す場合、この関数は空文字列を返す。

表示等に利用する場合、値をキャッシュせず直接この関数の戻り値を利用すること。ポーリング処理開始直後からしばらくは空文字列となるが、 Aimeリーダーが正しく接続されていればすぐに有効な値を返すようになる。

const AimeOfflineId& amdaemon::AimeResult::getOfflineId ( ) const

読み取ったAimeのオフラインIDを取得する。

戻り値: オフラインID。未取得の場合は無効値。

この関数はすべてのポーリング処理コマンドで有意な値を返す。ただしAimeリーダーによる読み取りに失敗した場合、この関数は無効値を返す。

オフラインIDとは、各種DBにアクセスせずに取得できるID値であり、他のオフラインIDとの比較やバイナリ書き出しが可能である。オフラインプレイをサポートするゲームで用いるとよい。

bool amdaemon::AimeResult::isMobile ( ) const

読み取ったAimeがFeliCaモバイル(おサイフケータイ)であるか否かを取得する。

戻り値

true	FeliCaモバイルである場合。
false	FeliCaモバイルではないか、未チェックである場合。

この関数はすべてのポーリング処理コマンドで有意な値を返す。ただしメンバ関数 getOfflineId が無効値を返す場合、この関数は false を返す。

この関数はFeliCaモバイル(おサイフケータイ)の場合のみ true を返す。 FeliCaスタンダード(キャラEdy)や FeliCa Lite-S (共通アミューズメントICカード)等、 FeliCaモバイル以外のFeliCaデバイスである場合は false を返す。

const AccessCode& amdaemon::AimeResult::getAccessCode ( ) const

読み取ったAimeのアクセスコードを取得する。

戻り値: アクセスコード。未取得の場合は無効値。

この関数はすべてのポーリング処理コマンドで有意な値を返す。ただし下記の場合、この関数は無効値を返す。

Aimeリーダーによる読み取りに失敗した場合。
ポーリング処理コマンドに AimeCommand::ScanOffline を指定し、読み取ったAimeの種別がFeliCaであった場合。
- FeliCaのアクセスコードはFeliCaDBにアクセスしないとわからないため。

const AimeId& amdaemon::AimeResult::getAimeId ( ) const

読み取ったAimeのUID値を取得する。

戻り値: UID値。未取得の場合は無効値。

この関数はポーリング処理コマンド AimeCommand::Scan でのみ有意な値を返す。ただし何らかの理由でUID値を取得できない場合、この関数は無効値を返す。

bool amdaemon::AimeResult::isSegaIdRegistered ( ) const

読み取ったAimeが SEGA ID に紐付いているか否かを取得する。

戻り値

true	紐付いている場合。
false	紐付いていないか、取得できなかった場合。

この関数はポーリング処理コマンド AimeCommand::Scan でのみ有意な値を返す。ただしメンバ関数 getAimeId が無効値を返す場合、この関数は false を返す。

const wchar_t* amdaemon::AimeResult::getSegaIdAuthKey ( ) const

読み取ったAimeに紐付く SEGA ID への認証キーを取得する。

戻り値: 認証キー。紐付いていないか、取得できなかった場合は nullptr 。

この関数はポーリング処理コマンド AimeCommand::Scan でのみ有意な値を返す。ただしメンバ関数 isSegaIdRegistered が false を返す場合、この関数は nullptr を返す。

std::size_t amdaemon::AimeResult::getRelatedAimeIdCount ( ) const

SEGA ID に紐付くUID値の個数を取得する。

戻り値: UID値の個数。紐付いていないか、取得できなかった場合は 0 。

この関数はポーリング処理コマンド AimeCommand::Scan でのみ有意な値を返す。ただしメンバ関数 isSegaIdRegistered が false を返す場合、この関数は 0 を返す。

読み取ったAimeのUID値は含まない。

const AimeId& amdaemon::AimeResult::getRelatedAimeId ( std::size_t index ) const

SEGA ID に紐付くUID値を取得する。

引数

[in] index インデックス。

戻り値: UID値。

例外

Exception 引数 index にUID値個数以上の値を指定した場合。 UID値個数はメンバ関数 getRelatedAimeIdCount で取得できる。

この関数はポーリング処理コマンド AimeCommand::Scan でのみ有意な値を返す。

読み取ったAimeのUID値は含まない。読み取ったAimeのUID値を取得したい場合はメンバ関数 getAimeId を用いること。

このクラス詳解は次のファイルから抽出されました:

AimeResult.h

公開メンバ関数

詳解

構築子と解体子

関数詳解