src/HYDROData/HYDROData_LandCoverMap.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_LANDCOVER_MAP_HeaderFile
  20 #define HYDROData_LANDCOVER_MAP_HeaderFile
  21
  22 #include <HYDROData_Entity.h>
  23 #include <TDataStd_ExtStringArray.hxx>
  24 #include <NCollection_IndexedDataMap.hxx>
  25 #include <QString>
  26 #include <TopoDS_Face.hxx>
  27 #include <TopExp_Explorer.hxx>
  28 #include <vector>
  29 #include <set>
  30
  31 class Handle_HYDROData_StricklerTable;
  32 #include <TopTools_IndexedDataMapOfShapeListOfShape.hxx>
  33
  34 typedef NCollection_IndexedDataMap<TopoDS_Face, QString> HYDROData_MapOfFaceToStricklerType;
  35
  36 DEFINE_STANDARD_HANDLE( HYDROData_LandCoverMap, HYDROData_Entity )
  37
  38 class TopoDS_Shape;
  39 class TopoDS_Wire;
  40 class TopoDS_Iterator;
  41 class TopTools_ListOfShape;
  42 class Handle( HYDROData_PolylineXY );
  43 class Handle( HYDROData_Object );
  44 class gp_Pnt2d;
  45
  46 class HYDROData_LandCoverMap : public HYDROData_Entity
  47 {
  48 protected:
  49   friend class HYDROData_Iterator;
  50
  51   enum DataTag
  52   {
  53     DataTag_First = HYDROData_Entity::DataTag_First + 100, ///< first tag, to reserve
  54     DataTag_Shape,                                         ///< the shape presentation of the land cover map
  55     DataTag_Types,
  56     DataTag_Transparency,
  57   };
  58
  59 public:
  60   class Explorer
  61   {
  62   public:
  63     Explorer( const HYDROData_LandCoverMap& );
  64     HYDRODATA_EXPORT Explorer( const Handle( HYDROData_LandCoverMap )& );
  65     HYDRODATA_EXPORT ~Explorer();
  66
  67     void Init( const HYDROData_LandCoverMap& );
  68     HYDRODATA_EXPORT bool More() const;
  69     HYDRODATA_EXPORT void Next();
  70
  71     int Index() const;
  72     HYDRODATA_EXPORT TopoDS_Face Face() const;
  73     HYDRODATA_EXPORT QString StricklerType() const;
  74     void SetStricklerType( const QString& );
  75
  76   private:
  77     TopExp_Explorer* myExplorer;
  78     int              myIndex;
  79     Handle(TDataStd_ExtStringArray) myArray;
  80   };
  81
  82   enum DBFStatus
  83   {
  84     DBFStatus_OK,
  85     DBFStatus_DIFF_SIZE_ERROR,
  86     DBFStatus_OPEN_FILE_ERROR,
  87     DBFStatus_NO_SUCH_FIELD_ERROR,
  88     DBFStatus_NO_DBFVALUES_CORRESPONDENCE_WARNING
  89   };
  90
  91   HYDRODATA_EXPORT HYDROData_LandCoverMap();
  92   HYDRODATA_EXPORT virtual ~HYDROData_LandCoverMap();
  93
  94   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const;
  95
  96   HYDRODATA_EXPORT bool ImportSHP( const QString& theSHPFileName,
  97                                    const QList<int>& theIndices = QList<int>() );
  98
  99   HYDRODATA_EXPORT bool ExportSHP( const QString& theSHPFileName, bool bUseDiscr = false, double theDefl = 0.1) const;
 100
 101   HYDRODATA_EXPORT DBFStatus ImportDBF( const QString& theDBFFileName,
 102                                         const QString& theFieldName,
 103                                         const QStringList& DBFValues,
 104                                         const QStringList& StricklerTypes,
 105                                         const QList<int>& theIndices = QList<int>() );
 106
 107   HYDRODATA_EXPORT void ExportDBF( const QString& theDBFFileName,
 108                                    const QString& theFieldName,
 109                                    const QStringList& theDBFValues,
 110                                    const QStringList& theStricklerTypes ) const;
 111
 112   HYDRODATA_EXPORT bool ExportTelemac( const QString& theFileName,
 113                                        double theDeflection,
 114                                        const Handle_HYDROData_StricklerTable& theTable ) const;
 115
 116   HYDRODATA_EXPORT bool Add( const Handle( HYDROData_Object )&, const QString& theType );
 117   HYDRODATA_EXPORT bool Add( const Handle( HYDROData_PolylineXY )&, const QString& theType );
 118
 119   HYDRODATA_EXPORT bool Remove( const TopoDS_Face& );
 120   HYDRODATA_EXPORT bool Remove( const TopTools_ListOfShape& );
 121
 122   HYDRODATA_EXPORT bool Split( const Handle( HYDROData_PolylineXY )& );
 123   HYDRODATA_EXPORT bool Split( const TopoDS_Shape& );
 124   HYDRODATA_EXPORT bool Merge( const TopTools_ListOfShape&, const QString& theType );
 125
 126   HYDRODATA_EXPORT bool ChangeType( const TopTools_ListOfShape&, const QString& theType );
 127
 128   HYDRODATA_EXPORT TopoDS_Face FindByPoint( const gp_Pnt2d&, QString& theType ) const;
 129
 130   HYDRODATA_EXPORT TopoDS_Shape GetShape() const;
 131
 132   HYDRODATA_EXPORT QString StricklerType( const TopoDS_Face& ) const;
 133
 134   HYDRODATA_EXPORT virtual QStringList DumpToPython( const QString& thePyScriptPath,
 135                                                      MapOfTreatedObjects& theTreatedObjects ) const;
 136
 137   HYDRODATA_EXPORT int GetLCCount() const;
 138   HYDRODATA_EXPORT bool IsEmpty() const;
 139
 140   HYDRODATA_EXPORT void StoreLandCovers( const HYDROData_MapOfFaceToStricklerType& );
 141
 142   HYDRODATA_EXPORT virtual bool IsHas2dPrs() const;
 143
 144   HYDRODATA_EXPORT void SetTransparency( double );
 145   HYDRODATA_EXPORT double GetTransparency() const;
 146
 147   HYDRODATA_EXPORT void RemoveInternal(TopoDS_Shape& ShToRebuild, NCollection_IndexedDataMap<TopoDS_Face, TopoDS_Face>* aF2FReplace);
 148
 149   HYDRODATA_EXPORT bool CheckLinear();
 150
 151   HYDRODATA_EXPORT virtual void UpdateLocalCS( double theDx, double theDy );
 152
 153   HYDRODATA_EXPORT void ClassifyPoints( const std::vector<gp_Pnt2d>& thePoints, std::vector<std::set <QString> >& theTypes ) const;
 154
 155   HYDRODATA_EXPORT void ClassifyPoints( const std::vector<gp_Pnt2d>& thePoints,
 156     Handle(HYDROData_StricklerTable) theTable,
 157     std::vector<double>& theCoeffs, double DefValue, bool UseMax ) const;
 158
 159 protected:
 160   void SetShape( const TopoDS_Shape& );
 161
 162   bool Add( const TopoDS_Wire&, const QString& );
 163
 164   bool LocalPartition( const TopoDS_Shape&, const QString& theNewType );
 165
 166   static TopoDS_Shape MergeFaces(const TopTools_ListOfShape& theFaces,
 167                                  bool IsToUnify,
 168                                  TopTools_IndexedDataMapOfShapeListOfShape* theShHistory = NULL,
 169                                  double theTolerance = 1E-5 );
 170
 171 public:
 172   DEFINE_STANDARD_RTTI( HYDROData_LandCoverMap );
 173
 174 private:
 175   friend class Explorer;
 176   friend class test_HYDROData_LandCoverMap;
 177 };
 178
 179 #endif