BoardIODef.h

[詳解]

/// @file
/// @brief DipSwitch、PushSwitch、LEDの定数定義を提供するヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_BOARDIODEF_H
#define AMDAEMON_BOARDIODEF_H

#include "amdaemon/env.h"

#include <cstddef>

namespace amdaemon
{
/// @addtogroup g_boardio
/// @{

    /// @brief DipSwitch位置定義列挙。
    ///
    /// Nuシリーズにおける定義を表す。
    /// ALLSシリーズではすべてアプリ定義となる。
    enum class DipSwitchPos : std::size_t
    {
        App1 = 0,       ///< アプリ定義1
        App2,           ///< アプリ定義2
        App3,           ///< アプリ定義3
        MonitorAngle,   ///< モニタ縦横設定
        Resolution1,    ///< モニタ解像度設定1
        Resolution2,    ///< モニタ解像度設定2
        Resolution3,    ///< モニタ解像度設定3
        Reserved,       ///< 予約
    };

    /// DipSwitch個数。
    static const std::size_t DipSwitchCount = 8;

    /// PushSwitch個数。
    static const std::size_t PushSwitchCount = 2;

    /// LED個数。
    static const std::size_t BoardLedCount = 2;

    /// @brief @ref DipSwitchPos 列挙値の文字列表現値を取得する。
    /// @param[in] pos @ref DipSwitchPos 列挙値。
    /// @return @ref DipSwitchPos 列挙値の文字列表現値。不正値の場合は nullptr 。
    /// @internal ライブラリ実装メモ: enumsToString.cpp で実装。
    const wchar_t* toString(DipSwitchPos pos);

/// @}
} // namespace amdaemon

#endif // AMDAEMON_BOARDIODEF_H