src/ModelAPI/ModelAPI_Document.h

   1 // File:        ModelAPI_Document.cxx
   2 // Created:     28 Feb 2014
   3 // Author:      Mikhail PONIKAROV
   4
   5 #ifndef ModelAPI_Document_HeaderFile
   6 #define ModelAPI_Document_HeaderFile
   7
   8 #include <ModelAPI.h>
   9 #include <string>
  10 #include <memory>
  11 #include <vector>
  12
  13 class ModelAPI_Feature;
  14 class ModelAPI_Iterator;
  15
  16 /// Common groups identifiers
  17 /// Group of parameters
  18 static const std::string PARAMETERS_GROUP = "Parameters";
  19 /// Group of constructions
  20 static const std::string CONSTRUCTIONS_GROUP = "Construction";
  21 /// Group of parts
  22 static const std::string PARTS_GROUP = "Parts";
  23
  24 /// Event ID that model is updated
  25 static const char * EVENT_MODEL_UPDATED = "ModelUpdated";
  26
  27 /**\class Model_Document
  28  * \ingroup DataModel
  29  * \brief Document for internal data structure of any object storage. Corresponds to the SALOME study.
  30  * Document contains all data of te SALOME Study specific to this module
  31  * that must be written into the HDF file.
  32  * Also it provides acces to this data: open/save, transactions management etc.
  33  * to provide access to all stored data.
  34  */
  35 class ModelAPI_Document
  36 {
  37 public:
  38   //! Loads the OCAF document from the file.
  39   //! \param theFileName full name of the file to load
  40   //! \param theStudyID identifier of the SALOME study to associate with loaded file
  41   //! \returns true if file was loaded successfully
  42   MODELAPI_EXPORT virtual bool load(const char* theFileName) = 0;
  43
  44   //! Saves the OCAF document to the file.
  45   //! \param theFileName full name of the file to store
  46   //! \returns true if file was stored successfully
  47   MODELAPI_EXPORT virtual bool save(const char* theFileName) = 0;
  48
  49   //! Removes document data
  50   MODELAPI_EXPORT virtual void close() = 0;
  51
  52   //! Starts a new operation (opens a tansaction)
  53   MODELAPI_EXPORT virtual void startOperation() = 0;
  54   //! Finishes the previously started operation (closes the transaction)
  55   MODELAPI_EXPORT virtual void finishOperation() = 0;
  56   //! Aborts the operation
  57   MODELAPI_EXPORT virtual void abortOperation() = 0;
  58   //! Returns true if operation has been started, but not yet finished or aborted
  59   MODELAPI_EXPORT virtual bool isOperation() = 0;
  60   //! Returns true if document was modified (since creation/opening)
  61   MODELAPI_EXPORT virtual bool isModified() = 0;
  62
  63   //! Returns True if there are available Undos
  64   MODELAPI_EXPORT virtual bool canUndo() = 0;
  65   //! Undoes last operation
  66   MODELAPI_EXPORT virtual void undo() = 0;
  67   //! Returns True if there are available Redos
  68   MODELAPI_EXPORT virtual bool canRedo() = 0;
  69   //! Redoes last operation
  70   MODELAPI_EXPORT virtual void redo() = 0;
  71
  72   //! Adds to the document the new feature of the given feature id
  73   //! \param creates feature and puts it in the document
  74   MODELAPI_EXPORT virtual std::shared_ptr<ModelAPI_Feature> addFeature(std::string theID) = 0;
  75
  76   ///! Adds a new sub-document by the identifier, or returns existing one if it is already exist
  77   MODELAPI_EXPORT virtual std::shared_ptr<ModelAPI_Document> subDocument(std::string theDocID) = 0;
  78
  79   ///! Creates an iterator of the features by the specific groups
  80   MODELAPI_EXPORT virtual std::shared_ptr<ModelAPI_Iterator> featuresIterator(
  81     const std::string theGroup) = 0;
  82
  83   ///! Returns the id of hte document
  84   MODELAPI_EXPORT virtual const std::string& id() const = 0;
  85
  86   //! Returns the feature in the group by the index (started from zero)
  87   MODELAPI_EXPORT virtual std::shared_ptr<ModelAPI_Feature>
  88     feature(const std::string& theGroupID, const int theIndex) = 0;
  89
  90   //! Returns the index of feature in the group (zero based)
  91   MODELAPI_EXPORT virtual int featureIndex(std::shared_ptr<ModelAPI_Feature> theFeature) = 0;
  92
  93   ///! Returns the vector of groups already added to the document
  94   MODELAPI_EXPORT virtual const std::vector<std::string>& getGroups() const = 0;
  95
  96 protected:
  97   /// Only for SWIG wrapping it is here
  98   MODELAPI_EXPORT ModelAPI_Document()
  99   {}
 100 };
 101
 102 #endif