AnalogChannel.hpp

Go to the documentation of this file.

#ifndef IV_SRC_CHANNELS_ANALOGCHANNEL_HPP_
#define IV_SRC_CHANNELS_ANALOGCHANNEL_HPP_
 
#include "channels/AbstractChannel.hpp"
#include "channels/controller/AnalogChannel.hpp"
 
namespace iv::channels
{
 
class AnalogChannel : public iv::channels::AbstractChannel
{
    friend class iv::channels::controller::AnalogChannel;
 
public:
    ~AnalogChannel() override = default;
 
    void update(AbstractChannel &other) override;
    bool load(const iv::file::xml::node &nodeChannel) override;
    bool save(iv::file::xml::node &nodeChannel) const override;
 
    [[nodiscard]] std::string analogStrValue() const;
 
    [[nodiscard]] std::string getEngineeringUnitsStr() const override;
    iv::channels::AnalogAlarmLimits &alarmLimits();
    iv::types::channelValue &deadBand();
    iv::types::channelValue &offset();
    iv::types::channelValue &factor();
    uint8_t &numberOfDecimals();
    iv::eMeasurementUnit &measurementUnit();
    iv::channels::eAnalogSensorType &analogSensorType();
    iv::types::channelValue &sensorHigh();
    iv::types::channelValue &sensorLow();
 
    [[nodiscard]] std::string formatValue() const override;
    [[nodiscard]] iv::channels::FormattedValue formattedValue() const override;
 
protected:
    iv::channels::AnalogAlarmLimits m_alarmLimits;
    iv::types::channelValue m_deadBand;
    iv::types::channelValue m_offset;
    iv::types::channelValue m_factor;
    uint8_t m_numberOfDecimals;
    iv::eMeasurementUnit m_measurementUnit;
    iv::channels::eAnalogSensorType m_analogSensorType;
    iv::types::channelValue m_sensorHigh;
    iv::types::channelValue m_sensorLow;
 
    AnalogChannel();
    AnalogChannel(const AnalogChannel &other);
 
private:
    struct Keys
    {
        static constexpr std::string_view alarmLimits {"AlarmLimits"};
        static constexpr std::string_view deadBand {"DeadBand"};
        static constexpr std::string_view offset {"Offset"};
        static constexpr std::string_view factor {"Factor"};
        static constexpr std::string_view numberOfDecimals {"NumberOfDecimals"};
        static constexpr std::string_view measurementUnit {"MeasurementUnit"};
        static constexpr std::string_view analogSensorType {"AnalogSensorType"};
        static constexpr std::string_view sensorHigh {"SensorHigh"};
        static constexpr std::string_view sensorLow {"SensorLow"};
 
        struct AlarmSettings
        {
            static constexpr std::string_view instrumentFailureHigh {"InstrumentFailureHigh"};
            static constexpr std::string_view instrumentFailureLow {"InstrumentFailureLow"};
            static constexpr std::string_view lowEngineeringLimit {"LowEngineeringLimit"};
            static constexpr std::string_view highEngineeringLimit {"HighEngineeringLimit"};
            static constexpr std::string_view hasLimit {"HasLimit"};
            static constexpr std::string_view limit {"Limit"};
        };
    };
    struct Sections
    {
        static constexpr std::string_view analogAttributes {"AnalogAttributes"};
        static constexpr std::string_view analogAlarmLimits {"AlarmLimits"};
        static constexpr std::string_view analogAlarmSettingsLLAL {"LLAL"};
        static constexpr std::string_view analogAlarmSettingsLAL {"LAL"};
        static constexpr std::string_view analogAlarmSettingsHAL {"HAL"};
        static constexpr std::string_view analogAlarmSettingsHHAL {"HHAL"};
    };
    struct DefaultValues
    {
        static constexpr std::string string {};
        static constexpr iv::types::channelValue deadBand {0};
        static constexpr iv::types::channelValue offset {0};
        static constexpr iv::types::channelValue factor {1.0};
        static constexpr uint8_t numberOfDecimals {0};
        static constexpr std::string measurementUnit {"NoUnit"};
        static constexpr std::string analogSensorType {"Current"};
        static constexpr iv::types::channelValue sensorHigh {1};
        static constexpr iv::types::channelValue sensorLow {0};
 
        struct AlarmSettings
        {
            static constexpr bool instrumentFailureHigh {false};
            static constexpr bool instrumentFailureLow {false};
            static constexpr iv::types::channelValue lowEngineeringLimit {0};
            static constexpr iv::types::channelValue highEngineeringLimit {100};
            static constexpr iv::channels::AnalogAlarmLimit lowLowAlarmLimit {false, 10};
            static constexpr iv::channels::AnalogAlarmLimit lowAlarmLimit {false, 20};
            static constexpr iv::channels::AnalogAlarmLimit highAlarmLimit {false, 80};
            static constexpr iv::channels::AnalogAlarmLimit highHighAlarmLimit {false, 90};
        };
    };
};
 
}// namespace iv::channels
 
#endif//IV_SRC_CHANNELS_ANALOGCHANNEL_HPP_