VersionGraphVersionCfg.h

Go to the documentation of this file.

 
// ###########################################################################################################################################################################################################################################################################################################################
 
#pragma once
 
// OpenTwin header
#include "OTSystem/ArchitectureInfo.h"
#include "OTCore/Serializable.h"
#include "OTGui/OTGuiAPIExport.h"
 
// std header
#include <list>
#include <vector>
#include <string>
 
#pragma warning(disable:4251)
 
namespace ot {
 
    class VersionGraphCfg;
 
    class OT_GUI_API_EXPORT VersionGraphVersionCfg : public Serializable {
    public:
#ifdef OT_OS_64Bit
        typedef long long VersionNumberType;
#else
        typedef long VersionNumberType;
#endif
 
        static VersionGraphVersionCfg createBranchNodeFromBranch(const std::string& _branch);
 
        VersionGraphVersionCfg();
        VersionGraphVersionCfg(const std::string& _versionName, const std::string& _label = std::string(), const std::string& _description = std::string());
        VersionGraphVersionCfg(const VersionGraphVersionCfg& _other);
        VersionGraphVersionCfg(VersionGraphVersionCfg&& _other) noexcept;
        virtual ~VersionGraphVersionCfg();
 
        VersionGraphVersionCfg& operator = (const VersionGraphVersionCfg& _other);
        VersionGraphVersionCfg& operator = (VersionGraphVersionCfg&& _other) noexcept;
        
        bool operator == (const std::string& _name) const;
 
        bool operator != (const std::string& _name) const;
 
        void addToJsonObject(ot::JsonValue& _object, ot::JsonAllocator& _allocator) const override;
 
        void setFromJsonObject(const ot::ConstJsonObject& _object) override;
 
        void setName(const std::string& _name) { m_name = _name; };
 
        const std::string& getName(void) const { return m_name; };
 
        std::string getBranchName(void) const;
 
        std::string getBranchNodeName(void) const;
 
        void setLabel(const std::string& _title) { m_label = _title; };
 
        const std::string& getLabel(void) const { return m_label; };
 
        void setDescription(const std::string& _description) { m_description = _description; };
        const std::string& getDescription(void) const { return m_description; };
 
        void setParentVersion(const std::string& _version) { m_parentVersion = _version; };
        const std::string& getParentVersion(void) const { return m_parentVersion; };
 
        void setDirectParentIsHidden(bool _isHidden) { m_directParentIsHidden = _isHidden; };
 
        bool getDirectParentIsHidden(void) const { return m_directParentIsHidden; };
 
        VersionNumberType getVersionNumber(void) const { return VersionGraphVersionCfg::getVersionNumber(m_name); };
 
        static VersionNumberType getVersionNumber(const std::string& _version);
 
        std::vector<VersionNumberType> getVersionNumbers(void) const;
        static std::vector<VersionNumberType> getVersionNumbers(const std::string& _version);
 
        bool isValid(void) const;
        
        static bool isValid(const std::string& _versionName);
 
        bool isOnActivePath(const std::string& _activeBranchName) const;
 
        static bool isOnActivePath(const std::string& _versionName, const std::string& _activeBranchName);
 
    private:
        std::string m_name;
        std::string m_label;
        std::string m_description;
        std::string m_parentVersion;
        bool m_directParentIsHidden;
    };
 
}