X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_Object.h;h=7ac6696f5ad5b0433b2d662bd2c5917f6858372f;hb=4b5410d157f6aab17772617fcaa09c5d660d13e9;hp=cf81f99bfee1dda02e24ba738a498ef8c6aeaf65;hpb=cf6ecce56482c1e15c6381d76b553004f87d3dd3;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_Object.h b/src/ModelAPI/ModelAPI_Object.h index cf81f99bf..7ac6696f5 100644 --- a/src/ModelAPI/ModelAPI_Object.h +++ b/src/ModelAPI/ModelAPI_Object.h @@ -1,52 +1,85 @@ // File: ModelAPI_Object.hxx -// Created: 21 Mar 2014 +// Created: 19 May 2014 // Author: Mikhail PONIKAROV -#ifndef ModelAPI_Object_HeaderFile -#define ModelAPI_Object_HeaderFile +#ifndef ModelAPI_Object_H_ +#define ModelAPI_Object_H_ #include "ModelAPI.h" -#include -#include +#include "ModelAPI_Data.h" -class ModelAPI_AttributeDocRef; -class ModelAPI_AttributeDouble; +#include + +class ModelAPI_Data; class ModelAPI_Document; /**\class ModelAPI_Object * \ingroup DataModel - * \brief General object of the application that allows - * to get/set attributes from the document and compute result of an operation. + * \brief Represents any object in the data model and in the object browser. + * + * It may be feature or result of the feature. User just may set name for it + * or change this name later. Generic class for Feature, Body, Parameter and other + * objects related to the features and their results. Contains attributes of this + * object in the "Data". */ - -class MODELAPI_EXPORT ModelAPI_Object +class ModelAPI_Object { -public: + boost::shared_ptr myData; ///< manager of the data model of a feature + boost::shared_ptr myDoc; ///< document this object belongs to + public: + /// By default object is displayed in the object browser. + virtual bool isInHistory() + { + return true; + } + + /// Returns the data manager of this object: attributes + virtual boost::shared_ptr data() const + { + return myData; + } + + /// Returns true if object refers to the same data model instance + virtual bool isSame(const boost::shared_ptr& theObject) + { + return theObject.get() == this; + } - /// Returns the name of the feature visible by the user in the object browser - virtual std::string getName() = 0; + /// Returns document this feature belongs to + virtual boost::shared_ptr document() const + { + return myDoc; + } - /// Defines the name of the feature visible by the user in the object browser - virtual void setName(std::string theName) = 0; + /// Returns the group identifier of this object + virtual std::string groupName() = 0; - /// Returns the attribute that references to another document - virtual std::shared_ptr docRef(const std::string theID) = 0; - /// Returns the attribute that contains real value with double precision - virtual std::shared_ptr real(const std::string theID) = 0; + /// To use virtuality for destructors + virtual ~ModelAPI_Object() {} - /// Initializes object by the attributes: must be called just after the object is created - /// for each attribute of the object - /// \param theID identifier of the attribute that can be referenced by this ID later - /// \param theAttrType type of the created attribute (received from the type method) - virtual void addAttribute(std::string theID, std::string theAttrType) = 0; + protected: + /// Sets the data manager of an object (document does) + virtual void setData(boost::shared_ptr theData) + { + myData = theData; + } - /// Returns the document of this data - virtual std::shared_ptr document() = 0; + /// Sets the data manager of an object (document does) + virtual void setDoc(boost::shared_ptr theDoc) + { + myDoc = theDoc; + } + + /// removes all fields from this feature + MODELAPI_EXPORT virtual void erase() { + if (myData) myData->erase(); + setData(DataPtr()); + } + + friend class Model_Document; -protected: - /// Objects are created for features automatically - ModelAPI_Object() - {} }; +typedef boost::shared_ptr ObjectPtr; + #endif