LogicComponentBroadCastChannel.hpp

Go to the documentation of this file.

#ifndef IV_LOGIC_COMPONENTS_LOGICCOMPONENTBROADCASTCHANNEL_HPP
#define IV_LOGIC_COMPONENTS_LOGICCOMPONENTBROADCASTCHANNEL_HPP
 
#include "logic/components/CLogicsComponentOthers.hpp"
 
#include <optional>
 
class LogicComponentBroadCastChannel final : public CLogicsComponentOthers
{
public:
    explicit LogicComponentBroadCastChannel(const iv::types::logic::ComponentType &componentType,
                                            std::optional<iv::types::unitId> unitId);
    LogicComponentBroadCastChannel(AbstractCanvasItem::TId id, const iv::types::logic::ComponentType &componentType,
                                   const std::string &name, std::optional<iv::types::unitId> unitId);
 
    ~LogicComponentBroadCastChannel() override = default;
 
    iv::file::xml::node read(const iv::file::xml::node &node) override;
    iv::file::xml::node save(iv::file::xml::node &node) const override;
 
    [[nodiscard]] std::string maxText() const override;
    [[nodiscard]] std::string getDescriptiveText() const override;
 
    [[nodiscard]] uint32_t firmwareValue() const;
    [[nodiscard]] iv::types::logic::channelGlobalId getChannelId() const;
    [[nodiscard]] std::string constantLogicStateToConstantFirmwareString() const;
 
    [[nodiscard]] std::string toString() const;
 
    iv::logic::eBroadCastChannelType m_broadCastChannelType;
 
    uint32_t indexArea() const;
    void setIndexArea(uint32_t indexArea);
 
    struct Constants
    {
        static constexpr uint32_t baseBroadCastDirection {768};
        static constexpr iv::types::logic::channelGlobalId baseChannelGlobalId {600};
        static constexpr uint32_t numBroadCastChannelTypes {4};//NewAlarm, SoundOff, Ack, DeadMan
        static constexpr uint32_t minIndexArea {1};
        static constexpr uint32_t maxIndexArea {5};
 
        static constexpr std::string_view firmwareNewAlarm {"BCC_NEW_ALARM"};
        static constexpr std::string_view firmwareSoundOff {"BCC_SOUND_OFF"};
        static constexpr std::string_view firmwareAck {"BCC_ACK"};
        static constexpr std::string_view firmwareDeadMan {"BCC_DEADMAN"};
    };
 
private:
    uint32_t m_indexArea;// From 1 to 5
    std::optional<iv::types::unitId> m_unitId;
 
    struct Sections
    {
        static constexpr std::string_view broadCastChannelData {"BoardCastChannelData"};
    };
    struct Keys
    {
        static constexpr std::string_view broadCastChannelType {"BoardCastChannelType"};
        static constexpr std::string_view indexArea {"IndexArea"};
    };
    struct DefaultValues
    {
        static constexpr std::string string {};
        static constexpr auto broadCastChannelType {iv::logic::eBroadCastChannelType::BroadCastNewAlarm};
        static constexpr uint32_t indexArea {1};
    };
};
 
#endif//IV_LOGIC_COMPONENTS_LOGICCOMPONENTBROADCASTCHANNEL_HPP