src/HYDROData/HYDROData_River.h

   1 // Copyright (C) 2007-2015  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Lesser General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2.1 of the License, or (at your option) any later version.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Lesser General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU Lesser General Public
  17 // License along with this library; if not, write to the Free Software
  18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 #ifndef HYDROData_River_HeaderFile
  24 #define HYDROData_River_HeaderFile
  25
  26 #include "HYDROData_NaturalObject.h"
  27
  28 DEFINE_STANDARD_HANDLE(HYDROData_River, HYDROData_NaturalObject)
  29
  30 /**\class HYDROData_River
  31  * \brief
  32  *
  33  */
  34 class HYDROData_River : public HYDROData_NaturalObject
  35 {
  36 protected:
  37   /**
  38    * Enumeration of tags corresponding to the persistent object parameters.
  39    */
  40   enum DataTag
  41   {
  42     DataTag_First = HYDROData_NaturalObject::DataTag_First + 100, ///< first tag, to reserve
  43   };
  44
  45 public:
  46   DEFINE_STANDARD_RTTI(HYDROData_River);
  47
  48   /**
  49    * Returns the kind of this object. Must be redefined in all objects of known type.
  50    */
  51   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const {return KIND_RIVER;}
  52
  53   /**
  54    * Dump object to Python script representation.
  55    */
  56   HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
  57
  58   /**
  59    * Update the immersible zone object.
  60    * Call this method whenever you made changes for object data.
  61    */
  62   HYDRODATA_EXPORT virtual void Update();
  63
  64   HYDRODATA_EXPORT virtual void UpdateLocalCS( double theDx, double theDy );
  65
  66   /**
  67    * Checks that object has 2D presentation. Reimlemented to retun true.
  68    */
  69   HYDRODATA_EXPORT virtual bool IsHas2dPrs() const;
  70
  71   /**
  72    * Returns the top shape of the object.
  73    */
  74   HYDRODATA_EXPORT virtual TopoDS_Shape GetTopShape() const;
  75
  76   /**
  77    * Returns the 3d shape of the object.
  78    */
  79   HYDRODATA_EXPORT virtual TopoDS_Shape GetShape3D() const;
  80
  81 protected:
  82
  83   friend class HYDROData_Iterator;
  84
  85   /**
  86    * Creates new object in the internal data structure. Use higher level objects
  87    * to create objects with real content.
  88    */
  89   HYDRODATA_EXPORT HYDROData_River();
  90
  91   /**
  92    * Destructs properties of the object and object itself, removes it from the document.
  93    */
  94   virtual HYDRODATA_EXPORT ~HYDROData_River();
  95 };
  96
  97 #endif