]> SALOME platform Git repositories - modules/hydro.git/blob - src/HYDROData/HYDROData_River.h
Salome HOME
Merge branch 'BR_LAND_COVER_MAP' of ssh://git.salome-platform.org/modules/hydro into...
[modules/hydro.git] / 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( const QString& thePyScriptPath,
53                                                      MapOfTreatedObjects& theTreatedObjects ) const;
54
55   /**
56    * Update the immersible zone object.
57    * Call this method whenever you made changes for object data.
58    */
59   HYDRODATA_EXPORT virtual void Update();
60
61   HYDRODATA_EXPORT virtual void UpdateLocalCS( double theDx, double theDy );
62
63   /**
64    * Checks that object has 2D presentation. Reimlemented to retun true.
65    */
66   HYDRODATA_EXPORT virtual bool IsHas2dPrs() const;
67
68 protected:
69
70   friend class HYDROData_Iterator;
71
72   /**
73    * Creates new object in the internal data structure. Use higher level objects 
74    * to create objects with real content.
75    */
76   HYDRODATA_EXPORT HYDROData_River();
77
78   /**
79    * Destructs properties of the object and object itself, removes it from the document.
80    */
81   virtual HYDRODATA_EXPORT ~HYDROData_River();
82 };
83
84 #endif