1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: ModelAPI_Attribute.h
5 // Author: Mikhail PONIKAROV
7 #ifndef ModelAPI_Attribute_H_
8 #define ModelAPI_Attribute_H_
14 class ModelAPI_Object;
16 /**\class ModelAPI_Attribute
18 * \brief Generic attribute of the Object.
20 class ModelAPI_Attribute
22 ///< needed here to emit signal that feature changed on change of the attribute
23 std::shared_ptr<ModelAPI_Object> myObject;
24 std::string myID; ///< identifier of this attribute in Data class
26 // accessible from the attributes
27 bool myIsInitialized; ///< is some value assigned to this attribute
28 bool myIsArgument; ///< is this attribute used as an argument for execution
29 bool myIsImmutable; ///< is this attribute can be changed programmatically (e.g. by constraint)
33 /// Returns the type of this class of attributes, not static method
34 MODELAPI_EXPORT virtual std::string attributeType() = 0;
36 /// To virtually destroy the fields of successors
37 MODELAPI_EXPORT virtual ~ModelAPI_Attribute()
41 /// Sets the owner of this attribute
42 MODELAPI_EXPORT virtual void setObject(const std::shared_ptr<ModelAPI_Object>& theObject)
47 /// Returns the owner of this attribute
48 MODELAPI_EXPORT const std::shared_ptr<ModelAPI_Object>& owner() const
53 /// Returns true if attribute was initialized by some value
54 MODELAPI_EXPORT bool isInitialized()
56 return myIsInitialized;
59 /// Makes attribute initialized
60 MODELAPI_EXPORT void setInitialized()
62 myIsInitialized = true;
65 /// Set this attribute is argument for result (change of this attribute requires update of result).
66 /// By default it is true.
67 MODELAPI_EXPORT void setIsArgument(const bool theFlag)
69 myIsArgument = theFlag;
72 /// Returns true if attribute causes the result change
73 MODELAPI_EXPORT bool isArgument()
78 /// Immutable argument can not be changed programaticaly (e.g. by constraint)
79 /// By default it is false.
80 /// Returns the previous state of the attribute's immutability.
81 MODELAPI_EXPORT bool setImmutable(const bool theFlag)
83 bool aResult = myIsImmutable;
84 myIsImmutable = theFlag;
88 /// Returns true if can not be changed programaticaly
89 MODELAPI_EXPORT bool isImmutable()
94 /// ID of the attribute in Data
95 MODELAPI_EXPORT const std::string& id() const
101 /// Objects are created for features automatically
104 myIsInitialized = false;
106 myIsImmutable = false;
109 /// Sets the ID of the attribute in Data (called from Data)
110 MODELAPI_EXPORT void setID(const std::string theID)
115 friend class Model_Data;
118 //! Pointer on attribute object
119 typedef std::shared_ptr<ModelAPI_Attribute> AttributePtr;