src/HYDROGUI/HYDROGUI_DataModel.h

   1 // Copyright (C) 2014-2015  EDF-R&D
   2 // This library is free software; you can redistribute it and/or
   3 // modify it under the terms of the GNU Lesser General Public
   4 // License as published by the Free Software Foundation; either
   5 // version 2.1 of the License, or (at your option) any later version.
   6 //
   7 // This library is distributed in the hope that it will be useful,
   8 // but WITHOUT ANY WARRANTY; without even the implied warranty of
   9 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  10 // Lesser General Public License for more details.
  11 //
  12 // You should have received a copy of the GNU Lesser General Public
  13 // License along with this library; if not, write to the Free Software
  14 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  15 //
  16 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  17 //
  18
  19
  20 #ifndef HYDROGUI_DATAMODEL_H
  21 #define HYDROGUI_DATAMODEL_H
  22
  23 #include <HYDROData_Document.h>
  24 #include <HYDROData_Entity.h>
  25 #include <HYDROData_Zone.h>
  26 #include <HYDROData_Region.h>
  27 #include <HYDROData_CalculationCase.h>
  28
  29 #include <QMap>
  30 #include <QList>
  31 #include <LightApp_DataModel.h>
  32
  33 #include <SUIT_TreeModel.h>
  34
  35 class CAM_DataObject;
  36 class SUIT_DataObject;
  37 class HYDROGUI_DataObject;
  38 class HYDROGUI_Zone;
  39
  40 /**
  41  * \class HYDROGUI_DataModel
  42  * \brief The class representing the HYDROGUI data model
  43  */
  44 class HYDROGUI_DataModel : public LightApp_DataModel, public SUIT_DataSearcher
  45 {
  46 public:
  47   /**
  48    * Constructor.
  49    * \param theModule module object
  50    */
  51   HYDROGUI_DataModel( CAM_Module* theModule );
  52   virtual ~HYDROGUI_DataModel();
  53
  54   /**
  55    * Open the document into the data model. Reimplemented.
  56    * \param theURL opened study path
  57    * \param theStudy object study
  58    * \param theFileList list of opened files for this model.
  59    */
  60   virtual bool open( const QString& theURL,
  61                      CAM_Study* theStudy,
  62                      QStringList theFileList );
  63
  64   /**
  65    * Saves the document. Reimplemented.
  66    * \param returned theFileList list of saved files of this model.
  67    */
  68   virtual bool save( QStringList& theFileList );
  69
  70   /**
  71    * Saves as the document. Reimplemented.
  72    * \param theURL saved study path
  73    * \param theStudy object study
  74    * \param returned theFileList list of saved files of this model.
  75    */
  76   virtual bool saveAs( const QString& theURL,
  77                        CAM_Study* theStudy,
  78                        QStringList& theFileList );
  79
  80   /**
  81    * Close the model and remove data. Reimplemented.
  82    */
  83   virtual bool close();
  84
  85   /**
  86    * Dump study data to Python script. Reimplemented.
  87    */
  88   virtual bool                        dumpPython( const QString& theURL,
  89                                                   CAM_Study*     theStudy,
  90                                                   bool           isMultiFile,
  91                                                   QStringList&   theListOfFiles );
  92
  93   /**
  94    * Returns modification status. Reimplemented.
  95    * \return boolean value of modification status
  96    */
  97   virtual bool isModified() const;
  98
  99   /**
 100    * Returns saving status. Reimplemented.
 101    * \return true if document has saved files on disc.
 102    */
 103   virtual bool isSaved() const;
 104
 105   /**
 106    * Updates the internal structure of data object tree.
 107    * \param theStudyId study identifier
 108    */
 109   virtual void update( const int theStudyId );
 110
 111   /**
 112    * Returns data object corresponding to the model object.
 113    * \param the data model object
 114    * \return the only one object referenced to the given data model object, or null if not found
 115    */
 116   virtual HYDROGUI_DataObject* getDataObject( const Handle(HYDROData_Entity)& theModelObject );
 117
 118   /**
 119    * Returns a data object referenced to the given data object.
 120    * \param the data object
 121    * \return the object referenced to the given object, or null if not found
 122    */
 123   virtual HYDROGUI_DataObject* getReferencedDataObject( HYDROGUI_DataObject* theObject );
 124
 125   /**
 126    * Finds the object by entry
 127    * \param theEntry an object entry
 128    */
 129   virtual SUIT_DataObject* findObject( const QString& theEntry ) const;
 130
 131   /**
 132    * Updates the internal structure of data object tree starting from specified data object \a obj.
 133    * \param theObject start data object
 134    * \param theStudy study object
 135    */
 136   virtual void update( LightApp_DataObject* theObject = 0,
 137                        LightApp_Study* theStudy = 0 );
 138
 139   /**
 140    * Creates a module object and set is a root for the model
 141    */
 142   CAM_DataObject* createRootModuleObject( SUIT_DataObject* theParent );
 143
 144   /**
 145    * Create a new region in the given calculation case containing given zones.
 146    */
 147   bool createNewRegion( Handle(HYDROData_CalculationCase) theCase,
 148                         const QList<HYDROGUI_Zone*>& theZonesList,
 149                         const bool theLandCover );
 150
 151   /**
 152    * Correct an internal model object according to the current document mode
 153    */
 154   void updateModel();
 155
 156   /**
 157    * Find a data object by the specified entry and kind
 158    */
 159   Handle(HYDROData_Entity) objectByEntry( const QString& theEntry,
 160                                           const ObjectKind theObjectKind = KIND_UNKNOWN );
 161
 162   /**
 163    * Check if it is possible to perform 'undo' operation
 164    */
 165   bool canUndo() const;
 166
 167   /**
 168    * Check if it is possible to perform 'redo' operation
 169    */
 170   bool canRedo() const;
 171
 172   /**
 173    * Returns the list of names of available 'undo' actions
 174    */
 175   QStringList undoNames() const;
 176
 177   /**
 178    * Returns the list of names of available 'redo' actions
 179    */
 180   QStringList redoNames() const;
 181
 182   /**
 183    * Clear the list of stored 'undo' actions
 184    */
 185   void clearUndos();
 186
 187   /**
 188    * Clear the list of stored 'redo' actions
 189    */
 190   void clearRedos();
 191
 192   /**
 193    * Perform the 'undo' operation
 194    */
 195   bool undo();
 196
 197   /**
 198    * Perform the 'redo' operation
 199    */
 200   bool redo();
 201
 202   /**
 203    * Check if it is possible to perform 'copy' operation
 204    */
 205   bool canCopy();
 206
 207   /**
 208    * Check if it is possible to perform 'paste' operation
 209    */
 210   bool canPaste();
 211
 212   /**
 213    * Perform the 'copy' operation
 214    */
 215   bool copy();
 216
 217   /**
 218    * Perform the 'paste' operation
 219    */
 220   bool paste();
 221
 222   /**
 223    * Rename the object
 224    */
 225   bool rename( Handle(HYDROData_Entity) theEntity, const QString& theName );
 226
 227   /**
 228    * Creates the Calculation Case subtree for usage within an operation dialog.
 229    * \param theParent a created object will be appended as a child of this GUI object
 230    * \param theCase the calculation case model object
 231    */
 232   void buildCaseTree( SUIT_DataObject*                  theParent,
 233                       Handle(HYDROData_CalculationCase) theCase );
 234
 235   /**
 236    * Updates the object subtree.
 237    * \param theObj the data model entity
 238    */
 239   void updateObjectTree( Handle(HYDROData_Entity)& theObj );
 240
 241   /**
 242    * Update the sequence of the objects to be copied
 243    */
 244   static void changeCopyingObjects( const HYDROData_SequenceOfObjects& );
 245
 246   /**
 247    * Returns name of the partition containing the objects of the specified kind
 248    * \param theObjectKind kind of objects
 249    * \return partition name
 250    */
 251   static QString partitionName( const ObjectKind theObjectKind );
 252
 253 protected:
 254   /**
 255    * Returns the document for the current study
 256    */
 257   Handle(HYDROData_Document) getDocument() const;
 258
 259   /**
 260    * Creates the GUI data object according to the model object.
 261    * \param theParent a created object will be appended as a child of this object
 262    * \param theModelObject model object
 263    * \param theParentEntry entry of parent object
 264    */
 265   LightApp_DataObject* createObject( SUIT_DataObject*         theParent,
 266                                      Handle(HYDROData_Entity) theModelObject,
 267                                      const QString&           theParentEntry = QString(),
 268                                      const bool               theIsBuildTree = true );
 269
 270   /**
 271    * Creates the GUI data object without corresponding model object: just by name
 272    * \param theParent a created object will be appended as a child of this object
 273    * \param theName name of this object
 274    * \param theParentEntry entry of parent object
 275    */
 276   LightApp_DataObject* createObject( SUIT_DataObject* theParent,
 277                                      const QString&   theName,
 278                                      const QString&   theParentEntry = QString() );
 279
 280   /**
 281    * Build object tree if the flag theIsBuildTree is true.
 282    * This is a conditional wrapper for buildObjectTree method.
 283    * \param theParent a created object will be appended as a child of this object
 284    * \param theObject the GUI object
 285    * \param theParentEntry the entry of parent object
 286    * \param theIsBuildTree if true then build the subtree of the GUI object
 287    * \param theIsInOperation if true then the tree is used for a browser within an operation, it is false by default
 288    */
 289   LightApp_DataObject* buildObject( SUIT_DataObject*     theParent,
 290                                     HYDROGUI_DataObject* theObject,
 291                                     const QString&       theParentEntry,
 292                                     const bool           theIsBuildTree,
 293                                     const bool           theIsInOperation = false );
 294
 295   /**
 296    * Build object tree if the flag theIsBuildTree is true.
 297    * \param theParent a created object will be appended as a child of this GUI object
 298    * \param theModelObject the data model zone object
 299    * \param theParentEntry the entry of parent object
 300    * \param theIsBuildTree if true then build the subtree of the GUI object
 301    * \param theIsInOperation if true then the tree is used for a browser within an operation, it is false by default
 302    */
 303   LightApp_DataObject* createZone( SUIT_DataObject*       theParent,
 304                                    Handle(HYDROData_Zone) theModelObject,
 305                                    const QString&         theParentEntry,
 306                                    const bool             theIsBuildTree ,
 307                                    const bool             theIsInOperation = false  );
 308
 309   /**
 310    * Build object tree if the flag theIsBuildTree is true.
 311    * \param theParent a created object will be appended as a child of this GUI object
 312    * \param theModelObject the data model region object
 313    * \param theParentEntry the entry of parent object
 314    * \param theIsBuildTree if true then build the subtree of the GUI object
 315    * \param theIsInOperation if true then the tree is used for a browser within an operation, it is false by default
 316    */
 317   LightApp_DataObject* createRegion( SUIT_DataObject*         theParent,
 318                                      Handle(HYDROData_Region) theModelObject,
 319                                      const QString&           theParentEntry,
 320                                      const bool               theIsBuildTree ,
 321                                      const bool               theIsInOperation = false );
 322   /**
 323    * Creates the default Strickler table object: both GUI data object and corresponding model object
 324    * \param theDocument a document into which created object will be added
 325    * \param theParent a created object will be appended as a child of this GUI object
 326    */
 327   void                 createDefaultStricklerTable( const Handle(HYDROData_Document)& theDocument,
 328                                                     LightApp_DataObject*              theParent );
 329   /**
 330    * Build partition for object.
 331    * \param theObject gui object for which the partition will be build
 332    * \param theObjects sequence of builded objects
 333    * \param thePartName name of created partition
 334    * \param theIsCreateEmpty if true then partition will be created in any case
 335    */
 336   void                 buildObjectPartition( SUIT_DataObject*                   theObject,
 337                                              const HYDROData_SequenceOfObjects& theObjects,
 338                                              const QString&                     thePartName,
 339                                              const bool                         theIsCreateEmpty );
 340
 341   /**
 342    * Build tree of a model object.
 343    * \param theParent a created object will be appended as a child of this object
 344    * \param theObject gui object for which the tree will be build
 345    * \param theParentEntry entry of parent object
 346    * \param theIsInOperation if true then the tree is used for a browser within an operation, it is false by default
 347    */
 348   void                 buildObjectTree( SUIT_DataObject* theParent,
 349                                         SUIT_DataObject* theObject,
 350                                         const QString&   theParentEntry = QString(),
 351                                         const bool       theIsInOperation = false );
 352
 353   /**
 354    * Removes data object from the tree.
 355    * \param theParent an object will be removed from this parent.
 356    * \param theChild the removed object.
 357    */
 358   void removeChild( SUIT_DataObject* theParent,
 359                     SUIT_DataObject* theChild );
 360
 361   /**
 362    * Returns the first child of the object with the specified name
 363    * \param theFather object that contain the searched object in children
 364    * \param theName name f the searched data object
 365    * \returns NULL if not found
 366    */
 367   static SUIT_DataObject* findChildByName( const SUIT_DataObject* theFather,
 368                                            const QString& theName );
 369
 370 protected:
 371   QString myStudyURL; ///< the saved/opened document URL
 372   QByteArray myStates;
 373 };
 374
 375 #endif