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