CLogicsComponentLabel.hpp

Go to the documentation of this file.

#ifndef LIBS_LOGIC_CLOGICSCOMPONENTLABEL_HPP_
#define LIBS_LOGIC_CLOGICSCOMPONENTLABEL_HPP_
 
#include "logic/components/CLogicsComponentOthers.hpp"
 
#include <bits/stdint-uintn.h>
#include <string>
 
class CLogicsComponentLabel : public CLogicsComponentOthers
{
public:
    enum class ELabelIOType
    {
        Input,
        Output,
        Without
    };// type of connection point the label is connected to
 
    typedef uint16_t
            TUniqueLabelDefaultIdNumber;// default names for labels will be assigned a number, like "LB_1", "LB_2", etc.
    static inline const TUniqueLabelDefaultIdNumber kInitialUniqueLabelIdNumber = 1;
    static inline const std::string kDefaultUniqueLabelName = "LB_";
    static inline const std::string kUnsetLabel = "???";
 
    static ELabelIOType enumLabelIOType(const std::string &strType);
    static std::string strLabelIOType(ELabelIOType labelIOType);
 
    explicit CLogicsComponentLabel(const iv::types::logic::ComponentType &componentType);
    CLogicsComponentLabel(AbstractCanvasItem::TId id, const iv::types::logic::ComponentType &componentType,
                          const std::string &name);
    CLogicsComponentLabel() = delete;
    ~CLogicsComponentLabel() override = default;
    CLogicsComponentLabel(const CLogicsComponentLabel &other) = delete;
    CLogicsComponentLabel(CLogicsComponentLabel &&other) = delete;
    CLogicsComponentLabel &operator=(const CLogicsComponentLabel &other) = delete;
    CLogicsComponentLabel &operator=(CLogicsComponentLabel &&other) = delete;
 
    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;
 
    void setLabelDescription(const std::string &description);
    void setLabelIOTYpe(ELabelIOType labelIOType);
    void setLabelName(const std::string &labelName);
 
    [[nodiscard]] ELabelIOType getLabelIOType() const;
    [[nodiscard]] const std::string &getLabelDescription() const;
    [[nodiscard]] const std::string &getLabelName() const;
 
private:
    ELabelIOType m_labelIOType;
    std::string m_labelName;// name of label, which will also be its identifier
    std::string m_labelDescription;
};
 
#endif /* LIBS_LOGIC_CLOGICSCOMPONENTLABEL_HPP_ */