OutputUnit クラスにアナログ出力値を設定するラッパクラス。 [詳解]

#include <AnalogOutput.h>

公開メンバ関数
	AnalogOutput (OutputUnit &unit, const OutputId &id, double minValue, double maxValue)
	コンストラクタ。 [詳解]

	AnalogOutput (OutputUnit &unit, const OutputId &id, double maxValue=1)
	コンストラクタ。 [詳解]

bool	exists () const
	出力が存在するか否かを取得する。 [詳解]

void	setValue (double value, bool forceUpdate=false)
	線形変換された出力値を設定する。 [詳解]

double	getCurrentValue () const
	現在の出力値を線形変換した値を取得する。 [詳解]

double	getMinValue () const
	線形変換された最小値として用いる値を取得する。 [詳解]

double	getMaxValue () const
	線形変換された最大値として用いる値を取得する。 [詳解]

詳解

OutputUnit クラスにアナログ出力値を設定するラッパクラス。

参照: Output, OutputUnit

出力を線形変換された値で行いたい場合等に用いる。

構築子と解体子

amdaemon::AnalogOutput::AnalogOutput	(	OutputUnit &	unit,
		const OutputId &	id,
		double	minValue,
		double	maxValue
	)

コンストラクタ。

引数

[in]	unit	OutputUnit インスタンス参照。
[in]	id	出力識別ID。
[in]	minValue	線形変換された最小値として用いる値。
[in]	maxValue	線形変換された最大値として用いる値。

例外

Exception 引数 minValue または maxValue に非数値(NAN等)を指定した場合。

引数 id に存在しない出力識別IDを指定した場合でも例外は発生しない。ただしメンバ関数 exists は false を返す。

(minValue >= maxValue) となるような値も指定可能である。その場合、アナログ出力設定値が単調増加すると直値が単調減少するような計算が行われる。

amdaemon::AnalogOutput::AnalogOutput	(	OutputUnit &	unit,
		const OutputId &	id,
		double	maxValue = `1`
	)

コンストラクタ。

引数

[in]	unit	OutputUnit インスタンス参照。
[in]	id	出力識別ID。
[in]	maxValue	線形変換された最大値として用いる値。既定値は 1.0 。

例外

Exception 引数 maxValue に非数値(NAN等)を指定した場合。

AnalogOutput(unit, id, 0, maxValue) と同義。

関数詳解

bool amdaemon::AnalogOutput::exists ( ) const

出力が存在するか否かを取得する。

戻り値

true	存在する場合。
false	存在しない場合。

void amdaemon::AnalogOutput::setValue	(	double	value,
		bool	forceUpdate = `false`
	)

線形変換された出力値を設定する。

引数

[in]	value	線形変換された出力値。
[in]	forceUpdate	値が変化しない場合も更新要求するならば true 。既定値は false 。

例外

Exception 引数 value に有効範囲外の値を指定した場合。

出力が存在しない場合は何もしない。

double amdaemon::AnalogOutput::getCurrentValue ( ) const

現在の出力値を線形変換した値を取得する。

戻り値: 現在の出力値を線形変換した値。出力が存在しない場合は最小値。

現在ライブラリ内で保持している値を線形変換して返す。起動直後などは、実デバイスにこの値が設定されているとは限らない。

double amdaemon::AnalogOutput::getMinValue ( ) const

inline

線形変換された最小値として用いる値を取得する。

戻り値: 線形変換された最小値として用いる値。

メンバ関数 getMaxValue の戻り値より大きい値になりうる。

double amdaemon::AnalogOutput::getMaxValue ( ) const

inline

線形変換された最大値として用いる値を取得する。

戻り値: 線形変換された最大値として用いる値。

メンバ関数 getMinValue の戻り値より小さい値になりうる。

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

AnalogOutput.h

公開メンバ関数

詳解

構築子と解体子

関数詳解