CanPort.h

[詳解]

/// @file
/// @brief CAN通信ポートの情報を提供するクラス CanPort のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_CANPORT_H
#define AMDAEMON_CANPORT_H

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

#include <functional>
#include <vector>
#include <cstddef>

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

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

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

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

        /// @brief
        ///     設定ファイルのポート定義内に記述したターゲット定義数(CANボード数)を取得する。
        /// @return ターゲット定義数(CANボード数)。
        std::size_t getTargetCount() const;

        /// @brief ターゲット操作インスタンスを取得する。
        /// @param[in] targetIndex ポート定義内のターゲット定義インデックス。
        /// @return ターゲット操作インスタンス。
        ///
        /// @exception Exception
        /// 引数 targetIndex にポート定義内のターゲット定義数以上の値を指定した場合。
        /// ターゲット定義数はメンバ関数 #getTargetCount で取得できる。
        CanTarget& getTarget(std::size_t targetIndex);

        /// @copydoc getTarget(std::size_t)
        const CanTarget& getTarget(std::size_t targetIndex) const;

        /// @brief ターゲット操作インスタンス配列を取得する。
        /// @return ターゲット操作インスタンス配列。
        ///
        /// 範囲for文や各種アルゴリズム関数に渡すことを想定している。
        ///
        /// - ターゲット定義数を知りたいだけならばメンバ関数 #getTargetCount を用いること。
        /// - 特定ターゲットを取得したいだけならばメンバ関数 #getTarget を用いること。
        std::vector<std::reference_wrapper<CanTarget>> getTargets()
        {
            return
                ::amdaemon::util::toContainer<decltype(getTargets())>(
                    getTargetCount(),
                    [this](std::size_t i) -> CanTarget& { return getTarget(i); });
        }

        /// @copydoc getTargets
        std::vector<std::reference_wrapper<const CanTarget>> getTargets() const
        {
            return
                ::amdaemon::util::toContainer<decltype(getTargets())>(
                    getTargetCount(),
                    [this](std::size_t i) -> const CanTarget& { return getTarget(i); });
        }

    private:
        std::size_t _index; ///< ポート定義インデックス。

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

/// @}
} // namespace amdaemon

#endif // AMDAEMON_CANPORT_H