UsbIOAnalogInput.h

[詳解]

/// @file
/// @brief USB I/O のアナログ入力情報を提供するクラス UsbIOAnalogInput のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_USBIOANALOGINPUT_H
#define AMDAEMON_USBIOANALOGINPUT_H

#include "amdaemon/env.h"
#include "amdaemon/util/container.h"

#include <vector>
#include <cstdint>
#include <cstddef>

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

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

    /// @brief USB I/O のアナログ入力情報を提供するクラス。
    /// @see UsbIO, UsbIONode
    ///
    /// このクラスのインスタンスをアプリ側で直接生成することはできない。
    /// UsbIONode クラスのメンバ関数 UsbIONode#getAnalogInput から取得すること。
    class UsbIOAnalogInput
    {
    public:
        /// @brief コンストラクタ。
        /// @note アプリ側からは利用できない。
        explicit UsbIOAnalogInput(InnerIndexHolder);

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

        /// @brief チャンネル数を取得する。
        /// @return チャンネル数。
        std::size_t getChannelCount() const;

        /// @brief 有効ビット数を取得する。
        /// @return 有効ビット数。
        ///
        /// メンバ関数 #getValue で取得するアナログ値が上位何ビットまで有効であるかを返す。
        /// 例えばこの関数が 10 を返す場合、下位 6 ビットは常に 0 となる。
        std::size_t getValidBitCount() const;

        /// @brief 指定チャンネルのアナログ入力値を取得する。
        /// @param[in] channelIndex チャンネルインデックス。
        /// @return アナログ入力値。
        ///
        /// @exception Exception
        /// 引数 channelIndex にチャンネル数以上の値を指定した場合。
        /// チャンネル数はメンバ関数 #getChannelCount で取得できる。
        ///
        /// 具体的な値の意味はデバイス依存である。
        /// 多くのデバイスは 0x8000 が中点となるように設計されている。
        std::uint16_t getValue(std::size_t channelIndex) const;

        /// @brief アナログ入力値配列を取得する。
        /// @return アナログ入力値配列。
        ///
        /// 範囲for文や各種アルゴリズム関数に渡すことを想定している。
        ///
        /// - チャンネル数を知りたいだけならばメンバ関数 #getChannelCount を用いること。
        /// - 特定チャンネルのアナログ入力値を取得したいだけならばメンバ関数
        ///   #getValue を用いること。
        std::vector<std::uint16_t> getValues() const
        {
            return
                ::amdaemon::util::toContainer<decltype(getValues())>(
                    getChannelCount(),
                    [this](std::size_t i) { return getValue(i); });
        }

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

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

/// @}
} // namespace amdaemon

#endif // AMDAEMON_USBIOANALOGINPUT_H