Salome HOME
Merge branch 'master' of newgeom:newgeom.git
[modules/shaper.git] / src / ModelAPI / ModelAPI_Attribute.h
index 5173855f9eafe03a9bc8560238cc7dab61833a34..cfef5172421791a08ebd6958ca018a3000be1378 100644 (file)
@@ -19,42 +19,87 @@ class ModelAPI_Attribute
 {
   ///< needed here to emit signal that feature changed on change of the attribute
   boost::shared_ptr<ModelAPI_Object> myObject;
-protected: // accessible from the attributes
+ protected:
+  // accessible from the attributes
   bool myIsInitialized;
   bool myIsArgument;
-public:
-  
+  bool myIsImmutable;
+
+ public:
+
   /// Returns the type of this class of attributes, not static method
   MODELAPI_EXPORT virtual std::string attributeType() = 0;
 
   /// To virtually destroy the fields of successors
-  MODELAPI_EXPORT virtual ~ModelAPI_Attribute() {}
+  MODELAPI_EXPORT virtual ~ModelAPI_Attribute()
+  {
+  }
 
   /// Sets the owner of this attribute
-  MODELAPI_EXPORT void setObject(const boost::shared_ptr<ModelAPI_Object>& theObject)
-    {myObject = theObject;}
+  MODELAPI_EXPORT virtual void setObject(const boost::shared_ptr<ModelAPI_Object>& theObject)
+  {
+    myObject = theObject;
+  }
 
   /// Returns the owner of this attribute
-  MODELAPI_EXPORT const boost::shared_ptr<ModelAPI_Object>& owner()
-  {return myObject;}
+  MODELAPI_EXPORT const boost::shared_ptr<ModelAPI_Object>& owner() const
+  {
+    return myObject;
+  }
 
   /// Returns true if attribute was  initialized by some value
-  MODELAPI_EXPORT bool isInitialized() {return myIsInitialized;}
+  MODELAPI_EXPORT bool isInitialized()
+  {
+    return myIsInitialized;
+  }
 
   /// Makes attribute initialized
-  MODELAPI_EXPORT void setInitialized() {myIsInitialized = true;}
+  MODELAPI_EXPORT void setInitialized()
+  {
+    myIsInitialized = true;
+  }
 
   /// Set this attribute is argument for result (change of this attribute requires update of result).
   /// By default it is true.
-  MODELAPI_EXPORT void setIsArgument(const bool theFlag) {myIsArgument = theFlag;}
+  MODELAPI_EXPORT void setIsArgument(const bool theFlag)
+  {
+    myIsArgument = theFlag;
+  }
 
   /// Returns true if attribute causes the result change
-  MODELAPI_EXPORT bool isArgument() {return myIsArgument;}
+  MODELAPI_EXPORT bool isArgument()
+  {
+    return myIsArgument;
+  }
+
+  /// Immutable argument can not be changed programaticaly (e.g. by constraint)
+  /// By default it is false.
+  /// Returns the previous state of the attribute's immutability.
+  MODELAPI_EXPORT bool setImmutable(const bool theFlag)
+  {
+    bool aResult = myIsImmutable;
+    myIsImmutable = theFlag;
+    return aResult;
+  }
 
-protected:
+  /// Returns true if can not be changed programaticaly
+  MODELAPI_EXPORT bool isImmutable()
+  {
+    return myIsImmutable;
+  }
+
+ protected:
   /// Objects are created for features automatically
-  ModelAPI_Attribute() {myIsInitialized = false; myIsArgument = true;}
+  ModelAPI_Attribute()
+  {
+    myIsInitialized = false;
+    myIsArgument = true;
+    myIsImmutable = false;
+  }
 
 };
 
+//! Pointer on attribute object
+typedef boost::shared_ptr<ModelAPI_Attribute> AttributePtr;
+
 #endif