OutputUnit クラスにスイッチ出力値を設定するラッパクラス。 [詳解]

#include <SwitchOutput.h>

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

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

void	set (std::size_t bitIndex, bool on, bool forceUpdate=false)
	スイッチ出力のON/OFF状態を設定する。 [詳解]

void	reset (std::size_t bitIndex, bool forceUpdate=false)
	スイッチ出力をOFF状態に設定する。 [詳解]

bool	isCurrentOn (std::size_t bitIndex) const
	現在のスイッチ出力設定がON状態であるか否かを取得する。 [詳解]

詳解

OutputUnit クラスにスイッチ出力値を設定するラッパクラス。

参照: Output, OutputUnit

出力をビット単位で行いたい場合等に用いる。

#include "amdaemon/Output.h"
namespace outputs
{
    // 定数宣言(実値は任意のソースファイルで定義する)
    extern const amdaemon::OutputId Led1;
    extern const amdaemon::OutputId Led2;
}
void foo()
{
    amdaemon::Output output;
    // OutputUnit インスタンスから取得
    auto led1 = output.getSystem().getSwitch(outputs::Led1);
    // LEDを先頭から2つ点灯
    led1.set(true, 0);
    led1.set(true, 1);
    // OutputUnit インスタンスから直接構築
    amdaemon::SwitchOutput led2(output.getSystem(), outputs::Led2);
    // LEDを先頭から2つ消灯
    led2.reset(0);
    led2.reset(1);
}

構築子と解体子

amdaemon::SwitchOutput::SwitchOutput	(	OutputUnit &	unit,
		const OutputId &	id
	)

inline

コンストラクタ。

引数

[in]	unit	OutputUnit インスタンス参照。
[in]	id	出力識別ID。

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

関数詳解

bool amdaemon::SwitchOutput::exists ( ) const

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

戻り値

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

void amdaemon::SwitchOutput::set	(	std::size_t	bitIndex,
		bool	on,
		bool	forceUpdate = `false`
	)

スイッチ出力のON/OFF状態を設定する。

引数

[in]	bitIndex	対象ビットインデックス。
[in]	on	ON状態にするならば true 。OFF状態にするならば false 。
[in]	forceUpdate	値が変化しない場合も更新要求するならば true 。既定値は false 。

例外

Exception 引数 bitIndex に有効ビット範囲外の値を指定した場合。

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

void amdaemon::SwitchOutput::reset	(	std::size_t	bitIndex,
		bool	forceUpdate = `false`
	)

inline

スイッチ出力をOFF状態に設定する。

引数

[in]	bitIndex	対象ビットインデックス。
[in]	forceUpdate	値が変化しない場合も更新要求するならば true 。既定値は false 。

例外

Exception 引数 bitIndex に有効ビット範囲外の値を指定した場合。

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

bool amdaemon::SwitchOutput::isCurrentOn ( std::size_t bitIndex ) const

現在のスイッチ出力設定がON状態であるか否かを取得する。

引数

[in] bitIndex 対象ビットインデックス。

戻り値

true	現在のスイッチ出力設定がON状態である場合。
false	現在のスイッチ出力設定がOFF状態であるか、出力が存在しない場合。

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

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

SwitchOutput.h

公開メンバ関数

詳解

構築子と解体子

関数詳解