amdaemon::CanTargetProperty クラス

CANボード単体の情報を提供するクラス。 [詳解]

#include <CanTargetProperty.h>

公開メンバ関数
	CanTargetProperty (InnerIndexHolder, InnerIndexHolder)
	コンストラクタ。 [詳解]
bool	valid () const
	有効な情報を保持しているか否かを取得する。 [詳解]
CanTargetType	getType () const
	ターゲット分類を取得する。 [詳解]
std::uint16_t	getId () const
	ボードID値を取得する。 [詳解]
const wchar_t *	getProduct () const
	ボード品番文字列を取得する。 [詳解]
const wchar_t *	getCustomChip () const
	カスタムチップ品番文字列を取得する。 [詳解]
std::uint16_t	getFirmRevision () const
	ファームウェアリビジョン値を取得する。 [詳解]
std::uint16_t	getFirmSum () const
	ファームウェアチェックサム値を取得する。 [詳解]

詳解

CANボード単体の情報を提供するクラス。

参照

CanTarget

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

構築子と解体子

amdaemon::CanTargetProperty::CanTargetProperty	(	InnerIndexHolder	,
		InnerIndexHolder
	)

コンストラクタ。

覚え書き

アプリ側からは利用できない。

関数詳解

bool amdaemon::CanTargetProperty::valid ( ) const

inline

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

戻り値

true	保持している場合。
false	保持していないか、情報未取得である場合。

• 現時点の実装では、 Core クラスのメンバ関数 Core::isReady が true を返すとこの関数も true を返すようになる。
  • 将来ファームウェア更新処理等が実装された場合にはこの限りではない。
• この関数が false を返す場合、他のメンバ関数が返す値を信用してはならない。

CanTargetType amdaemon::CanTargetProperty::getType

(

)

const

ターゲット分類を取得する。

戻り値

ターゲット分類。情報未取得である場合は不定値。

std::uint16_t amdaemon::CanTargetProperty::getId

(

)

const

ボードID値を取得する。

戻り値

ボードID値。 1 以上 29 以下。情報未取得である場合は 0 。

const wchar_t* amdaemon::CanTargetProperty::getProduct

(

)

const

ボード品番文字列を取得する。

戻り値

ボード品番文字列。情報未取得である場合は不定値。

const wchar_t* amdaemon::CanTargetProperty::getCustomChip

(

)

const

カスタムチップ品番文字列を取得する。

戻り値

カスタムチップ品番文字列。情報未取得である場合は不定値。

std::uint16_t amdaemon::CanTargetProperty::getFirmRevision

(

)

const

ファームウェアリビジョン値を取得する。

戻り値

ファームウェアリビジョン値。最大 255 。情報未取得である場合は不定値。

std::uint16_t amdaemon::CanTargetProperty::getFirmSum

(

)

const

ファームウェアチェックサム値を取得する。

戻り値

ファームウェアチェックサム値。情報未取得である場合は不定値。

---

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

• CanTargetProperty.h