src/HYDROData/HYDROData_InterpolatorsFactory.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_InterpolatorsFactory_HeaderFile
  24 #define HYDROData_InterpolatorsFactory_HeaderFile
  25
  26 #include <HYDROData.h>
  27
  28 #include <TCollection_AsciiString.hxx>
  29 #include <NCollection_Sequence.hxx>
  30
  31 #include <string>
  32 #include <map>
  33
  34 class HYDROData_IProfilesInterpolator;
  35
  36 /**
  37  * \class HYDROData_InterpolatorsFactory
  38  *
  39  * \brief Profile interpolators factory.
  40  *
  41  * Allows to register different types of interpolatotors (these interpolators should inherit HYDROData_IProfilesInterpolator).
  42  * Once the interpolator of a certain type is registered it should be got by its name.
  43  */
  44
  45 class HYDROData_InterpolatorsFactory
  46 {
  47 public:
  48
  49   /**
  50    * Public constructor.
  51    */
  52   HYDROData_InterpolatorsFactory();
  53
  54   /**
  55    * Public virtual destructor.
  56    */
  57   virtual ~HYDROData_InterpolatorsFactory();
  58
  59   /**
  60    * Registers the interpolator of a certain type with the given name.
  61    * \param theName the interpolator name used as identifier
  62    */
  63   template <class T> /*HYDRODATA_EXPORT */void Register( const TCollection_AsciiString& theName )
  64   {
  65     myInterpolators[theName.ToCString()] = new T();
  66   }
  67
  68   /**
  69    * Get the appropriate interpolator by the name.
  70    * \param theName name of the interpolator
  71    * \returns the appropriate interpolator or NULL if interpolator with such name is not registered
  72    */
  73   HYDRODATA_EXPORT HYDROData_IProfilesInterpolator* GetInterpolator( const TCollection_AsciiString& theName ) const;
  74
  75   /**
  76    * Get list of registered interpolator names.
  77    * \return the list of unique names
  78    */
  79   HYDRODATA_EXPORT NCollection_Sequence<TCollection_AsciiString> GetInterpolatorNames() const;
  80
  81 private:
  82   //! Map that stores all interpolators, identified by interpolator name (string)
  83   typedef std::map<std::string, HYDROData_IProfilesInterpolator*> FactoryInterpolators;
  84
  85   FactoryInterpolators myInterpolators; ///< all interpolators stored by factory
  86 };
  87
  88 #endif