Aime関連処理を提供するMonostateクラス Aime とその関連定義。 [詳解]

Aime : Aime 連携図

クラス
class	amdaemon::Aime
	Aime関連処理を提供するMonostateクラス。 [詳解]

class	amdaemon::AimeErrorInfo
	Aime関連エラー情報を提供するクラス。 [詳解]

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

class	amdaemon::AimeUnit
	Aimeリーダー単体の処理を提供するクラス。 [詳解]

struct	amdaemon::AccessCode
	アクセスコード値構造体。 [詳解]

struct	amdaemon::AimeCampaignInfo
	Aimeキャンペーン情報を保持する構造体。 [詳解]

struct	amdaemon::AimeCampaignProgress
	Aimeキャンペーンの進捗状況を保持する構造体。 [詳解]

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

struct	amdaemon::AimeOfflineId
	オフラインでAimeを識別するためのID値構造体。 [詳解]

struct	amdaemon::FeliCaId
	FeliCa IDm/PMm をラップする構造体。 [詳解]

列挙型
enum	amdaemon::AimeCommand { amdaemon::AimeCommand::ScanOffline, amdaemon::AimeCommand::Scan }
	Aimeポーリング処理コマンド列挙。 [詳解]

enum	amdaemon::AimeConfirm { amdaemon::AimeConfirm::None, amdaemon::AimeConfirm::FeliCaDB, amdaemon::AimeConfirm::AimeDB }
	Aime登録に関する要確認事項種別列挙。 [詳解]

enum	amdaemon::AimeErrorCategory { amdaemon::AimeErrorCategory::None, amdaemon::AimeErrorCategory::Warning, amdaemon::AimeErrorCategory::Network, amdaemon::AimeErrorCategory::Fatal, amdaemon::AimeErrorCategory::Unknown }
	Aimeエラーカテゴリ列挙。 [詳解]

enum	amdaemon::AimeErrorId { amdaemon::AimeErrorId::None, amdaemon::AimeErrorId::ReaderSetupFail, amdaemon::AimeErrorId::ReaderFirmFileInvalid, amdaemon::AimeErrorId::ReaderFirmUpToDate, amdaemon::AimeErrorId::ReaderAccessFail, amdaemon::AimeErrorId::ReaderTimeout, amdaemon::AimeErrorId::ReaderIncompatible, amdaemon::AimeErrorId::ReaderTwoOrMore, amdaemon::AimeErrorId::DBResolveFail, amdaemon::AimeErrorId::DBAccessTimeout, amdaemon::AimeErrorId::DBAccessFail, amdaemon::AimeErrorId::FeliCaInvalid, amdaemon::AimeErrorId::FeliCaNotFound, amdaemon::AimeErrorId::FeliCaRegisterFail, amdaemon::AimeErrorId::AimeIdInvalid, amdaemon::AimeErrorId::AimeIdNotFound, amdaemon::AimeErrorId::AimeIdRegisterFail, amdaemon::AimeErrorId::FeliCaRequired, amdaemon::AimeErrorId::CardRequired, amdaemon::AimeErrorId::NoBoardInfo, amdaemon::AimeErrorId::LogRegisterFail, amdaemon::AimeErrorId::FeliCaRegistered, amdaemon::AimeErrorId::AimeIdRegistered, amdaemon::AimeErrorId::LockBanSystemUser, amdaemon::AimeErrorId::LockBanSystem, amdaemon::AimeErrorId::LockBanUser, amdaemon::AimeErrorId::LockBan, amdaemon::AimeErrorId::LockSystemUser, amdaemon::AimeErrorId::LockSystem, amdaemon::AimeErrorId::LockUser, amdaemon::AimeErrorId::ReaderFirmUpdateFail, amdaemon::AimeErrorId::CampaignInfoFail, amdaemon::AimeErrorId::ReaderDetectFail, amdaemon::AimeErrorId::FeliCaComFail }
	Aime内部エラーID列挙。 [詳解]

enum	amdaemon::AimeLedStatus { amdaemon::AimeLedStatus::None, amdaemon::AimeLedStatus::Scanning, amdaemon::AimeLedStatus::Success, amdaemon::AimeLedStatus::Warning, amdaemon::AimeLedStatus::Error }
	AimeのLED点灯ステータス列挙。 [詳解]

enum	amdaemon::AimeLogStatus { amdaemon::AimeLogStatus::Enter, amdaemon::AimeLogStatus::Continue, amdaemon::AimeLogStatus::Leave }
	Aimeログステータス列挙。 [詳解]

