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