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

#include <AimeErrorInfo.h>

amdaemon::AimeErrorInfo の継承関係図

amdaemon::AimeErrorInfo 連携図

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

AimeErrorId	getId () const
	内部エラーID値を取得する。 [詳解]

AimeErrorCategory	getCategory () const
	エラーカテゴリ値を取得する。 [詳解]

bool	isOccurred () const override
	エラーが発生しているか否かを取得する。 [詳解]

std::uint32_t	getNumber () const override
	エラー番号を取得する。 [詳解]

std::uint32_t	getSubNumber () const override
	サブエラー番号(枝番)を取得する。 [詳解]

const wchar_t *	getMessage () const override
	エラーメッセージを取得する。 [詳解]

const ::amdaemon::util::DateTime &	getTime () const override
	エラー発生日時を取得する。 [詳解]

基底クラス amdaemon::ErrorInfo に属する継承公開メンバ関数
	ErrorInfo ()
	コンストラクタ。 [詳解]

virtual	~ErrorInfo ()
	デストラクタ。 [詳解]

std::wstring	toString () const
	エラーの文字列表現値を作成する。 [詳解]

詳解

Aime関連エラー情報を提供するクラス。

参照: AimeUnit

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

構築子と解体子

amdaemon::AimeErrorInfo::AimeErrorInfo ( InnerIndexHolder )

explicit

コンストラクタ。

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

関数詳解

AimeErrorId amdaemon::AimeErrorInfo::getId ( ) const

内部エラーID値を取得する。

戻り値: 内部エラーID値。エラーが発生していなければ AimeErrorId::None 。

AimeErrorCategory amdaemon::AimeErrorInfo::getCategory ( ) const

エラーカテゴリ値を取得する。

戻り値: エラーカテゴリ値。エラーが発生していなければ AimeErrorCategory::None 。

Aime読み取りエラー発生時の処理をこの値で切り分けることができる。詳細は各 AimeErrorCategory 列挙値の説明を参照すること。

bool amdaemon::AimeErrorInfo::isOccurred ( ) const

inlineoverridevirtual

エラーが発生しているか否かを取得する。

戻り値

true	エラーが発生している場合。
false	エラーが発生していない場合。

条件式 (getId() != AimeErrorId::None) の結果を返す。

amdaemon::ErrorInfoを再実装しています。

std::uint32_t amdaemon::AimeErrorInfo::getNumber ( ) const

overridevirtual

エラー番号を取得する。

戻り値: エラー番号。エラーが発生していないか、エラー番号が定義されていなければ 0 。

エラーが発生していても、エラー番号が定義されていない場合は 0 を返す。エラーが発生しているか否かはメンバ関数 isOccurred で判別すること。

エラーメッセージ表示時にはこのエラー番号を同時に表示することが好ましい。

amdaemon::ErrorInfoを実装しています。

std::uint32_t amdaemon::AimeErrorInfo::getSubNumber ( ) const

overridevirtual

サブエラー番号(枝番)を取得する。

戻り値: サブエラー番号(枝番)。枝番が無いならば 0 。

エラーが発生しており、Aimeリーダーが 2 台以上接続されている場合は (ユニットインデックス + 1) を返す。
エラーが発生していないか、Aimeリーダーが 1 台のみの場合は常に 0 を返す。

amdaemon::ErrorInfoを実装しています。

const wchar_t* amdaemon::AimeErrorInfo::getMessage ( ) const

overridevirtual

エラーメッセージを取得する。

戻り値: エラーメッセージ。エラーが発生していなければ不定値。

エラーが発生していても、エラーメッセージが定義されていない場合は空文字列を返す。エラーが発生しているか否かはメンバ関数 isOccurred で判別すること。

amdaemon::ErrorInfoを実装しています。

const ::amdaemon::util::DateTime& amdaemon::AimeErrorInfo::getTime ( ) const

overridevirtual

エラー発生日時を取得する。

戻り値: エラー発生日時。エラーが発生していなければ不定値。

amdaemon::ErrorInfoを実装しています。

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

AimeErrorInfo.h

公開メンバ関数

詳解

構築子と解体子

関数詳解