X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_Object.h;h=07776479cf194c85bbae1d5bd82807fab11315b1;hb=dc50f2f6b509a5dd5de0be397a3fe4564cb8d98d;hp=490e5617ac77205b85adf6c2c4b9b370db57f3fc;hpb=1a0a0306f6d0f56c009b29cba0b53e8d1abd4edf;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_Object.h b/src/ModelAPI/ModelAPI_Object.h index 490e5617a..07776479c 100644 --- a/src/ModelAPI/ModelAPI_Object.h +++ b/src/ModelAPI/ModelAPI_Object.h @@ -1,45 +1,96 @@ +// Copyright (C) 2014-20xx CEA/DEN, EDF R&D + // 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 "ModelAPI_Data.h" +#include "ModelAPI_Entity.h" + #include -class ModelAPI_AttributeDocRef; +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 ModelAPI_Entity { -public: + std::shared_ptr myData; ///< manager of the data model of a feature + std::shared_ptr myDoc; ///< document this object belongs to + public: + /// By default object is displayed in the object browser. + MODELAPI_EXPORT virtual bool isInHistory(); + + /// Makes object presented or not in the history of the created objects + /// \param theObject is shared pointer to "this" + /// \param theFlag is boolean value: to add or remove from the history + MODELAPI_EXPORT virtual void setInHistory( + const std::shared_ptr theObject, const bool theFlag); + + /// Returns the data manager of this object: attributes + MODELAPI_EXPORT virtual std::shared_ptr data() const; + + /// Returns true if object refers to the same data model instance + MODELAPI_EXPORT virtual bool isSame(const std::shared_ptr& theObject); + + /// Returns document this feature belongs to + MODELAPI_EXPORT virtual std::shared_ptr document() const; + + /// Returns the group identifier of this object + virtual std::string groupName() = 0; - /// Returns the name of the feature visible by the user in the object browser - virtual std::string getName() = 0; + /// Request for initialization of data model of the object: adding all attributes + virtual void initAttributes() = 0; - /// Defines the name of the feature visible by the user in the object browser - virtual void setName(std::string theName) = 0; + /// Returns the feature is disabled or not. + virtual bool isDisabled() const = 0; - /// Returns the attribute that references to another document - virtual std::shared_ptr docRef(const std::string theID) = 0; + /// Called on change of any argument-attribute of this object + /// \param theID identifier of changed attribute + MODELAPI_EXPORT virtual void attributeChanged(const std::string& theID); - /// 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; + /// Initializes the default states of the object + MODELAPI_EXPORT ModelAPI_Object(); + + /// To use virtuality for destructors + MODELAPI_EXPORT virtual ~ModelAPI_Object(); + + /// Returns true if object must be displayed in the viewer: flag is stored in the + /// data model, so on undo/redo, open/save or recreation of object by history-playing it keeps + /// the original state i nthe current transaction. + MODELAPI_EXPORT virtual bool isDisplayed(); + + /// Sets the displayed/hidden state of the object. If it is changed, sends the "redisplay" + /// signal. + MODELAPI_EXPORT virtual void setDisplayed(const bool theDisplay); + + protected: + /// Sets the data manager of an object (document does) + MODELAPI_EXPORT virtual void setData(std::shared_ptr theData); + + /// Sets the data manager of an object (document does) + MODELAPI_EXPORT virtual void setDoc(std::shared_ptr theDoc); + + /// removes all fields from this feature + MODELAPI_EXPORT virtual void erase(); + + friend class Model_Objects; + friend class Model_Document; -protected: - /// Objects are created for features automatically - ModelAPI_Object() - {} }; +typedef std::shared_ptr ObjectPtr; + #endif