AnalogOutput.h

[詳解]

/// @file
/// @brief OutputUnit クラスにアナログ出力値を設定するラッパクラス AnalogOutput のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_ANALOGOUTPUT_H
#define AMDAEMON_ANALOGOUTPUT_H

#include "amdaemon/env.h"
#include "amdaemon/OutputId.h"

namespace amdaemon
{
/// @addtogroup g_io
/// @{

    // OutputUnit クラスの前方宣言
    class OutputUnit;

    /// @brief OutputUnit クラスにアナログ出力値を設定するラッパクラス。
    /// @see Output, OutputUnit
    ///
    /// 出力を線形変換された値で行いたい場合等に用いる。
    class AnalogOutput
    {
    public:
        /// @brief コンストラクタ。
        /// @param[in] unit OutputUnit インスタンス参照。
        /// @param[in] id 出力識別ID。
        /// @param[in] minValue 線形変換された最小値として用いる値。
        /// @param[in] maxValue 線形変換された最大値として用いる値。
        ///
        /// @exception Exception
        /// 引数 minValue または maxValue に非数値(NAN等)を指定した場合。
        ///
        /// 引数 id に存在しない出力識別IDを指定した場合でも例外は発生しない。
        /// ただしメンバ関数 #exists は false を返す。
        ///
        /// (minValue >= maxValue) となるような値も指定可能である。
        /// その場合、アナログ出力設定値が単調増加すると直値が単調減少するような
        /// 計算が行われる。
        AnalogOutput(
            OutputUnit& unit,
            const OutputId& id,
            double minValue,
            double maxValue);

        /// @brief コンストラクタ。
        /// @param[in] unit OutputUnit インスタンス参照。
        /// @param[in] id 出力識別ID。
        /// @param[in] maxValue 線形変換された最大値として用いる値。既定値は 1.0 。
        ///
        /// @exception Exception
        /// 引数 maxValue に非数値(NAN等)を指定した場合。
        ///
        /// @ref #AnalogOutput "AnalogOutput(unit, id, 0, maxValue)" と同義。
        AnalogOutput(
            OutputUnit& unit,
            const OutputId& id,
            double maxValue = 1);

        // 下記は暗黙の定義を用いる。
        //AnalogOutput(const AnalogOutput&) = default;
        //‾AnalogOutput() = default;
        //AnalogOutput& operator=(const AnalogOutput&) = default;

        /// @brief 出力が存在するか否かを取得する。
        /// @retval true  存在する場合。
        /// @retval false 存在しない場合。
        bool exists() const;

        /// @brief 線形変換された出力値を設定する。
        /// @param[in] value 線形変換された出力値。
        /// @param[in] forceUpdate
        ///     値が変化しない場合も更新要求するならば true 。既定値は false 。
        ///
        /// @exception Exception
        /// 引数 value に有効範囲外の値を指定した場合。
        ///
        /// 出力が存在しない場合は何もしない。
        void setValue(double value, bool forceUpdate = false);

        /// @brief 現在の出力値を線形変換した値を取得する。
        /// @return 現在の出力値を線形変換した値。出力が存在しない場合は最小値。
        ///
        /// 現在ライブラリ内で保持している値を線形変換して返す。
        /// 起動直後などは、実デバイスにこの値が設定されているとは限らない。
        double getCurrentValue() const;

        /// @brief 線形変換された最小値として用いる値を取得する。
        /// @return 線形変換された最小値として用いる値。
        ///
        /// メンバ関数 #getMaxValue の戻り値より大きい値になりうる。
        double getMinValue() const
        {
            return _minValue;
        }

        /// @brief 線形変換された最大値として用いる値を取得する。
        /// @return 線形変換された最大値として用いる値。
        ///
        /// メンバ関数 #getMinValue の戻り値より小さい値になりうる。
        double getMaxValue() const
        {
            return _maxValue;
        }

    private:
        OutputUnit* _unit;  ///< OutputUnit インスタンス参照。
        OutputId _id;       ///< 出力識別ID。
        double _minValue;   ///< 線形変換された最小値として用いる値。
        double _maxValue;   ///< 線形変換された最大値として用いる値。
    };

/// @}
} // namespace amdaemon

#endif // AMDAEMON_ANALOGOUTPUT_H