Can.h

[詳解]

/// @file
/// @brief CAN通信処理を提供するMonostateクラス Can のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_CAN_H
#define AMDAEMON_CAN_H

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

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

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

    /// @brief CAN通信処理を提供するMonostateクラス。
    /// @see Input
    ///
    /// Core クラスのメンバ関数 Core#execute 呼び出しによって内容が更新される。
    ///
    /// CAN I/O ボード 837-15257 およびその互換ボードから自動送信されるスイッチ入力等を
    /// 扱う場合は、このクラスではなく Input クラスを用いること。
    ///
    /// @par プラットフォーム情報
    /// - ALLSシリーズではCAN機能は利用できない。
    /// - ALLSシリーズの場合、常にポート定義数 0 として扱われる。
    ///
    /// @ingroup g_common
    class Can
    {
    public:
        // 下記は暗黙の定義を用いる。
        //Can() = default;
        //‾Can() = default;
        //Can(const Can&) = default;
        //Can& operator=(const Can&) = default;

        /// @brief CAN通信機能を利用可能であるか否かを取得する。
        /// @retval true  利用可能である場合。
        /// @retval false 機能が無効である場合。
        ///
        /// 条件式 (getPortCount() > 0) の結果を返す。
        bool isAvailable() const
        {
            return (this->getPortCount() > 0);
        }

        /// @brief 設定ファイルに記述したポート定義数を取得する。
        /// @return ポート定義数。
        std::size_t getPortCount() const;

        /// @brief ポート情報インスタンスを取得する。
        /// @param[in] portIndex ポート定義インデックス。ポート番号ではないことに注意。
        /// @return ポート情報インスタンス。
        ///
        /// @exception Exception
        /// 引数 portIndex にポート定義数以上の値を指定した場合。
        /// ポート定義数はメンバ関数 #getPortCount で取得できる。
        CanPort& getPort(std::size_t portIndex);

        /// @copydoc getPort(std::size_t)
        const CanPort& getPort(std::size_t portIndex) const;

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

        /// @copydoc getPorts
        std::vector<std::reference_wrapper<const CanPort>> getPorts() const
        {
            return
                ::amdaemon::util::toContainer<decltype(getPorts())>(
                    getPortCount(),
                    [this](std::size_t i) -> const CanPort& { return getPort(i); });
        }
    };

/// @}
} // namespace amdaemon

#endif // AMDAEMON_CAN_H