src/HYDROData/HYDROData_River.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 #ifndef HYDROData_River_HeaderFile
  20 #define HYDROData_River_HeaderFile
  21
  22 #include "HYDROData_NaturalObject.h"
  23
  24 /**\class HYDROData_River
  25  * \brief
  26  *
  27  */
  28 class HYDROData_River : public HYDROData_NaturalObject
  29 {
  30 protected:
  31   /**
  32    * Enumeration of tags corresponding to the persistent object parameters.
  33    */
  34   enum DataTag
  35   {
  36     DataTag_First = HYDROData_NaturalObject::DataTag_First + 100, ///< first tag, to reserve
  37   };
  38
  39 public:
  40   DEFINE_STANDARD_RTTIEXT(HYDROData_River, HYDROData_NaturalObject);
  41
  42   /**
  43    * Returns the kind of this object. Must be redefined in all objects of known type.
  44    */
  45   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const {return KIND_RIVER;}
  46
  47   /**
  48    * Dump object to Python script representation.
  49    */
  50   HYDRODATA_EXPORT virtual QStringList DumpToPython( const QString& thePyScriptPath,
  51                                                      MapOfTreatedObjects& theTreatedObjects ) const;
  52
  53   /**
  54    * Update the immersible zone object.
  55    * Call this method whenever you made changes for object data.
  56    */
  57   HYDRODATA_EXPORT virtual void Update();
  58
  59   HYDRODATA_EXPORT virtual void UpdateLocalCS( double theDx, double theDy );
  60
  61   /**
  62    * Checks that object has 2D presentation. Reimlemented to retun true.
  63    */
  64   HYDRODATA_EXPORT virtual bool IsHas2dPrs() const;
  65
  66 protected:
  67
  68   friend class HYDROData_Iterator;
  69
  70   /**
  71    * Creates new object in the internal data structure. Use higher level objects
  72    * to create objects with real content.
  73    */
  74   HYDRODATA_EXPORT HYDROData_River();
  75
  76   /**
  77    * Destructs properties of the object and object itself, removes it from the document.
  78    */
  79   virtual HYDRODATA_EXPORT ~HYDROData_River();
  80 };
  81
  82 #endif