OpenMS  3.0.0
SingletonRegistry.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2022.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Chris Bielow $
32 // $Authors: $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
39 
40 #include <map>
41 
42 namespace OpenMS
43 {
44  class String;
45  class FactoryBase;
46 
54  class OPENMS_DLLAPI SingletonRegistry
55  {
56  friend class singletonsNeedNoFriends; //some versions of gcc would warn otherwise
57 
58 private:
60  typedef std::map<String, FactoryBase *> Map;
61  typedef Map::const_iterator MapIterator;
62 
64  virtual ~SingletonRegistry(){}
65 
68 
71  {
72  if (!singletonRegistryInstance_)
73  {
74  singletonRegistryInstance_ = new SingletonRegistry();
75  }
76  return singletonRegistryInstance_;
77  }
78 
79 public:
80 
82  static FactoryBase * getFactory(const String & name)
83  {
84  MapIterator it = instance_()->inventory_.find(name);
85  if (it != instance_()->inventory_.end())
86  {
87  return it->second;
88  }
89  else
90  {
91  throw Exception::InvalidValue(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, "This Factory is not registered with SingletonRegistry!", name.c_str());
92  }
93  }
94 
101  static void registerFactory(const String & name, FactoryBase * instance)
102  {
103  instance_()->inventory_[name] = instance;
104  }
105 
107  static bool isRegistered(String name)
108  {
109  if (instance_()->inventory_.find(name) != instance_()->inventory_.end())
110  {
111  return true;
112  }
113  return false;
114  }
115 
116 private:
117 
120  };
121 
122 
123 }
OpenMS::SingletonRegistry::inventory_
Map inventory_
Definition: SingletonRegistry.h:118
OpenMS::SingletonRegistry::instance_
static SingletonRegistry * instance_()
singleton access to SingletonRegistry
Definition: SingletonRegistry.h:70
OpenMS::Exception::InvalidValue
Invalid value exception.
Definition: Exception.h:327
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::SingletonRegistry::MapIterator
Map::const_iterator MapIterator
Definition: SingletonRegistry.h:61
OpenMS::SingletonRegistry::registerFactory
static void registerFactory(const String &name, FactoryBase *instance)
register new concrete Factory
Definition: SingletonRegistry.h:101
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
Exception.h
OpenMS::SingletonRegistry
Holds pointers to unique instance of a singleton factory.
Definition: SingletonRegistry.h:54
OpenMS::SingletonRegistry::~SingletonRegistry
virtual ~SingletonRegistry()
destructor
Definition: SingletonRegistry.h:64
OpenMS::SingletonRegistry::isRegistered
static bool isRegistered(String name)
Returns if a factory is registered.
Definition: SingletonRegistry.h:107
OpenMS::SingletonRegistry::SingletonRegistry
SingletonRegistry()
C'Tor.
Definition: SingletonRegistry.h:67
String.h
OpenMS::SingletonRegistry::getFactory
static FactoryBase * getFactory(const String &name)
return DefaultParamHandler according to unique identifier name
Definition: SingletonRegistry.h:82
OpenMS::SingletonRegistry::singletonRegistryInstance_
static SingletonRegistry * singletonRegistryInstance_
Definition: SingletonRegistry.h:119
OpenMS::FactoryBase
Base class for Factory<T>
Definition: FactoryBase.h:48
OpenMS::SingletonRegistry::Map
std::map< String, FactoryBase * > Map
Function signature of creator function.
Definition: SingletonRegistry.h:60