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