AbstractMimicElement.hpp

Go to the documentation of this file.

#ifndef IV_SRC_MIMICS_ABSTRACTMIMICELEMENT_HPP_
#define IV_SRC_MIMICS_ABSTRACTMIMICELEMENT_HPP_
 
#include "channels/AbstractChannel.hpp"
#include "mimics/MimicControlMenu.hpp"
#include "mimics/OnlineVariables.hpp"
#include "mimics/structs.hpp"
#include "ui/graphics/IGraphics.hpp"
#include "ui/gui/AbstractComponentGUI.hpp"
#include "ui/gui/CEventMotion.hpp"
#include "ui/shapes/CDrawText.hpp"
 
#include <memory>
#include <optional>
#include <unordered_set>
 
namespace iv::mimics
{
 
class AbstractMimicElement
{
public:
    virtual ~AbstractMimicElement();
 
    virtual bool load(const iv::file::xml::node &nodeControlMimic);
    virtual bool save(iv::file::xml::node &nodeControlMimic) const;
 
    [[nodiscard]] const iv::mimics::TitleSettings &getTitleSettings() const
    {
        return m_titleSettings;
    }
 
    [[nodiscard]] virtual std::shared_ptr<iv::mimics::AbstractMimicElement> clone() const = 0;
    [[nodiscard]] std::weak_ptr<iv::mimics::OnlineVariables> getOnlineVariables() const;
    virtual void updateEnabledLanguages(const std::set<iv::eLanguage> &enabledLanguages);
 
    //Controller
 
    virtual void mapChannels(const std::function<void(std::weak_ptr<iv::channels::AbstractChannel> &)> &mapFunction);
 
    virtual void getChannels(
            const std::shared_ptr<std::vector<std::weak_ptr<iv::channels::AbstractChannel>>> &channelsInControl) const;
 
    virtual void addOptionsMenu(const std::shared_ptr<iv::mimics::MimicControlMenu> &menu);
 
    [[nodiscard]] bool isPointInMimic(iv::types::coord x, iv::types::coord y) const;
 
    [[nodiscard]] virtual std::optional<iv::types::color> getColorWorkingState() const;
    [[nodiscard]] virtual std::optional<iv::types::color> getColorControlState() const;
    [[nodiscard]] virtual std::optional<std::string> getStringWorkingState() const;
    [[nodiscard]] virtual std::optional<std::string> getStringControlState() const;
    [[nodiscard]] virtual std::optional<iv::mimics::eAlarmState> getAlarmState() const;
    [[nodiscard]] virtual iv::math::geometry::Point2d
    getAlarmIconPosition(const iv::math::geometry::Area &elementSize) const;
 
 
    [[nodiscard]] virtual bool canShowCircularMenu() const;
 
    [[nodiscard]] virtual bool hasAlternativeAction() const;
 
 
    virtual void executeCommand(const std::string &strAction) const = 0;
 
    virtual void runCommandControlWithoutMenu();
 
    virtual void runAlternativeAction(CDialog *dlgFatherRef);
 
    virtual void runEvaluation();
 
 
 
    virtual AbstractComponentGUI *panelEditControl() = 0;
 
 
    virtual void postProcess();
 
 
    void draw(IGraphics *graphics, iv::eLanguage drawingLanguage,
              const std::optional<std::unordered_set<iv::types::channelId>> &channelsRepeatedOpt = std::nullopt,
              const std::optional<std::set<std::shared_ptr<AbstractMimicElement>>> &otherMimicElements = std::nullopt);
    void setRedrawFlag(bool reDrawFlag = true);
 
    void removeGraphicsObjects(IGraphics *graphics);
 
    virtual void move(double dx, double dy);
 
    bool rotate(double angle);
 
    void handleEvent(CEventMotion *evtMotion);
 
    eZDepth m_depth;// TODO: [IV_MODEL] No se escribe en el xml y no se asigna en ningun sitio?
 
