UsbIOGeneralOutput.h

[詳解]

/// @file
/// @brief USB I/O の汎用出力処理を行うクラス UsbIOGeneralOutput のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_USBIOGENERALOUTPUT_H
#define AMDAEMON_USBIOGENERALOUTPUT_H

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

#include <cstdint>
#include <cstddef>

namespace amdaemon
{
/// @addtogroup g_usbio
/// @{

    // 内部クラスの前方宣言
    class InnerIndexHolder;

    /// @brief USB I/O の汎用出力処理を行うクラス。
    /// @see UsbIO, UsbIONode
    ///
    /// このクラスのインスタンスをアプリ側で直接生成することはできない。
    /// UsbIONode クラスのメンバ関数 UsbIONode#getGeneralOutput から取得すること。
    class UsbIOGeneralOutput
    {
    public:
        /// 最大有効ビット数。
        static const std::size_t MaxBitCount = 64;

    public:
        /// @brief コンストラクタ。
        /// @note アプリ側からは利用できない。
        explicit UsbIOGeneralOutput(InnerIndexHolder);

        // 下記は暗黙の定義を用いる。
        //‾UsbIOGeneralOutput();

        /// @brief 出力するビット列を設定する。
        /// @param[in] bits 出力するビット列。
        /// @param[in] forceUpdate
        ///     値が変化しない場合も更新要求するならば true 。既定値は false 。
        /// @return 要求状態値。更新不要ならば無効値。
        ///
        /// この関数を呼び出しても即座に出力されるわけではない。
        /// 反映状況は戻り値の要求状態値で確認できる。
        ///
        /// 引数 forceUpdate が false かつ値が変化しない場合、更新不要と判断される。
        /// その場合、戻り値の要求状態値は無効値となる。
        ///
        /// この関数を同一フレーム内で複数回呼びだした場合、
        /// 最後の呼び出し時に指定した値のみが反映される。
        RequestState setBits(std::uint64_t bits, bool forceUpdate = false);

        /// @brief 出力するビット列をリセットする。
        /// @param[in] forceUpdate
        ///     値が変化しない場合も更新要求するならば true 。既定値は false 。
        /// @return 要求状態値。
        ///
        /// メンバ関数 #setBits を第1引数値 0 で呼び出すことと同義。
        RequestState resetBits(bool forceUpdate = false)
        {
            return this->setBits(0, forceUpdate);
        }

        /// @brief 出力するビット値を設定する。
        /// @param[in] bitIndex ビットインデックス。
        /// @param[in] on ビットを立てるならば true 。下ろすならば false 。
        /// @param[in] forceUpdate
        ///     値が変化しない場合も更新要求するならば true 。既定値は false 。
        /// @return 要求状態値。
        ///
        /// @exception Exception
        /// 引数 bitIndex に #MaxBitCount 以上の値を指定した場合。
        ///
        /// この関数を呼び出しても即座に出力されるわけではない。
        /// 反映状況は戻り値の要求状態値で確認できる。
        ///
        /// 引数 forceUpdate が false かつ値が変化しない場合、更新不要と判断される。
        /// その場合、戻り値の要求状態値は無効値となる。
        ///
        /// この関数を同一フレーム内で同一ビットインデックスに対して複数回呼びだした場合、
        /// 最後の呼び出し時に指定した値のみが反映される。
        /// 異なるビットインデックスに対して呼びだした場合はマージされる。
        RequestState setBit(std::size_t bitIndex, bool on, bool forceUpdate = false);

        /// @brief 現在設定されているビット列を取得する。
        /// @return 現在設定されているビット列。
        ///
        /// 現在ライブラリ内で保持しているビット列を返す。
        /// 起動直後などは、実デバイスにこの値が設定されているとは限らない。
        std::uint64_t getCurrentBits() const;

    private:
        std::size_t _nodeIndex; ///< ノードインデックス。

    private:
        // コピー禁止
        UsbIOGeneralOutput(const UsbIOGeneralOutput&);              // 宣言のみ
        UsbIOGeneralOutput& operator=(const UsbIOGeneralOutput&);   // 宣言のみ
    };

/// @}
} // namespace amdaemon

#endif // AMDAEMON_USBIOGENERALOUTPUT_H