amdaemon::CanPort クラス

CAN通信ポートの情報を提供するクラス。 [詳解]

#include <CanPort.h>

公開メンバ関数
	CanPort (InnerIndexHolder)
	コンストラクタ。 [詳解]
std::size_t	getTargetCount () const
	設定ファイルのポート定義内に記述したターゲット定義数(CANボード数)を取得する。 [詳解]
CanTarget &	getTarget (std::size_t targetIndex)
	ターゲット操作インスタンスを取得する。 [詳解]
const CanTarget &	getTarget (std::size_t targetIndex) const
	ターゲット操作インスタンスを取得する。 [詳解]
std::vector< std::reference_wrapper< CanTarget > >	getTargets ()
	ターゲット操作インスタンス配列を取得する。 [詳解]
std::vector< std::reference_wrapper< const CanTarget > >	getTargets () const
	ターゲット操作インスタンス配列を取得する。 [詳解]

詳解

CAN通信ポートの情報を提供するクラス。

参照

Can

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

構築子と解体子

amdaemon::CanPort::CanPort

(

InnerIndexHolder

)

コンストラクタ。

覚え書き

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

関数詳解

std::size_t amdaemon::CanPort::getTargetCount

(

)

const

設定ファイルのポート定義内に記述したターゲット定義数(CANボード数)を取得する。

戻り値

ターゲット定義数(CANボード数)。

CanTarget& amdaemon::CanPort::getTarget

(

std::size_t

targetIndex

)

ターゲット操作インスタンスを取得する。

引数

[in]

targetIndex

ポート定義内のターゲット定義インデックス。

戻り値

ターゲット操作インスタンス。

例外

Exception

引数 targetIndex にポート定義内のターゲット定義数以上の値を指定した場合。 ターゲット定義数はメンバ関数 getTargetCount で取得できる。

const CanTarget& amdaemon::CanPort::getTarget

(

std::size_t

targetIndex

)

const

ターゲット操作インスタンスを取得する。

引数

[in]

targetIndex

ポート定義内のターゲット定義インデックス。

戻り値

ターゲット操作インスタンス。

例外

Exception

引数 targetIndex にポート定義内のターゲット定義数以上の値を指定した場合。 ターゲット定義数はメンバ関数 getTargetCount で取得できる。

std::vector<std::reference_wrapper<CanTarget> > amdaemon::CanPort::getTargets ( )

inline

ターゲット操作インスタンス配列を取得する。

戻り値

ターゲット操作インスタンス配列。

範囲for文や各種アルゴリズム関数に渡すことを想定している。

• ターゲット定義数を知りたいだけならばメンバ関数 getTargetCount を用いること。
• 特定ターゲットを取得したいだけならばメンバ関数 getTarget を用いること。

std::vector<std::reference_wrapper<const CanTarget> > amdaemon::CanPort::getTargets ( ) const

inline

ターゲット操作インスタンス配列を取得する。

戻り値

ターゲット操作インスタンス配列。

範囲for文や各種アルゴリズム関数に渡すことを想定している。

• ターゲット定義数を知りたいだけならばメンバ関数 getTargetCount を用いること。
• 特定ターゲットを取得したいだけならばメンバ関数 getTarget を用いること。

---

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

• CanPort.h