NetworkData.hpp

Go to the documentation of this file.

#ifndef IV_SRC_MODEL_COMMS_NETWORKDATA_HPP_
#define IV_SRC_MODEL_COMMS_NETWORKDATA_HPP_
 
#include "core/types.hpp"
#include "filehandlers/xmlFile.hpp"
#include "model/comms/InterfaceSettings.hpp"
#include "model/comms/ProtocolSettings.hpp"
 
namespace iv::channels
{
class AbstractChannel;
}
 
namespace iv::model::comms
{
 
struct NetworkData
{
    NetworkData();
    NetworkData(iv::types::networkId networkId, const std::shared_ptr<bool> &isEnabled,
                iv::comms::eNetworkType networkType, std::string internalDescription,
                iv::types::milliseconds deinitTimeout, iv::types::channelId errorChannelId,
                iv::model::comms::InterfaceSettings interfaceSettings,
                iv::model::comms::ProtocolSettings protocolSettings, iv::comms::eCommDebugLevels debugLevel,
                iv::types::stationId stationId);
    NetworkData(const NetworkData &other);
    NetworkData(NetworkData &&other) noexcept;
    ~NetworkData();
 
    NetworkData &operator=(const NetworkData &other);
    NetworkData &operator=(NetworkData &&other) noexcept;
 
    bool load(const iv::file::xml::node &node);
    static std::string loadNetworkProtocol(const iv::file::xml::node &node);
    bool save(iv::file::xml::node &node) const;
 
    [[nodiscard]] std::shared_ptr<NetworkData> clone() const;
    void update(const NetworkData &other);
 
    std::string getDetails();
 
    iv::types::networkId _networkId;
    std::shared_ptr<bool> _isEnabled;
    iv::comms::eNetworkType _networkType;
    std::string _internalDescription;
    iv::types::milliseconds _deinitTimeout;
    iv::types::networkId fallBackNetwork;
 
    iv::model::comms::InterfaceSettings _interfaceSettings;
    iv::model::comms::ProtocolSettings _protocolSettings;
 
    std::weak_ptr<iv::channels::AbstractChannel> _heartbeatChannel;
    std::weak_ptr<iv::channels::AbstractChannel> _commFailureChannel;
 
    iv::comms::eCommDebugLevels _debugLevel;
 
    iv::types::stationId _stationId;
 
private:
    struct Keys
    {
        static constexpr std::string_view id {"Id"};
        static constexpr std::string_view isEnabled {"Enabled"};
        static constexpr std::string_view type {"Type"};
        static constexpr std::string_view deInitTimeOut {"DeInitTimeOut"};
        static constexpr std::string_view internalDescription {"InternalDescription"};
 
        static constexpr std::string_view interfaceType {"Type"};
 
        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"};
 
        static constexpr std::string_view ixxatBoardType {"BoardType"};
        static constexpr std::string_view ixxatHwSerial {"HwSerial"};
        static constexpr std::string_view ixxatHwPort {"HwPort"};
        static constexpr std::string_view ixxatBaudRate {"BaudRate"};
        static constexpr std::string_view ixxatOperationMode {"OperationMode"};
        static constexpr std::string_view ixxatEnableErrorFrames {"EnableErrorFrames"};
 
        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"};
 
        static constexpr std::string_view serialPortName {"PortName"};
        static constexpr std::string_view serialBaudRate {"BaudRate"};
        static constexpr std::string_view serialDataBits {"DataBits"};
        static constexpr std::string_view serialParity {"Parity"};
        static constexpr std::string_view serialStopBits {"StopBits"};
        static constexpr std::string_view serialFlowControl {"FlowControl"};
        static constexpr std::string_view serialPollTime {"PollTime"};
 
        static constexpr std::string_view httpSettingIp {"Ip"};
        static constexpr std::string_view httpSettingPort {"Port"};
 
        static constexpr std::string_view protocolType {"ProtocolType"};
 
        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"};
 
        static constexpr std::string_view modbusSlaveId {"SlaveId"};
        static constexpr std::string_view modbusZeroBased {"ZeroBased"};
        static constexpr std::string_view modbusTimeoutWait {"TimeoutWait"};
        static constexpr std::string_view modbusTimeoutRetry {"TimeoutRetry"};
        static constexpr std::string_view modbusMaxRetries {"MaxRetries"};
        static constexpr std::string_view modbusMaxCoilsReadPerQuery {"MaxCoilsReadPerQuery"};
        static constexpr std::string_view modbusMaxCoilsWritePerQuery {"MaxCoilsWritePerQuery"};
        static constexpr std::string_view modbusMaxRegistersReadPerQuery {"MaxRegistersReadPerQuery"};
        static constexpr std::string_view modbusMaxRegistersWritePerQuery {"MaxRegistersWritePerQuery"};
 
        static constexpr std::string_view nmea0183TimeoutWait {"TimeoutWait"};
        static constexpr std::string_view nmea0183TimeoutRetry {"TimeoutRetry"};
        static constexpr std::string_view nmea0183TimeReadingPerFrame {"TimeReadingPerFrame"};
 
        static constexpr std::string_view fallbackNetwork {"FallbackNetwork"};
        static constexpr std::string_view heartbeatChannel {"HeartbeatChannel"};
        static constexpr std::string_view failChannel {"FailChannel"};
        static constexpr std::string_view debugLevel {"DebugLevel"};
    };
 
    struct Sections
    {
        static constexpr std::string_view settings {"Settings"};
        static constexpr std::string_view ipAddresses {"IpAddresses"};
        static constexpr std::string_view ipAddress {"IpAddress"};
        static constexpr std::string_view networks {"Networks"};
        static constexpr std::string_view network {"Network"};
        static constexpr std::string_view networkCommInterfaceSettings {"Interface"};
        static constexpr std::string_view networkCommProtocolSettings {"Protocol"};
 
        struct Network
        {
            static constexpr std::string_view httpSetting {"HttpSetting"};
        };
    };
 
    struct DefaultValues
    {
        static constexpr std::string string {};
        static constexpr bool isEnabled {};
        static constexpr iv::comms::eNetworkType networkType {iv::comms::eNetworkType::Redundancy};
        static constexpr iv::types::milliseconds deinitTimeout {0};
        static constexpr iv::comms::eCommDebugLevels debugLevel {iv::comms::eCommDebugLevels::All};
    };
};
 
}// namespace iv::model::comms
 
#endif//IV_SRC_MODEL_COMMS_NETWORKDATA_HPP_