PropertyBase.h

Go to the documentation of this file.

 
// ###########################################################################################################################################################################################################################################################################################################################
 
#pragma once
 
// OpenTwin header
#include "OTCore/Flags.h"
#include "OTCore/Serializable.h"
#include "OTCore/OTClassHelper.h"
#include "OTGui/OTGuiAPIExport.h"
 
// std header
#include <map>
#include <list>
#include <string>
 
#pragma warning(disable:4251)
 
namespace ot {
 
    class OT_GUI_API_EXPORT PropertyBase : public Serializable {
    public:
        enum PropertyFlag {
            NoFlags = 0x0000, 
            IsReadOnly = 0x0001, 
            IsProtected = 0x0002, 
            IsHidden = 0x0004, 
            HasMultipleValues = 0x0008, 
            HasInputError = 0x0010, 
            IsDeletable = 0x0020, 
            AllowCustomValues = 0x1000, 
            AllowMultiselection = 0x2000  
        };
 
        typedef Flags<PropertyFlag> PropertyFlags;
 
        static std::string toString(PropertyFlag _flag);
 
        static PropertyFlag stringToFlag(const std::string& _flag);
 
        static std::list<std::string> toStringList(PropertyFlags _flags);
 
        static PropertyFlags stringListToFlags(const std::list<std::string>& _flags);
 
        PropertyBase(PropertyFlags _flags = PropertyFlags(NoFlags));
 
        PropertyBase(const std::string& _name, PropertyFlags _flags = PropertyFlags(NoFlags));
        
        PropertyBase(const PropertyBase& _other);
 
        virtual ~PropertyBase() {};
 
        PropertyBase& operator = (const PropertyBase& _other);
 
        // ###########################################################################################################################################################################################################################################################################################################################
 
        // Base class functions
 
        virtual void addToJsonObject(ot::JsonValue& _object, ot::JsonAllocator& _allocator) const override;
 
        virtual void setFromJsonObject(const ot::ConstJsonObject& _object) override;
 
        // ###########################################################################################################################################################################################################################################################################################################################
 
        // Setter / Getter
 
        void setPropertyName(const std::string& _name) { m_name = _name; };
        const std::string& getPropertyName(void) const { return m_name; };
 
        void setPropertyTitle(const std::string& _title) { m_title = _title; };
 
        const std::string& getPropertyTitle(void) const { return (m_title.empty() ? m_name : m_title); };
 
        void setPropertyTip(const std::string& _tip) { m_tip = _tip; };
        std::string& getPropertyTip(void) { return m_tip; };
        const std::string& getPropertyTip(void) const { return m_tip; };
 
        void setPropertyFlag(PropertyFlag _flag, bool _active = true) { m_flags.setFlag(_flag, _active); };
        void setPropertyFlags(PropertyFlags _flags) { m_flags = _flags; };
        PropertyFlags& getPropertyFlags(void) { return m_flags; };
        const PropertyFlags& getPropertyFlags(void) const { return m_flags; };
 
        void setSpecialType(const std::string& _type) { m_specialType = _type; };
        const std::string& getSpecialType(void) const { return m_specialType; };
 
        void addAdditionalPropertyData(const std::string& _key, const std::string& _data) { m_data.insert_or_assign(_key, _data); };
        void setAdditionalPropertyData(const std::map<std::string, std::string>& _data) { m_data = _data; };
        const std::map<std::string, std::string>& getAllAdditionalPropertyData(void) const { return m_data; };
        std::string getAdditionalPropertyData(const std::string& _key) const;
 
    private:
        std::string m_tip; 
        std::string m_name; 
        std::string m_title; 
        std::string m_specialType; 
        std::map<std::string, std::string> m_data; 
        PropertyFlags m_flags; 
    };
 
}
 
OT_ADD_FLAG_FUNCTIONS(ot::PropertyBase::PropertyFlag)