    iv::mimics::eMimicElementType m_mimicElementType;
    iv::mimics::Location m_location;
 
    iv::types::width m_width;
    iv::types::height m_height;
 
    iv::mimics::TitleSettings m_titleSettings;
    iv::mimics::Background m_background;
    std::shared_ptr<OnlineVariables> m_onlineVariables;
 
    std::shared_ptr<std::vector<std::weak_ptr<iv::channels::AbstractChannel>>> m_addedAlarms;
 
protected:
    explicit AbstractMimicElement(iv::mimics::eMimicElementType elementType);
    AbstractMimicElement(const AbstractMimicElement &other);
 
    std::vector<iv::math::geometry::Point2d> calculateLimits(IGraphics *graphics, iv::eLanguage drawingLanguage);
    [[nodiscard]] virtual bool checkIntegrity() const;
    virtual bool hasRepeatedChannels(const std::unordered_set<iv::types::channelId> &channelsRepeatedOpt) const;
    virtual bool
    isRepeatedMimicElement(const std::set<std::shared_ptr<AbstractMimicElement>> &otherMimicsElements) const;
 
    virtual void drawSpecific(IGraphics *graphics, std::optional<iv::types::color> colorWorkingState,
                              std::optional<iv::types::color> colorControlState, iv::eLanguage drawingLanguage) = 0;
 
    AbstractComponentGUI *buttonEditTitle();
    AbstractComponentGUI *panelEditSize();
    [[nodiscard]] AbstractComponentGUI *panelEditOnlineVariables() const;
    [[nodiscard]] AbstractComponentGUI *panelEditAddedAlarms() const;
 
    bool m_redrawFlag {false};
 
private:
    // Draw
    [[nodiscard]] std::unique_ptr<CDrawText> prvCreateTextTitle(iv::eLanguage language) const;
    static bool
    checkHasRepeated(const std::unordered_set<iv::types::channelId> &repeatedChannels,
                     const std::shared_ptr<std::vector<std::weak_ptr<iv::channels::AbstractChannel>>> &elementChannels);
 
    void applyPosition(IGraphics *graphics) const;
    void applyRotation(IGraphics *graphics) const;
 
    [[nodiscard]] std::optional<iv::mimics::eAlarmState> getAddedAlarmsMimicAlarmState() const;
 
    std::unique_ptr<CDrawText> m_textTitleOpt;
    std::shared_ptr<std::vector<iv::math::geometry::Point2d>> m_polylinesLimits;
 
    uint32_t m_idBlockBackground;
    uint32_t m_idBlockForegorund;
 
    bool m_isCreatedForeground {false};
    bool m_isCreatedBackground {false};
 
    bool m_isMarked {false};
 
    struct Constants
    {
        static constexpr double offlineCrossLineWidthProportion {0.02};
        static constexpr iv::types::width offlineCrossLineMinWidth {1.2f};
        static constexpr iv::types::width offlineCrossLineMaxWidth {3.6f};
    };
    struct Keys
    {
        static constexpr std::string_view width {"Width"};
        static constexpr std::string_view height {"Height"};
        static constexpr std::string_view addedChannelId {"AddedChannelId"};
    };
    struct Sections
    {
        static constexpr std::string_view titleSettings {"TitleSettings"};
        static constexpr std::string_view location {"Location"};
        static constexpr std::string_view onlineVariables {"OnlineVariables"};
        static constexpr std::string_view addedAlarms {"AddedAlarms"};
        static constexpr std::string_view addedChannel {"AddedChannel"};
    };
    struct DefaultValues
    {
        static constexpr std::string string {};
        static constexpr std::string mimicElementType = {"Line"};
        static constexpr iv::types::width width {50};
        static constexpr iv::types::height height {50};
    };
};
 
}// namespace iv::mimics
 
#endif//IV_SRC_MIMICS_ABSTRACTMIMICELEMENT_HPP_