CanTargetType.h

[詳解]

/// @file
/// @brief CANターゲットの分類を定義する列挙 CanTargetType のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_CANTARGETTYPE_H
#define AMDAEMON_CANTARGETTYPE_H

#include "amdaemon/env.h"

namespace amdaemon
{
/// @addtogroup g_can
/// @{

    /// @brief CANターゲットの分類を定義する列挙。
    ///
    /// CAN共通プロトコル仕様における BD Class を表す。
    enum class CanTargetType
    {
        Host = 0,   ///< ホスト。
        Motor,      ///< モーターボード。
        Sensor,     ///< センサーボード。
        IO,         ///< I/Oボード。
        Led,        ///< LEDボード。
        Reserved,   ///< 予約。
    };

    /// @brief CANターゲット種別文字列から @ref CanTargetType 列挙値を作成する。
    /// @param[in] value CANターゲット種別文字列。
    /// @param[in] defaultType どの種別にも該当しなかった場合の戻り値。
    /// @return @ref CanTargetType 列挙値。どの種別にも該当しなかった場合は defaultType 。
    /// @see toString(CanTargetType)
    CanTargetType makeCanTargetType(
        const wchar_t* value,
        CanTargetType defaultType = CanTargetType::Reserved);

    /// @brief @ref CanTargetType 列挙値の文字列表現値を取得する。
    /// @param[in] type @ref CanTargetType 列挙値。
    /// @return @ref CanTargetType 列挙値の文字列表現値。不正値の場合は nullptr 。
    /// @see makeCanTargetType
    ///
    /// 関数 @ref makeCanTargetType に渡す文字列に対応している。
    const wchar_t* toString(CanTargetType type);

/// @}
} // namespace amdaemon

#endif // AMDAEMON_CANTARGETTYPE_H