JvsGeneralOutput.h

[詳解]

/// @file
/// @brief JVS汎用ドライバ出力処理を行うクラス JvsGeneralOutput のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_JVSGENERALOUTPUT_H
#define AMDAEMON_JVSGENERALOUTPUT_H

#include "amdaemon/env.h"

#include <cstdint>
#include <cstddef>

namespace amdaemon
{
/// @addtogroup g_jvs
/// @{

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

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

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

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

        /// @brief 出力するビット列を設定する。
        /// @param[in] bits 出力するビット列。
        /// @param[in] forceUpdate
        ///     値が変化しない場合も更新要求するならば true 。既定値は false 。
        ///
        /// この関数で指定しても即座に更新されるわけではなく、
        /// Core クラスのメンバ関数 Core#execute 呼び出しによって更新される。
        void setBits(std::uint64_t bits, bool forceUpdate = false);

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

        /// @brief 出力するビット値を設定する。
        /// @param[in] bitIndex ビットインデックス。
        /// @param[in] on ビットを立てるならば true 。下ろすならば false 。
        /// @param[in] forceUpdate
        ///     値が変化しない場合も更新要求するならば true 。既定値は false 。
        ///
        /// @exception Exception
        /// 引数 bitIndex に #MaxBitCount 以上の値を指定した場合。
        ///
        /// この関数で指定しても即座に更新されるわけではなく、
        /// Core クラスのメンバ関数 Core#execute 呼び出しによって更新される。
        void setBit(std::size_t bitIndex, bool on, bool forceUpdate = false);

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

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

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

/// @}
} // namespace amdaemon

#endif // AMDAEMON_JVSGENERALOUTPUT_H