src/Model/Model_Document.h

   1 // File:        Model_Document.h
   2 // Created:     28 Feb 2014
   3 // Author:      Mikhail PONIKAROV
   4
   5 #ifndef Model_Document_HeaderFile
   6 #define Model_Document_HeaderFile
   7
   8 #include <Model.h>
   9 #include <ModelAPI_Document.h>
  10 #include <TDocStd_Document.hxx>
  11 #include <map>
  12
  13 class Handle_Model_Document;
  14
  15 /**\class Model_Document
  16  * \ingroup DataModel
  17  * \brief Document for internal data structure of any object storage. Corresponds to the SALOME study.
  18  * Document contains all data of te SALOME Study specific to this module
  19  * that must be written into the HDF file.
  20  * Also it provides acces to this data: open/save, transactions management etc.
  21  * to provide access to all stored data.
  22  */
  23
  24 class Model_Document: public ModelAPI_Document
  25 {
  26 public:
  27
  28   //! Loads the OCAF document from the file.
  29   //! \param theFileName full name of the file to load
  30   //! \param theStudyID identifier of the SALOME study to associate with loaded file
  31   //! \returns true if file was loaded successfully
  32   MODEL_EXPORT bool load(const char* theFileName);
  33
  34   //! Saves the OCAF document to the file.
  35   //! \param theFileName full name of the file to store
  36   //! \returns true if file was stored successfully
  37   MODEL_EXPORT bool save(const char* theFileName);
  38
  39   //! Removes document data
  40   MODEL_EXPORT void close();
  41
  42   //! Starts a new operation (opens a tansaction)
  43   MODEL_EXPORT void startOperation();
  44   //! Finishes the previously started operation (closes the transaction)
  45   MODEL_EXPORT void finishOperation();
  46   //! Aborts the operation
  47   MODEL_EXPORT void abortOperation();
  48   //! Returns true if operation has been started, but not yet finished or aborted
  49   MODEL_EXPORT bool isOperation();
  50   //! Returns true if document was modified (since creation/opening)
  51   MODEL_EXPORT bool isModified();
  52
  53   //! Returns True if there are available Undos
  54   MODEL_EXPORT bool canUndo();
  55   //! Undoes last operation
  56   MODEL_EXPORT void undo();
  57   //! Returns True if there are available Redos
  58   MODEL_EXPORT bool canRedo();
  59   //! Redoes last operation
  60   MODEL_EXPORT void redo();
  61
  62   //! Adds to the document the new feature of the given feature id
  63   //! \param creates feature and puts it in the document
  64   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Feature> addFeature(std::string theID);
  65
  66   //! Returns the existing feature by the label
  67   //! \param theLabel base label of the feature
  68   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Feature> feature(TDF_Label& theLabel);
  69
  70   //! Adds a new sub-document by the identifier, or returns existing one if it is already exist
  71   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Document> subDocument(std::string theDocID);
  72
  73   //! Creates an iterator of the features by the specific groups
  74   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Iterator> featuresIterator(
  75     const std::string theGroup);
  76
  77   MODEL_EXPORT virtual const std::string& id() const {return myID;}
  78
  79   //! Returns the feature in the group by the index (started from zero)
  80   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Feature>
  81     feature(const std::string& theGroupID, const int theIndex);
  82
  83   ///! Returns the vector of groups already added to the document
  84   MODEL_EXPORT virtual const std::vector<std::string>& getGroups() const;
  85
  86   //! Returns the index of feature in the group (zero based)
  87   //! \retruns -1 if not found
  88   MODEL_EXPORT virtual int featureIndex(std::shared_ptr<ModelAPI_Feature> theFeature);
  89
  90 protected:
  91
  92   //! Returns (creates if needed) the group label
  93   TDF_Label groupLabel(const std::string theGroup);
  94
  95   //! Initializes feature with a unique name in this group (unique name is generated as
  96   //! feature type + "_" + index
  97   void setUniqueName(std::shared_ptr<ModelAPI_Feature> theFeature);
  98
  99   //! Adds to the document the new feature
 100   void addFeature(const std::shared_ptr<ModelAPI_Feature> theFeature);
 101
 102   //! Creates new document with binary file format
 103   Model_Document(const std::string theID);
 104
 105   friend class Model_Application;
 106
 107 private:
 108   std::string myID; ///< identifier of the document in the application
 109   Handle_TDocStd_Document myDoc; ///< OCAF document
 110   int myTransactionsAfterSave; ///< number of transactions after the last "save" call, used for "IsModified" method
 111   std::map<std::string, TDF_Label> myGroups; ///< root labels of the features groups identified by names
 112   std::vector<std::string> myGroupsNames; ///< names of added groups to the document
 113 };
 114
 115 #endif