Damper.hpp

Go to the documentation of this file.

#ifndef IV_SRC_MIMICS_INDICATORS_DAMPER_HPP_
#define IV_SRC_MIMICS_INDICATORS_DAMPER_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/traits/AutomaticSemiAuto.hpp"
#include "ui/shapes/DamperSymbol.hpp"
 
namespace iv::mimics::elements
{
 
class Damper final : public iv::mimics::AbstractMimicElement,
                     iv::mimics::traits::AutomaticSemiAuto,
                     iv::mimics::traits::FeedbackOpCl,
                     iv::mimics::traits::CommandsOpCl,
                     iv::mimics::traits::ControlLock,
                     iv::mimics::traits::OrderOpCl,
                     iv::mimics::traits::RemoteLocal,
                     iv::mimics::traits::TripReset
{
public:
    Damper();
    ~Damper() 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;
 
    [[nodiscard]] std::optional<iv::types::color> getColorWorkingState() const override;
    [[nodiscard]] std::optional<iv::types::color> getColorControlState() const override;
    [[nodiscard]] std::optional<std::string> getStringWorkingState() const override;
    [[nodiscard]] std::optional<std::string> getStringControlState() 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;
 
protected:
    explicit Damper(iv::mimics::eMimicElementType type);
    Damper(const Damper &other);
 
    bool m_isControl;
 
    iv::mimics::support::Maintenance m_maintenance;
 
    // View
    std::unique_ptr<iv::shapes::DamperSymbol> m_damperSymbol {nullptr};
 
private:
    struct Keys
    {
        static constexpr std::string_view isControl {"IsControl"};
    };
    struct Sections
    {
        static constexpr std::string_view damper {"Damper"};
        static constexpr std::string_view maintenance {"Maintenance"};
        static constexpr std::string_view feedbackOpCl {"FeedbackOpCl"};
        static constexpr std::string_view feedbackAutoSemiAuto {"FeedbackAutoSemiAuto"};
        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"};
    };
    struct DefaultValues
    {
        static constexpr bool isControl {false};
        struct Colors
        {
            static constexpr iv::types::color color {iv::color::Gray};
 
            static constexpr iv::types::color workingStateOpen {iv::color::SedniElementWorkingGreen};
            static constexpr iv::types::color workingStateClose {iv::color::SedniElementNotWorkingBlack};
            static constexpr iv::types::color workingStateUndefined {iv::color::SedniElementUndefined};
            static constexpr iv::types::color workingStateOffline {iv::color::SedniElementOfflineBlack};
 
            static constexpr iv::types::color controlStateLocal {iv::color::SedniLocal};
            static constexpr iv::types::color controlStateRemoteSemiAuto {iv::color::SedniSemiAuto};
            static constexpr iv::types::color controlStateRemoteAuto {iv::color::SedniAuto};
            static constexpr iv::types::color controlStateOffline {iv::color::SedniElementOfflineGrey};
        };
    };
};
 
}// namespace iv::mimics::elements
 
#endif//IV_SRC_MIMICS_INDICATORS_DAMPER_HPP_