関数
const wchar_t *	amdaemon::toString (AimeCommand command)
	AimeCommand 列挙値の文字列表現値を取得する。 [詳解]

const wchar_t *	amdaemon::toString (AimeConfirm confirm)
	AimeConfirm 列挙値の文字列表現値を取得する。 [詳解]

const wchar_t *	amdaemon::toString (AimeErrorCategory category)
	AimeErrorCategory 列挙値の文字列表現値を取得する。 [詳解]

const wchar_t *	amdaemon::toString (AimeErrorId id)
	AimeErrorId 列挙値の文字列表現値を取得する。 [詳解]

AimeErrorCategory	amdaemon::getCategory (AimeErrorId id)
	AimeErrorId 列挙値に対応する AimeErrorCategory 列挙値を取得する。 [詳解]

const wchar_t *	amdaemon::toString (AimeLedStatus status)
	AimeLedStatus 列挙値の文字列表現値を取得する。 [詳解]

const wchar_t *	amdaemon::toString (AimeLogStatus status)
	AimeLogStatus 列挙値の文字列表現値を取得する。 [詳解]

変数
static const std::size_t	amdaemon::AimeCampaignCountLimit
	1タイトルで同時に開催可能なAimeキャンペーンの最大数。 [詳解]

詳解

Aime関連処理を提供するMonostateクラス Aime とその関連定義。

列挙型詳解

enum amdaemon::AimeCommand

strong

Aimeポーリング処理コマンド列挙。

列挙値
ScanOffline	オフライン用ID(アクセスコードまたはFeliCaID)の読み取り処理。
Scan	UID値の読み取り処理。AimeDBやFeliCaDBへのアクセスを行う。 ScanOffline の処理を含む。

enum amdaemon::AimeConfirm

strong

Aime登録に関する要確認事項種別列挙。

列挙値
None	確認事項なし。
FeliCaDB	FeliCaDBへの登録許諾確認。
AimeDB	AimeDBへの登録許諾確認。

enum amdaemon::AimeErrorCategory

strong

Aimeエラーカテゴリ列挙。

AM Daemon 用に定めたカテゴリ分けであり、Aime仕様ではない。

列挙値
None	エラーなし。
Warning	リトライ可能なエラー。不正なカードをかざした場合等、リトライ可能な軽度のエラー。 Daemonプロセスが自動的にLEDをエラー点灯させるため、LED制御は不要。 Aime読み取りエラー音を鳴らすこと。リトライで成功する可能性が高いため、再度 AimeUnit::start でポーリング処理を開始してもよい。リトライする場合、特にエラー情報の画面表示は行わなくとも構わない。 LEDがエラー点灯状態から消灯状態になるまで待機してからリトライすること。 LED点灯ステータスは AimeUnit::getLedStatus で確認できる。
Network	ネットワークエラー。 DBサーバアクセス失敗等、ネットワークが関係するエラー。リトライ不可能ではないが、リトライしても同様のエラーが発生する可能性が高い。共通 Aime読み取りエラー音を鳴らすこと。ネットワークエラーである旨を画面表示すること。 Aime必須である場合 AimeUnit::setLedStatus(AimeLedStatus::Error) でLEDをエラー点灯させること。 Aimeなしプレイに移行できる場合 AimeUnit::setLedStatus(AimeLedStatus::Warning) でLEDを警告点灯させること。
Fatal	重度のエラー。ファームウェア更新失敗時およびAimeリーダー非接続時に発生する重度のエラー。単にリトライするだけでは必ず同様のエラーが発生し続ける。当該Aimeリーダーが必須である場合 Error クラスで進行停止エラーが発生するため、進行停止エラー発生時の処理を行うこと。当該Aimeリーダーが必須ではない場合 LEDは正常に点灯できない可能性が高いため制御不要。 Aime読み取りエラー音を鳴らすこと。エラー情報を画面表示すること。
Unknown	アプリには返さないエラー。内部エラーとの対応のために定義されている。 AM Daemon がこのカテゴリのエラーを返すことはない。

enum amdaemon::AimeErrorId

strong

Aime内部エラーID列挙。

AiMeLibの AiMeDef::eAiMeError 列挙に対応している。 AM Daemon では返すことのないエラーも含まれる。

