CanTargetProperty.h

[詳解]

/// @file
/// @brief CANボード単体の情報を提供するクラス CanTargetProperty のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_CANTARGETPROPERTY_H
#define AMDAEMON_CANTARGETPROPERTY_H

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

#include <cstdint>
#include <cstddef>

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

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

    /// @brief CANボード単体の情報を提供するクラス。
    /// @see CanTarget
    ///
    /// このクラスのインスタンスをアプリ側で直接生成することはできない。
    /// CanTarget クラスのメンバ関数 CanTarget#getProperty から取得すること。
    class CanTargetProperty
    {
    public:
        /// @brief コンストラクタ。
        /// @note アプリ側からは利用できない。
        CanTargetProperty(InnerIndexHolder, InnerIndexHolder);

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

        /// @brief 有効な情報を保持しているか否かを取得する。
        /// @retval true  保持している場合。
        /// @retval false 保持していないか、情報未取得である場合。
        ///
        /// - 現時点の実装では、 Core クラスのメンバ関数 Core#isReady が
        ///   true を返すとこの関数も true を返すようになる。
        ///     - 将来ファームウェア更新処理等が実装された場合にはこの限りではない。
        /// - この関数が false を返す場合、他のメンバ関数が返す値を信用してはならない。
        bool valid() const
        {
            return (this->getId() != 0);
        }

        /// @brief ターゲット分類を取得する。
        /// @return ターゲット分類。情報未取得である場合は不定値。
        CanTargetType getType() const;

        /// @brief ボードID値を取得する。
        /// @return ボードID値。 1 以上 29 以下。情報未取得である場合は 0 。
        std::uint16_t getId() const;

        /// @brief ボード品番文字列を取得する。
        /// @return ボード品番文字列。情報未取得である場合は不定値。
        const wchar_t* getProduct() const;

        /// @brief カスタムチップ品番文字列を取得する。
        /// @return カスタムチップ品番文字列。情報未取得である場合は不定値。
        const wchar_t* getCustomChip() const;

        /// @brief ファームウェアリビジョン値を取得する。
        /// @return ファームウェアリビジョン値。最大 255 。情報未取得である場合は不定値。
        std::uint16_t getFirmRevision() const;

        /// @brief ファームウェアチェックサム値を取得する。
        /// @return ファームウェアチェックサム値。情報未取得である場合は不定値。
        std::uint16_t getFirmSum() const;

    private:
        std::size_t _portIndex;     ///< ポート定義インデックス。
        std::size_t _targetIndex;   ///< ターゲット定義インデックス。

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

/// @}
} // namespace amdaemon

#endif // AMDAEMON_CANTARGETPROPERTY_H