src/HYDROData/HYDROData_Document.h

   1 #ifndef HYDROData_Document_HeaderFile
   2 #define HYDROData_Document_HeaderFile
   3
   4 #include <HYDROData.h>
   5 #include <HYDROData_Entity.h>
   6
   7 #include <TDocStd_Document.hxx>
   8
   9 class QFile;
  10
  11 /**
  12  * Errors that could appear on document open/save actions.
  13  * If there is no error, it is "OK".
  14  */
  15 enum Data_DocError {
  16   DocError_OK = 0, ///< success
  17   DocError_ResourcesProblem, ///< resources files are invalid or not found
  18   DocError_CanNotOpen, ///< can not open file for reading or writing
  19   DocError_InvalidVersion, ///< version of document is different than expected
  20   DocError_InvalidFormat, ///< format of the document is bad
  21   DocError_UnknownProblem ///< problem has unknown nature
  22 };
  23
  24 DEFINE_STANDARD_HANDLE(HYDROData_Document, MMgt_TShared)
  25
  26 /**\class HYDROData_Document
  27  *
  28  * \brief Document for internal data structure of any object storage. Corresponds to the SALOME study.
  29  *
  30  * Document contains all data of the Study specific to this module.
  31  * Also it provides acces to this data: open/save, transactions management etc.
  32  * to provide access to all stored data.
  33  */
  34
  35 class HYDROData_Document : public MMgt_TShared
  36 {
  37 public:
  38
  39   DEFINE_STANDARD_RTTI(HYDROData_Document);
  40
  41   //! Returns the existing document or creates new if it is not exist
  42   HYDRODATA_EXPORT static Handle(HYDROData_Document) Document(const int theStudyID);
  43
  44   //! Returns the document by object
  45   HYDRODATA_EXPORT static Handle(HYDROData_Document) Document(
  46     const TDF_Label& theObjectLabel );
  47
  48 public:
  49
  50   //! Returns true if data model contains document for this study
  51   HYDRODATA_EXPORT static bool HasDocument(const int theStudyID);
  52
  53   //! Get study id by document instance, if document doesn't exists return false
  54   HYDRODATA_EXPORT static bool DocumentId( const Handle(HYDROData_Document)& theDocument,
  55                                            int&                              theDocId );
  56
  57 public:
  58
  59   //! Loads the OCAF document from the file.
  60   //! \param theFileName full name of the file to load
  61   //! \param theStudyID identifier of the SALOME study to associate with loaded file
  62   //! \returns error status (OK in case of success)
  63   HYDRODATA_EXPORT static Data_DocError Load(const char* theFileName, const int theStudyID);
  64
  65   //! Saves the OCAF document to the file.
  66   //! \param theFileName full name of the file to store
  67   //! \returns error status (OK in case of success)
  68   HYDRODATA_EXPORT Data_DocError Save(const char* theFileName);
  69
  70   //! Removes document data
  71   HYDRODATA_EXPORT void Close();
  72
  73 public:
  74
  75   // Returns name of document instance in python dump script
  76   HYDRODATA_EXPORT QString GetDocPyName() const;
  77
  78   //! Dump study document to Python script representation.
  79   //! \param theFileName full name of the file to store
  80   //! \returns true if document has been successfuly dumped
  81   HYDRODATA_EXPORT bool DumpToPython( const QString& theFileName ) const;
  82
  83   //! Dump model data to Python script representation.
  84   HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
  85
  86 public:
  87
  88   //! Starts a new operation (opens a tansaction)
  89   HYDRODATA_EXPORT void StartOperation();
  90   //! Finishes the previously started operation (closes the transaction)
  91   HYDRODATA_EXPORT void CommitOperation(
  92     const TCollection_ExtendedString& theName = TCollection_ExtendedString());
  93   //! Aborts the operation
  94   HYDRODATA_EXPORT void AbortOperation();
  95   //! Returns true if operation has been started, but not yet finished or aborted
  96   HYDRODATA_EXPORT bool IsOperation();
  97   //! Returns true if document was modified (since creation/opening)
  98   HYDRODATA_EXPORT bool IsModified();
  99
 100 public:
 101
 102   //! Returns True if there are available Undos
 103   HYDRODATA_EXPORT bool CanUndo();
 104   //! Returns a list of stored undo actions
 105   HYDRODATA_EXPORT const TDF_DeltaList& GetUndos();
 106   //! Clears a list of stored undo actions
 107   HYDRODATA_EXPORT void ClearUndos();
 108   //! Undoes last operation
 109   HYDRODATA_EXPORT void Undo();
 110
 111   //! Returns True if there are available Redos
 112   HYDRODATA_EXPORT bool CanRedo();
 113   //! Returns a list of stored undo actions
 114   HYDRODATA_EXPORT const TDF_DeltaList& GetRedos();
 115   //! Clears a list of stored undo actions
 116   HYDRODATA_EXPORT void ClearRedos();
 117   //! Redoes last operation
 118   HYDRODATA_EXPORT void Redo();
 119
 120 public:
 121
 122   //! Creates and locates in the document a new object
 123   //! \param theKind kind of the created object, can not be UNKNOWN
 124   //! \returns the created object
 125   HYDRODATA_EXPORT Handle(HYDROData_Entity) CreateObject(const ObjectKind theKind);
 126
 127
 128   //! Find the data object with the specified name.
 129   HYDRODATA_EXPORT Handle(HYDROData_Entity) FindObjectByName(
 130     const QString&   theName,
 131     const ObjectKind theObjectKind = KIND_UNKNOWN ) const;
 132
 133   //! Find the data objects with the specified names.
 134   HYDRODATA_EXPORT HYDROData_SequenceOfObjects FindObjectsByNames(
 135     const QStringList& theNames,
 136     const ObjectKind   theObjectKind = KIND_UNKNOWN ) const;
 137
 138 protected:
 139
 140   friend class HYDROData_Iterator;
 141   friend class test_HYDROData_Document;
 142
 143   //! Creates new document: private because "Document" method must be used instead of direct creation.
 144   HYDRODATA_EXPORT HYDROData_Document();
 145   //! Creates new document by existing OCAF structure
 146   HYDRODATA_EXPORT HYDROData_Document(const Handle(TDocStd_Document)& theDoc);
 147   //! Deletes all high-level data, managed this document
 148   HYDRODATA_EXPORT ~HYDROData_Document();
 149
 150   //! Returns the new identifier of the new object (may be used for correct ordering of objects)
 151   HYDRODATA_EXPORT int NewID();
 152
 153   //! Returns the label where the objects are located (used by Iterator)
 154   HYDRODATA_EXPORT TDF_Label LabelOfObjects();
 155
 156 private:
 157
 158   // Dump header Python part in to file \c theFile
 159   bool DumpToPython( QFile&               theFile,
 160                      MapOfTreatedObjects& theTreatedObjects ) const;
 161
 162   // Dump objects of type \c theObjectKind to file \c theFile
 163   bool dumpPartitionToPython( QFile&               theFile,
 164                               MapOfTreatedObjects& theDumpedObjects,
 165                               const ObjectKind&    theObjectKind ) const;
 166
 167 private:
 168   Handle(TDocStd_Document) myDoc; ///< OCAF document instance corresponding for keeping all persistent data
 169   int myTransactionsAfterSave; ///< number of transactions after the last "save" call, used for "IsModified" method
 170 };
 171
 172 #endif