X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_Data.h;h=a03a06c9bf9ff40a2c7c80cf4875558780ef2653;hb=9db45503b9ec9a48ee30e9ea7ce14eb34c139d5e;hp=3bae7c023be864d8134b40e4b08206a8567ddb5e;hpb=50eee93b00efc7e0e2595937d9cba45e131ca8cb;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_Data.h b/src/ModelAPI/ModelAPI_Data.h index 3bae7c023..a03a06c9b 100644 --- a/src/ModelAPI/ModelAPI_Data.h +++ b/src/ModelAPI/ModelAPI_Data.h @@ -1,23 +1,45 @@ +// Copyright (C) 2014-20xx CEA/DEN, EDF R&D + // File: ModelAPI_Data.hxx // Created: 21 Mar 2014 // Author: Mikhail PONIKAROV -#ifndef ModelAPI_Data_HeaderFile -#define ModelAPI_Data_HeaderFile +#ifndef ModelAPI_Data_H_ +#define ModelAPI_Data_H_ #include "ModelAPI.h" #include -#include +#include +#include +#include +class ModelAPI_Attribute; class ModelAPI_AttributeDocRef; +class ModelAPI_AttributeInteger; class ModelAPI_AttributeDouble; class ModelAPI_AttributeReference; class ModelAPI_AttributeRefAttr; class ModelAPI_AttributeRefList; +class ModelAPI_AttributeBoolean; +class ModelAPI_AttributeString; class ModelAPI_Document; 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 @@ -26,57 +48,107 @@ class GeomAPI_Shape; class MODELAPI_EXPORT ModelAPI_Data { -public: + public: /// Returns the name of the feature visible by the user in the object browser - virtual std::string getName() = 0; + virtual std::string name() = 0; /// Defines the name of the feature visible by the user in the object browser - virtual void setName(std::string theName) = 0; + virtual void setName(const std::string& theName) = 0; /// Returns the attribute that references to another document - virtual boost::shared_ptr docRef(const std::string theID) = 0; + virtual std::shared_ptr document(const std::string& theID) = 0; /// Returns the attribute that contains real value with double precision - virtual boost::shared_ptr real(const std::string theID) = 0; + virtual std::shared_ptr real(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 - virtual boost::shared_ptr reference(const std::string theID) = 0; + virtual std::shared_ptr reference(const std::string& theID) = 0; + /// Returns the attribute that contains selection to a shape + virtual std::shared_ptr selection(const std::string& theID) = 0; + /// Returns the attribute that contains selection to a shape + virtual std::shared_ptr + selectionList(const std::string& theID) = 0; /// Returns the attribute that contains reference to an attribute of a feature - virtual boost::shared_ptr refattr(const std::string theID) = 0; + virtual std::shared_ptr refattr(const std::string& theID) = 0; /// Returns the attribute that contains list of references to features - virtual boost::shared_ptr reflist(const std::string theID) = 0; + virtual std::shared_ptr reflist(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 - virtual boost::shared_ptr attribute(const std::string theID) = 0; + virtual std::shared_ptr attribute(const std::string& theID) = 0; + /// Returns all attributes of the feature of the given type + /// or all attributes if "theType" is empty + virtual std::list > + attributes(const std::string& theType) = 0; + /// Returns all attributes ids of the feature of the given type + /// or all attributes if "theType" is empty + virtual std::list attributesIDs(const std::string& theType) = 0; /// Identifier by the id (not fast, iteration by map) /// \param theAttr attribute already created in this data - virtual const std::string& id(const boost::shared_ptr theAttr) = 0; + virtual const std::string& id(const std::shared_ptr& theAttr) = 0; /// Returns true if data belongs to same features - virtual bool isEqual(const boost::shared_ptr theData) = 0; - /// Returns true if it is correctly connected t othe data model + virtual bool isEqual(const std::shared_ptr& theData) = 0; + /// Returns true if it is correctly connected to the data model virtual bool isValid() = 0; - /// Stores the shape (called by the execution method). - virtual void store(const boost::shared_ptr& theShape) = 0; - /// Returns the shape-result produced by this feature - virtual boost::shared_ptr shape() = 0; - /// 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; + /// \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 + virtual void blockSendAttributeUpdated(const bool theBlock) = 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; -protected: + /// Returns the state of the latest execution of the feature + virtual ModelAPI_ExecState execState() = 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 + 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 atributes content into theTarget data + virtual void copyTo(std::shared_ptr theTarget) = 0; + + protected: /// Objects are created for features automatically - ModelAPI_Data() - {} + ModelAPI_Data(); }; -typedef boost::shared_ptr DataPtr; - +typedef std::shared_ptr DataPtr; #endif