refs #651: wrapping land cover map by Python

[modules/hydro.git] / src / HYDROData / HYDROData_Region.h

diff --git a/src/HYDROData/HYDROData_Region.h b/src/HYDROData/HYDROData_Region.h
index 5ba5bf969527ec0575ce4fc0342c605d3b56aeb7..b8da0556160d93457d168e4c8480e8b67fa1633e 100644 (file)
--- a/src/HYDROData/HYDROData_Region.h
+++ b/src/HYDROData/HYDROData_Region.h
@@ -1,13 +1,34 @@
+// Copyright (C) 2014-2015  EDF-R&D
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
 
 #ifndef HYDROData_Region_HeaderFile
 #define HYDROData_Region_HeaderFile
 
-#include "HYDROData_Entity.h"
+#include "HYDROData_ShapesGroup.h"
 
 
 DEFINE_STANDARD_HANDLE(HYDROData_Region, HYDROData_Entity)
 
 class Handle(HYDROData_Zone);
+class Handle(HYDROData_Document);
+class TopoDS_Shape;
+class TopoDS_Face;
+class QStringList;
 
 /**\class HYDROData_Region
  * \brief Regions are groups (lists) of zones, they can include one or several zones.
@@ -40,6 +61,28 @@ public:
    */
   HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
 
+  /**
+   * Returns flag indicating that object is updateble or not.
+   */
+  HYDRODATA_EXPORT virtual bool CanBeUpdated() const;
+
+
+  /**
+   * Removes object and it child sub-objects from the data structure.
+   * Reimplemented to update names of regions in father calculation.
+   */
+  HYDRODATA_EXPORT virtual void Remove();
+
+  /**
+   * Returns flag indicating that object can be removed or not.
+   */
+  HYDRODATA_EXPORT virtual bool CanRemove();
+
+  /**
+   * Returns the list of all reference objects of this object.
+   */
+  HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
+
 
   /**
    * Add new one reference zone for region.
@@ -62,6 +105,16 @@ public:
    */
   HYDRODATA_EXPORT virtual void RemoveZones();
 
+  /**
+   * \brief Returns the shape of the region.
+   * Shape of the region could be:
+   * - a face which is the union of the region zones faces
+   * - a shell if the zones faces can't be united into one face
+   * \return shape as TopoDS_Shape
+   */
+  HYDRODATA_EXPORT virtual TopoDS_Shape GetShape( HYDROData_ShapesGroup::SeqOfGroupsDefs* theSeqOfGroups = 0 ) const;
+
+  HYDRODATA_EXPORT bool IsSubmersible() const;
 
 protected:
 
@@ -69,7 +122,10 @@ protected:
    * Create new one reference zone for region on child label.
    * The new zone is added into the list of reference zones.
    */
-  HYDRODATA_EXPORT virtual Handle(HYDROData_Zone) addNewZone();
+  HYDRODATA_EXPORT virtual Handle(HYDROData_Zone) addNewZone( const Handle(HYDROData_Document)& theDoc,
+                                                              const QString& thePrefix,
+                                                              const TopoDS_Face& theFace,
+                                                              const QStringList& theRefObjects );
 
 protected:
 
@@ -80,12 +136,12 @@ protected:
    * Creates new object in the internal data structure. Use higher level objects 
    * to create objects with real content.
    */
-  HYDROData_Region();
+  HYDRODATA_EXPORT HYDROData_Region();
 
   /**
    * Destructs properties of the object and object itself, removes it from the document.
    */
-  ~HYDROData_Region();
+  HYDRODATA_EXPORT ~HYDROData_Region();
 };
 
 #endif