列挙値
None	エラーなし。
ReaderSetupFail	リーダー初期化失敗。
ReaderFirmFileInvalid	リーダーファームウェアファイル不正。
ReaderFirmUpToDate	リーダーファームウェア更新済み。
ReaderAccessFail	リーダーアクセス失敗。
ReaderTimeout	リーダーカード検出タイムアウト。
ReaderIncompatible	互換性のないカードを検出。
ReaderTwoOrMore	2枚以上のカードを検出。
DBResolveFail	DBサーバ名前解決失敗。
DBAccessTimeout	DBサーバアクセスタイムアウト。
DBAccessFail	DBサーバアクセスエラー。
FeliCaInvalid	無効なFeliCaを検出。
FeliCaNotFound	FeliCa未登録。
FeliCaRegisterFail	FeliCa登録失敗。
AimeIdInvalid	無効なUIDを検出。
AimeIdNotFound	UID未登録。
AimeIdRegisterFail	UID登録失敗。
FeliCaRequired	FeliCa非検出。
CardRequired	Aimeカード非検出。
NoBoardInfo	基板情報未設定。
LogRegisterFail	ログ登録失敗。
FeliCaRegistered	FeliCa登録済み。
AimeIdRegistered	UID登録済み。
LockBanSystemUser	BANシステムユーザーロック状態。
LockBanSystem	BANシステムロック状態。
LockBanUser	BANユーザーロック状態。
LockBan	BANロック状態。
LockSystemUser	システムユーザーロック状態。
LockSystem	システムロック状態。
LockUser	ユーザーロック状態。
ReaderFirmUpdateFail	リーダーファームウェア更新失敗。
CampaignInfoFail	キャンペーン情報取得失敗。
ReaderDetectFail	リーダーカード検出失敗。
FeliCaComFail	FeliCa通信失敗。

enum amdaemon::AimeLedStatus

strong

AimeのLED点灯ステータス列挙。

AimeUnit クラスの説明およびAime作成基準を参照すること。

列挙値
None	ステータスなし。明示的に指定した場合は消灯する。
Scanning	読み取り処理中の白点灯。別のLED制御が行われるまで点灯し続ける。
Success	読み取り成功時の青点灯。一定時間点灯後に消灯する。
Warning	オフライン動作時等の黄点灯。一定時間点灯後に消灯する。
Error	読み取り失敗時の赤点灯。一定時間点灯後に消灯する。

enum amdaemon::AimeLogStatus

strong

Aimeログステータス列挙。

列挙値
Enter	ゲームプレイ開始。
Continue	コンティニュー。
Leave	ゲームプレイ終了。

関数詳解

const wchar_t* amdaemon::toString ( AimeCommand command )

AimeCommand 列挙値の文字列表現値を取得する。

引数

[in] command AimeCommand 列挙値。

戻り値: AimeCommand 列挙値の文字列表現値。不正値の場合は nullptr 。

const wchar_t* amdaemon::toString ( AimeConfirm confirm )

AimeConfirm 列挙値の文字列表現値を取得する。

引数

[in] confirm AimeConfirm 列挙値。

戻り値: AimeConfirm 列挙値の文字列表現値。不正値の場合は nullptr 。

const wchar_t* amdaemon::toString ( AimeErrorCategory category )

AimeErrorCategory 列挙値の文字列表現値を取得する。

引数

[in] category AimeErrorCategory 列挙値。

戻り値: AimeErrorCategory 列挙値の文字列表現値。不正値の場合は nullptr 。

const wchar_t* amdaemon::toString ( AimeErrorId id )

AimeErrorId 列挙値の文字列表現値を取得する。

引数

[in] id AimeErrorId 列挙値。

戻り値: AimeErrorId 列挙値の文字列表現値。不正値の場合は nullptr 。

AimeErrorCategory amdaemon::getCategory ( AimeErrorId id )

AimeErrorId 列挙値に対応する AimeErrorCategory 列挙値を取得する。

引数

[in] id AimeErrorId 列挙値。

戻り値: AimeErrorCategory 列挙値。

例外

Exception 引数 id に不正な値を指定した場合。

const wchar_t* amdaemon::toString ( AimeLedStatus status )

AimeLedStatus 列挙値の文字列表現値を取得する。

引数

[in] status AimeLedStatus 列挙値。

戻り値: AimeLedStatus 列挙値の文字列表現値。不正値の場合は nullptr 。

const wchar_t* amdaemon::toString ( AimeLogStatus status )

AimeLogStatus 列挙値の文字列表現値を取得する。

引数

[in] status AimeLogStatus 列挙値。

戻り値: AimeLogStatus 列挙値の文字列表現値。不正値の場合は nullptr 。

変数詳解

const std::size_t amdaemon::AimeCampaignCountLimit

static

1タイトルで同時に開催可能なAimeキャンペーンの最大数。