CAN通信処理を提供するMonostateクラス。 [詳解]

#include <Can.h>

公開メンバ関数
bool	isAvailable () const
	CAN通信機能を利用可能であるか否かを取得する。 [詳解]

std::size_t	getPortCount () const
	設定ファイルに記述したポート定義数を取得する。 [詳解]

CanPort &	getPort (std::size_t portIndex)
	ポート情報インスタンスを取得する。 [詳解]

const CanPort &	getPort (std::size_t portIndex) const
	ポート情報インスタンスを取得する。 [詳解]

std::vector< std::reference_wrapper< CanPort > >	getPorts ()
	ポート情報インスタンス配列を取得する。 [詳解]

std::vector< std::reference_wrapper< const CanPort > >	getPorts () const
	ポート情報インスタンス配列を取得する。 [詳解]

詳解

CAN通信処理を提供するMonostateクラス。

参照: Input

Core クラスのメンバ関数 Core::execute 呼び出しによって内容が更新される。

CAN I/O ボード 837-15257 およびその互換ボードから自動送信されるスイッチ入力等を扱う場合は、このクラスではなく Input クラスを用いること。

プラットフォーム情報

ALLSシリーズではCAN機能は利用できない。
ALLSシリーズの場合、常にポート定義数 0 として扱われる。

関数詳解

bool amdaemon::Can::isAvailable ( ) const

inline

CAN通信機能を利用可能であるか否かを取得する。

戻り値

true	利用可能である場合。
false	機能が無効である場合。

条件式 (getPortCount() > 0) の結果を返す。

std::size_t amdaemon::Can::getPortCount ( ) const

設定ファイルに記述したポート定義数を取得する。

戻り値: ポート定義数。

CanPort& amdaemon::Can::getPort ( std::size_t portIndex )

ポート情報インスタンスを取得する。

引数

[in] portIndex ポート定義インデックス。ポート番号ではないことに注意。

戻り値: ポート情報インスタンス。

例外

Exception 引数 portIndex にポート定義数以上の値を指定した場合。ポート定義数はメンバ関数 getPortCount で取得できる。

const CanPort& amdaemon::Can::getPort ( std::size_t portIndex ) const

ポート情報インスタンスを取得する。

引数

[in] portIndex ポート定義インデックス。ポート番号ではないことに注意。

戻り値: ポート情報インスタンス。

例外

Exception 引数 portIndex にポート定義数以上の値を指定した場合。ポート定義数はメンバ関数 getPortCount で取得できる。

std::vector<std::reference_wrapper<CanPort> > amdaemon::Can::getPorts ( )

inline

ポート情報インスタンス配列を取得する。

戻り値: ポート情報インスタンス配列。

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

ポート定義数を知りたいだけならばメンバ関数 getPortCount を用いること。
特定ポート情報を取得したいだけならばメンバ関数 getPort を用いること。

std::vector<std::reference_wrapper<const CanPort> > amdaemon::Can::getPorts ( ) const

inline

ポート情報インスタンス配列を取得する。

戻り値: ポート情報インスタンス配列。

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

ポート定義数を知りたいだけならばメンバ関数 getPortCount を用いること。
特定ポート情報を取得したいだけならばメンバ関数 getPort を用いること。

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

Can.h

公開メンバ関数

詳解

関数詳解