PropertyDescriptor.h

Go to the documentation of this file.

#pragma once

#include <Core/DocObject.h>
#include <Core/PropertyBackLink.h>
#include <Core/PropertyGUID.h>
#include <Core/PropertyInteger.h>
#include <Core/PropertyLink.h>
#include <Core/PropertyLogical.h>
#include <Core/PropertyText.h>

namespace Core
{
/* @brief Saves and restore the characteristics of a Property
 */
class LX_CORE_EXPORT PropertyDescriptor : public Core::DocObject
{
    typedef Core::DocObject inherited;

    TYPESYSTEM_HEADER()
    LX_NODE_HEADER()
public:
    enum Type
    {
        UNDEFINED,
        INTEGER,
        DOUBLE,
        BOOL,
        STRING,
        ENUM,
        BUTTON,
        COLOR,
        POINT,
        OBJECT,
        GROUP,
        LXATTRIBUTE,
        LXFORMULA,
    };

    PropertyText parameterName;
    PropertyTextOpt defaultDisplayName;
    PropertyLogical isVisible;
    PropertyLogical isEditable;
    PropertyInteger translationId;
    PropertyInteger index;
    PropertyText guid;
    PropertyTextOpt ifcPropertyName;

    Core::PropertyText entryType;
    Core::PropertyText unit;
    Core::PropertyText detail;
    Core::PropertyLogical forPropertySetInfo;  // all properties for PropertySetInfo should have unique name
    Core::PropertyLogical forceLxProperty;  // property is "lx user property" even if it does not start with "lx_"
    Core::PropertyLogical isMaterialProperty;
    Core::PropertyInteger isLuccProperty;  // 0 is not lucc property, 1 is lucc property, 2 is unmodified lucc property from csv file

    PropertyDescriptor();
    virtual ~PropertyDescriptor();

    bool mustbeSaved() const override;
    void setMustbeSaved(bool aValue);
    virtual Type getType() const = 0;

    Base::String getDisplayName() const;

    // for App::PropertySetInfo
    Base::String getEntryType() const;                        // returns only existing type
    static Base::String getEntryType(const Base::String& s);  // fix for import
    static const std::vector<std::pair<Base::String, int>>& getEntryTypes() { return _entryTypes; }

protected:
    Core::DocObject* copy(Core::CoreDocument* toDoc, DocObjectMap& copyMap = DocObjectMap()) override;

    void restoreProperty(Core::Property* property,
                         const Base::String& name,
                         Base::AbstractXMLReader& reader,
                         Base::PersistenceVersion& version) override;

private:
    PropertyLogical mustbeSaved_;

    static std::vector<std::pair<Base::String, int>> _entryTypes;  // entryType, translation id //for App::PropertySetInfo
};

DECLARE_PROPERTY_TEMPLATES(Core::PropertyDescriptor, LX_CORE_EXPORT);
}  // namespace Core