X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_Data.h;h=71e9aee9d631201cbfb632a55811b6882ab1c707;hb=f0cec241aae9ca16d86e166f45cb5c4987d2c792;hp=8cc137477029665743eee48b877600859cb118bc;hpb=35a88fdd724349275bbff32b9596a44e7cd422e2;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_Data.h b/src/ModelAPI/ModelAPI_Data.h index 8cc137477..71e9aee9d 100644 --- a/src/ModelAPI/ModelAPI_Data.h +++ b/src/ModelAPI/ModelAPI_Data.h @@ -1,3 +1,5 @@ +// Copyright (C) 2014-20xx CEA/DEN, EDF R&D + // File: ModelAPI_Data.hxx // Created: 21 Mar 2014 // Author: Mikhail PONIKAROV @@ -5,18 +7,25 @@ #ifndef ModelAPI_Data_H_ #define ModelAPI_Data_H_ +#ifdef _WINDOWS // to avoid too long decorated name warning +#pragma warning( disable : 4503 ) +#endif + #include "ModelAPI.h" #include #include #include #include +class ModelAPI_Attribute; class ModelAPI_AttributeDocRef; class ModelAPI_AttributeInteger; class ModelAPI_AttributeDouble; +class ModelAPI_AttributeDoubleArray; class ModelAPI_AttributeReference; class ModelAPI_AttributeRefAttr; class ModelAPI_AttributeRefList; +class ModelAPI_AttributeRefAttrList; class ModelAPI_AttributeBoolean; class ModelAPI_AttributeString; class ModelAPI_Document; @@ -24,8 +33,19 @@ class ModelAPI_Attribute; class ModelAPI_Feature; class ModelAPI_AttributeSelection; class ModelAPI_AttributeSelectionList; +class ModelAPI_AttributeIntArray; +class ModelAPI_Object; class GeomAPI_Shape; +/// Enumeration that contains the execution status of the Object +enum ModelAPI_ExecState { + ModelAPI_StateDone, ///< execution was performed and result is up to date + ModelAPI_StateMustBeUpdated, ///< execution must be performed to obtain the up to date result + ModelAPI_StateExecFailed, ///< execution was failed (results are deleted in this case) + ModelAPI_StateInvalidArgument, ///< execution was not performed (results are deleted in this case) + ModelAPI_StateNothing ///< internal state that actually means that nothing must be changed +}; + /**\class ModelAPI_Data * \ingroup DataModel * \brief General object of the application that allows @@ -46,6 +66,8 @@ class MODELAPI_EXPORT ModelAPI_Data virtual std::shared_ptr document(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; + /// Returns the attribute that contains double values array + virtual std::shared_ptr realArray(const std::string& theID) = 0; /// Returns the attribute that contains integer value virtual std::shared_ptr integer(const std::string& theID) = 0; /// Returns the attribute that contains reference to a feature @@ -59,10 +81,15 @@ class MODELAPI_EXPORT ModelAPI_Data virtual std::shared_ptr refattr(const std::string& theID) = 0; /// Returns the attribute that contains list of references to features virtual std::shared_ptr reflist(const std::string& theID) = 0; + /// Returns the attribute that contains list of references to features or reference to + /// an attribute of a feature + virtual std::shared_ptr refattrlist(const std::string& theID) = 0; /// Returns the attribute that contains boolean value virtual std::shared_ptr boolean(const std::string& theID) = 0; /// Returns the attribute that contains boolean value virtual std::shared_ptr string(const std::string& theID) = 0; + /// Returns the attribute that contains integer values array + virtual std::shared_ptr intArray(const std::string& theID) = 0; /// Returns the generic attribute by identifier /// \param theID identifier of the attribute @@ -86,38 +113,91 @@ class MODELAPI_EXPORT ModelAPI_Data /// 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(const std::string& theID, const std::string theAttrType) = 0; + /// \returns the just created attribute + virtual std::shared_ptr + addAttribute(const std::string& theID, const std::string theAttrType) = 0; /// Useful method for "set" methods of the attributes: sends an UPDATE event and /// makes attribute initialized virtual void sendAttributeUpdated(ModelAPI_Attribute* theAttr) = 0; + /// Blocks sending "attribute updated" if theBlock is true + /// \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) + /// \returns the just created attribute + virtual void blockSendAttributeUpdated( + const bool theBlock, const bool theSendMessage = true) = 0; /// Erases all the data from the data model virtual void erase() = 0; /// To virtually destroy the fields of successors - virtual ~ModelAPI_Data() - { - } + virtual ~ModelAPI_Data(); + + /// Stores the state of the object to execute it later accordingly + virtual void execState(const ModelAPI_ExecState theState) = 0; - /// Makes feature must be updated later (on rebuild). Normally the Updater must call it - /// in case of not-automatic update to true - virtual void mustBeUpdated(const bool theFlag) = 0; + /// Returns the state of the latest execution of the feature + virtual ModelAPI_ExecState execState() = 0; - /// Returns true if feature must be updated (re-executed) on rebuild - virtual bool mustBeUpdated() = 0; + /// Registers error during the execution, causes the ExecutionFailed state + virtual void setError(const std::string& theError, bool theSend = true) = 0; + + /// Returns error, arose during the execution + virtual std::string error() const = 0; /// Returns the identifier of feature-owner, unique in this document virtual int featureId() const = 0; - // returns all objects referenced to this + /// returns all objects referenced to this virtual const std::set >& refsToMe() = 0; + /// returns all references by attributes of this data + /// \param theRefs returned list of pairs: id of referenced attribute and list of referenced objects + virtual void referencesToObjects( + std::list > > >& theRefs) =0; + + /// Copies all attributes content into theTarget data + virtual void copyTo(std::shared_ptr theTarget) = 0; + + /// Returns the invalid data pointer (to avoid working with NULL shared ptrs in swig) + virtual std::shared_ptr invalidPtr() = 0; + + /// Identifier of the transaction when object (feature or result) was updated last time. + virtual int updateID() = 0; + + /// Identifier of the transaction when object (feature or result) was updated last time. + /// This method is called by the updater. + virtual void setUpdateID(const int theID) = 0; + + /// Returns the owner of htis data + virtual std::shared_ptr owner() = 0; + + /// Returns true if the object is deleted, but some data is still keept in memory + virtual bool isDeleted() = 0; + + /// Sets true if the object is deleted, but some data is still keept in memory + virtual void setIsDeleted(const bool theFlag) = 0; + protected: /// Objects are created for features automatically - ModelAPI_Data() - { - } + ModelAPI_Data(); + + /// Returns true if "is in history" custom behaviors is defined for the feature + virtual bool isInHistory() = 0; + + /// Defines the custom "is in history" behavior + virtual void setIsInHistory(const bool theFlag) = 0; + + /// 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. + virtual bool isDisplayed() = 0; + + /// Sets the displayed/hidden state of the object. If it is changed, sends the "redisplay" + /// signal. + virtual void setDisplayed(const bool theDisplay) = 0; + + friend class ModelAPI_Object; }; typedef std::shared_ptr DataPtr;