CanSettings.hpp

Go to the documentation of this file.

#ifndef IV_SRC_MODEL_COMMS_CANSETTINGS_HPP_
#define IV_SRC_MODEL_COMMS_CANSETTINGS_HPP_
 
#include "core/enums.hpp"
#include "core/types.hpp"
#include "filehandlers/xmlFile.hpp"
 
#include <cstdint>
 
namespace iv::model::comms::can
{
 
// Structure to represent a filter for message acceptance
struct Filter
{
    Filter();
    Filter(uint32_t id, uint32_t mask);
    Filter(const Filter &other);
    Filter(Filter &&other) noexcept;
    ~Filter();
 
    Filter &operator=(const Filter &other);
    Filter &operator=(Filter &&other) noexcept;
 
    bool load(const iv::file::xml::node &node);
    bool save(iv::file::xml::node &node) const;
 
    // Function to check if a message matches the filter
    [[nodiscard]] bool matches(uint32_t messageId) const;
 
    uint32_t _id;  // Filter ID
    uint32_t _mask;// Acceptance mask
};
 
// Structure to represent the configuration of a CAN device
struct Settings
{
    Settings();
    Settings(iv::comms::eLomLine lomLine, bool highSpeed, iv::model::comms::can::Filter filter,
             iv::types::pollTime timeoutWait, iv::types::pollTime timeoutRetry);
    Settings(const Settings &other);
    Settings(Settings &&other) noexcept;
    ~Settings();
 
    Settings &operator=(const Settings &other);
    Settings &operator=(Settings &&other) noexcept;
 
    bool load(const iv::file::xml::node &node);
    bool save(iv::file::xml::node &node) const;
 
    iv::comms::eLomLine _lomLine;
    bool _highSpeed;                      // High-speed mode indicator
    iv::model::comms::can::Filter _filter;// Acceptance filter
    iv::types::pollTime _timeoutWait;
 
private:
    struct Keys
    {
        static constexpr std::string_view lomLine {"LomLine"};
        static constexpr std::string_view canHighSpeed {"HighSpeed"};
        static constexpr std::string_view canFilterId {"FilterId"};
        static constexpr std::string_view canFilterMask {"FilterMask"};
    };
 
    struct DefaultValues
    {
        static constexpr std::string string {};
    };
};
 
}// namespace iv::model::comms::can
 
#endif//IV_SRC_MODEL_COMMS_CANSETTINGS_HPP_