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