SocketCanSettings.hpp

Go to the documentation of this file.

#ifndef IV_SRC_MODEL_COMMS_SOCKETCANSETTINGS_HPP_
#define IV_SRC_MODEL_COMMS_SOCKETCANSETTINGS_HPP_
 
#include "filehandlers/xmlFile.hpp"
 
namespace iv::model::comms::socketcan
{
 
enum class eBoardType
{
    Usb,
    UsbFd,
    UsbPro,
    UsbX6,
    UsbProFd
};
 
enum class eOperationMode
{
    Extended,
    Standard,
    First = Extended,
    Last = Standard
};
 
enum class eBaudRate
{
    BR5,
    BR10,
    BR20,
    BR50,
    BR100,
    BR125,
    BR250,
    BR500,
    BR1000,
    First = BR5,
    Last = BR1000
};
 
struct UsbDeviceSettings
{
    UsbDeviceSettings();
    UsbDeviceSettings(iv::model::comms::socketcan::eBoardType boardType, std::string device, uint32_t hwPort,
                      iv::model::comms::socketcan::eOperationMode operationMode,
                      iv::model::comms::socketcan::eBaudRate busTimingRegister);
    UsbDeviceSettings(const UsbDeviceSettings &other);
    UsbDeviceSettings(UsbDeviceSettings &&other) noexcept;
    ~UsbDeviceSettings();
 
    UsbDeviceSettings &operator=(const UsbDeviceSettings &other);
    UsbDeviceSettings &operator=(UsbDeviceSettings &&other) noexcept;
 
    bool load(const iv::file::xml::node &node);
    bool save(iv::file::xml::node &node) const;
 
    iv::model::comms::socketcan::eBoardType _boardType;
    std::string _interface;
    iv::model::comms::socketcan::eBaudRate _busTimingRegister;
 
private:
    struct Keys
    {
        static constexpr std::string_view socketCanBoardType {"BoardType"};
        static constexpr std::string_view socketCanDevice {"Device"};
        static constexpr std::string_view socketCanHwPort {"HwPort"};
        static constexpr std::string_view socketCanOperationMode {"OperationMode"};
        static constexpr std::string_view socketCanBusTimingRegister {"BusTimingRegister"};
    };
 
    struct DefaultValues
    {
        static constexpr std::string string {};
        static constexpr std::string interface {"can0"};
    };
};
 
struct PCanEthGatewaySettings
{
    PCanEthGatewaySettings();
    PCanEthGatewaySettings(iv::types::ipAddress stationAddress, iv::types::ipPort stationPort,
                           iv::types::ipAddress gatewayAddress, iv::types::ipPort gatewayPort);
    PCanEthGatewaySettings(const PCanEthGatewaySettings &other);
    PCanEthGatewaySettings(PCanEthGatewaySettings &&other) noexcept;
    ~PCanEthGatewaySettings();
 
    PCanEthGatewaySettings &operator=(const PCanEthGatewaySettings &other);
    PCanEthGatewaySettings &operator=(PCanEthGatewaySettings &&other) noexcept;
 
    bool load(const iv::file::xml::node &node);
    bool save(iv::file::xml::node &node) const;
 
    iv::types::ipAddress _stationAddress;//IP address for reception of can packets from gateway
    iv::types::ipPort _stationPort;      //Port for reception of can packets from gateway
    iv::types::ipAddress _gatewayAddress;//IP address of the gateway used to send packets to can bus
    iv::types::ipPort _gatewayPort;      //Port used to send packets to can bus
 
private:
    struct Keys
    {
        static constexpr std::string_view stationIpAddress {"StationIpAddress"};
        static constexpr std::string_view stationPort {"StationPort"};
        static constexpr std::string_view gatewayIpAddress {"GatewayIpAddress"};
        static constexpr std::string_view gatewayPort {"GatewayPort"};
    };
};
 
}// namespace iv::model::comms::socketcan
 
#endif//IV_SRC_MODEL_COMMS_SOCKETCANSETTINGS_HPP_