src/HYDROData/HYDROData_StricklerTable.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_STRICKLERTABLE_HeaderFile
  20 #define HYDROData_STRICKLERTABLE_HeaderFile
  21
  22 #include <HYDROData_Entity.h>
  23
  24 #include <TColStd_SequenceOfExtendedString.hxx>
  25
  26 class Handle( TDataStd_NamedData );
  27
  28 DEFINE_STANDARD_HANDLE( HYDROData_StricklerTable, HYDROData_Entity )
  29
  30 class HYDROData_StricklerTable : public HYDROData_Entity
  31 {
  32 protected:
  33   friend class HYDROData_Iterator;
  34
  35   enum DataTag
  36   {
  37     DataTag_Table = HYDROData_Entity::DataTag_First + 100, ///< first tag, to reserve
  38   };
  39
  40   HYDRODATA_EXPORT HYDROData_StricklerTable();
  41   HYDRODATA_EXPORT ~HYDROData_StricklerTable();
  42
  43 public:
  44   DEFINE_STANDARD_RTTI( HYDROData_StricklerTable );
  45
  46   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const;
  47
  48   HYDRODATA_EXPORT bool Import( const TCollection_AsciiString& theFileName );
  49   HYDRODATA_EXPORT bool Export( const TCollection_AsciiString& theFileName );
  50
  51   HYDRODATA_EXPORT double Get( const TCollection_ExtendedString& theType, double theDefault ) const;
  52   HYDRODATA_EXPORT void Set( const TCollection_ExtendedString& theType, double theCoefficient );
  53
  54   HYDRODATA_EXPORT void GetCoefficientRange( double& theMin, double& theMax ) const;
  55
  56   HYDRODATA_EXPORT TColStd_SequenceOfExtendedString GetTypes() const;
  57
  58   HYDRODATA_EXPORT bool HasType( const TCollection_ExtendedString& theType ) const;
  59
  60   HYDRODATA_EXPORT void Clear();
  61
  62   HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
  63
  64 private:
  65   Handle(TDataStd_NamedData) Map() const;
  66 };
  67
  68 #endif