ValveAutomated.hpp

Go to the documentation of this file.

#ifndef IV_SRC_MIMICS_MODEL_ELEMENTSAUTOMATED_VALVEAUTOMATED_HPP_
#define IV_SRC_MIMICS_MODEL_ELEMENTSAUTOMATED_VALVEAUTOMATED_HPP_
 
#include "mimics/model/Digital.hpp"
#include "mimics/model/support/Maintenance.hpp"
#include "mimics/model/traits/CommandsOpCl.hpp"
#include "mimics/model/traits/ControlLock.hpp"
#include "mimics/model/traits/FeedbackOpCl.hpp"
#include "mimics/model/traits/OrderOpCl.hpp"
#include "mimics/model/traits/RemoteLocal.hpp"
#include "mimics/model/traits/TripReset.hpp"
#include "model/control/Valve.hpp"
 
namespace iv::mimics::elementsAutomated
{
 
class ValveAutomated final : public iv::mimics::AbstractMimicElement,
                             private iv::mimics::traits::FeedbackOpCl,
                             private iv::mimics::traits::CommandsOpCl,
                             private iv::mimics::traits::ControlLock,
                             private iv::mimics::traits::OrderOpCl,
                             private iv::mimics::traits::TripReset
{
public:
    ValveAutomated();
    ~ValveAutomated() override = default;
 
    bool load(const iv::file::xml::node &nodeControlMimic) override;
    bool save(iv::file::xml::node &nodeControlMimic) 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;
    void executeCommand(const std::string &strAction) 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;
 
    // View
    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;
 
    bool canShowCircularMenu() const override;
    bool hasAlternativeAction() const override;
    void runAlternativeAction(CDialog *dlgFatherRef) override;
 
protected:
    ValveAutomated(const ValveAutomated &other);
 
    bool checkIntegrity() const override;
    bool hasRepeatedChannels(const std::unordered_set<iv::types::channelId> &channelsRepeatedOpt) const override;
    bool
    isRepeatedMimicElement(const std::set<std::shared_ptr<AbstractMimicElement>> &otherMimicsElements) const override;
 
    bool removePreviousOnlineVariables(const std::optional<iv::types::control::valve::valveId> &previousValveId) const;
    bool addOnlineVariables(const std::optional<iv::types::control::valve::valveId> &newValveId) const;
 
    // View
    std::unique_ptr<CDrawText> m_textStateOpt {nullptr};
    virtual void prvDrawMechanicalValve(iv::types::color colorState, IGraphics *graphics) const;
    virtual void prvDrawNormalValve(iv::types::color colorState, IGraphics *graphics) const;
 
    iv::mimics::elements::eValveDesign m_valveDesign;
    iv::mimics::support::Maintenance m_maintenance;
    std::weak_ptr<iv::model::control::Valve> m_valve;
 
private:
    void updateValveTraits();
 
    struct Constants
    {
        static constexpr double locaSquareLineWidthProportion {0.01};
        static constexpr iv::types::width locaSquareLineMinWidth {0.8f};
        static constexpr iv::types::width locaSquareLineMaxWidth {2.4f};
    };
    struct DefaultValues
    {
        static constexpr std::string string {};
        static constexpr iv::mimics::elements::eValveDesign valveDesign {iv::mimics::elements::eValveDesign::Normal};
        struct Colors
        {
            static constexpr iv::types::color color {iv::color::White};
 
            static constexpr iv::types::color workingStateOpen {iv::color::SedniElementWorkingGreen};
            static constexpr iv::types::color workingStateClose {iv::color::SedniElementNotWorkingWhite};
            static constexpr iv::types::color workingStateUndefined {iv::color::SedniElementUndefined};
            static constexpr iv::types::color workingStateOffline {iv::color::SedniElementOfflineGrey};
        };
    };
    struct Keys
    {
        static constexpr std::string_view valve {"Valve"};
        static constexpr std::string_view valveDesign {"ValveDesign"};
    };
    struct Sections
    {
        static constexpr std::string_view valve {"Valve"};
        static constexpr std::string_view maintenance {"Maintenance"};
        static constexpr std::string_view feedbackOpCl {"FeedbackOpCl"};
        static constexpr std::string_view commandsOpCl {"CommandsOpCl"};
        static constexpr std::string_view orderOpCl {"OrderOpCl"};
        static constexpr std::string_view remoteLocal {"RemoteLocal"};
        static constexpr std::string_view tripReset {"TripReset"};
        static constexpr std::string_view controlLock {"ControlLock"};
    };
};
 
}// namespace iv::mimics::elementsAutomated
 
#endif//IV_SRC_MIMICS_MODEL_ELEMENTSAUTOMATED_VALVEAUTOMATED_HPP_