Tank.hpp

Go to the documentation of this file.

#ifndef IV_SRC_MIMICS_MODEL_INDICATORS_TANK_HPP_
#define IV_SRC_MIMICS_MODEL_INDICATORS_TANK_HPP_
 
#include "diagrams/CDiagram.hpp"
#include "mimics/model/AbstractMimicElement.hpp"
#include "model/support/Scale.hpp"
#include "tanks/Tank.hpp"
#include "ui/shapes/CRectangleGraphics.hpp"
 
namespace iv::mimics::elements
{
 
class Tank final : public iv::mimics::AbstractMimicElement
{
public:
    Tank();
    ~Tank() override = default;
 
    bool load(const iv::file::xml::node &nodeTank) override;
    bool save(iv::file::xml::node &nodeTank) const override;
 
    // Controller
    void getChannels(const std::shared_ptr<std::vector<std::weak_ptr<iv::channels::AbstractChannel>>>
                             &channelsInControl) const override;
    void mapChannels(const std::function<void(std::weak_ptr<iv::channels::AbstractChannel> &)> &mapFunction) override;
    [[nodiscard]] std::shared_ptr<iv::mimics::AbstractMimicElement> clone() const override;
 
    [[nodiscard]] std::optional<iv::types::color> getColorWorkingState() const override;
    [[nodiscard]] std::optional<std::string> getStringWorkingState() const override;
    [[nodiscard]] std::optional<iv::mimics::eAlarmState> getAlarmState() const override;
    void executeCommand(const std::string &strAction) const override;
 
    // Draw
    void drawSpecific(IGraphics *graphics, std::optional<iv::types::color> colorWorkingState,
                      std::optional<iv::types::color> colorControlState, iv::eLanguage drawingLanguage) override;
 
    // UI
    AbstractComponentGUI *panelEditControl() override;
    void addOptionsMenu(const std::shared_ptr<iv::mimics::MimicControlMenu> &menu) override;
 
private:
    static constexpr double kPrvRelationXY {6.8};
 
    Tank(const Tank &other);
 
    enum class eInfoLocation
    {
        Top,
        Bottom,
        Left,
        Right
    };
 
    std::weak_ptr<iv::tanks::Tank> m_tank;
 
    // Value
    iv::mimics::elements::Tank::eInfoLocation m_locationInfo;
    bool m_showVolume;
    bool m_showVolumeInPercent;
    bool m_showVolumeInMetersCubics;
    bool m_showVolumeInLitres;
    bool m_showWeight;
    bool m_showSounding;
    iv::types::height m_textInfoHeight;
    iv::types::padding m_textInfoPadding;
 
    // Colors
    iv::types::color m_backgroundColor;
    iv::types::color m_contentColor;
 
    // Scale
    iv::mimics::support::Scale m_scale;
 
    //Alarm limits indicators
    bool m_showAlarmLimits;
    iv::mimics::elements::eMarkType m_markType;
 
    // View
    void drawLevelBar(iv::types::channelValue value, const iv::channels::AnalogAlarmLimits &levelLimits,
                      std::optional<iv::types::color> colorState, IGraphics *graphics, double sizeXFrame,
                      double sizeYFrame, double sizeY) const;
    void drawLevelLimits(const iv::channels::AnalogAlarmLimits &levelLimits, IGraphics *graphics, double sizeX,
                         double sizeY) const;
    void drawLevelScale(const iv::channels::AnalogAlarmLimits &levelLimits, IGraphics *graphics,
                        std::optional<iv::types::color> colorState, uint8_t numDecimals, double sizeX,
                        double sizeY) const;
    void drawTankInfo(bool hasValue, iv::types::channelValue tankVolumeValue, uint8_t numDecimals,
                      std::optional<iv::types::color> colorState, IGraphics *graphics) const;
 
    std::unique_ptr<CRectangleGraphics> m_containerGraphic {nullptr};
    std::unique_ptr<CRectangleGraphics> m_contentGraphic {nullptr};
    std::unique_ptr<CDiagram> m_scaleGraphic {nullptr};
 
    struct Keys
    {
        static constexpr std::string_view tankName {"TankName"};
        static constexpr std::string_view locationInfo {"LocationInfo"};
        static constexpr std::string_view showVolume {"ShowVolume"};
        static constexpr std::string_view showVolumeInPercent {"ShowVolumeInPercent"};
        static constexpr std::string_view showVolumeInMeters {"ShowVolumeInMeters"};
        static constexpr std::string_view showVolumeInLitres {"ShowVolumeInLitres"};
        static constexpr std::string_view showSounding {"ShowSounding"};
        static constexpr std::string_view showWeight {"ShowWeight"};
        static constexpr std::string_view textValueHeight {"TextValueHeight"};
        static constexpr std::string_view textValuePadding {"TextValuePadding"};
        static constexpr std::string_view showScale {"ShowScale"};
        static constexpr std::string_view showAlarmLimits {"ShowAlarmLimits"};
        static constexpr std::string_view markType {"MarkType"};
        static constexpr std::string_view backgroundColor {"BackgroundColor"};
        static constexpr std::string_view contentColor {"ContentColor"};
    };
    struct DefaultValues
    {
        static constexpr std::string string {};
        static constexpr std::string locationInfo {"Right"};
 
        static constexpr bool showVolume {false};
        static constexpr bool showVolumeInPercent {false};
        static constexpr bool showVolumeInMeters {false};
        static constexpr bool showVolumeInLitres {false};
        static constexpr bool showSounding {false};
        static constexpr bool showWeight {false};
        static constexpr iv::types::height textValueHeight {16};
        static constexpr iv::types::padding textValuePadding {5};
        static constexpr bool showScale {false};
        static constexpr bool showAlarmLimits {true};
        static constexpr auto markType {iv::mimics::elements::eMarkType::ShortLine};
        static constexpr auto backgroundColor {iv::color::DarkGray};
        static constexpr auto contentColor {iv::color::Blue};
        struct Colors
        {
            static constexpr iv::types::color text {iv::color::White};
        };
    };
    struct Sections
    {
        static constexpr std::string_view tankIndicator {"TankIndicator"};
        static constexpr std::string_view scale {"Scale"};
    };
    struct ColorsState
    {
        static constexpr iv::types::color tankEdges {iv::color::LevelAnalogTankLine};
        struct Limit
        {
            static constexpr iv::types::color llal {iv::color::ControlAnalogicAlarm};
            static constexpr iv::types::color lal {iv::color::ControlAnalogicWarning};
            static constexpr iv::types::color hal {iv::color::ControlAnalogicWarning};
            static constexpr iv::types::color hhal {iv::color::ControlAnalogicAlarm};
        };
    };
};
 
}// namespace iv::mimics::elements
 
#endif//IV_SRC_MIMICS_MODEL_INDICATORS_TANK_HPP_