← Back to branch summary

~ubuntu-branches/ubuntu/wily/openms/wily

« back to all changes in this revision

Viewing changes to include/OpenMS/CONCEPT/SingletonRegistry.h

  • Committer: Package Import Robot
  • Author(s): Filippo Rusconi
  • Date: 2013-12-20 11:30:16 UTC
  • mfrom: (5.1.2 sid)
  • Revision ID: package-import@ubuntu.com-20131220113016-wre5g9bteeheq6he
Tags: 1.11.1-3
* remove version number from libbost development package names;
* ensure that AUTHORS is correctly shipped in all packages.

Show diffs side-by-side

added added

removed removed

Lines of Context:
include/OpenMS/CONCEPT/SingletonRegistry.h
1
 
        // -*- mode: C++; tab-width: 2; -*-
2
 
// vi: set ts=2:
3
 
//
4
 
// --------------------------------------------------------------------------
5
 
//                   OpenMS Mass Spectrometry Framework
6
 
// --------------------------------------------------------------------------
7
 
//  Copyright (C) 2003-2011 -- Oliver Kohlbacher, Knut Reinert
8
 
//
9
 
//  This library is free software; you can redistribute it and/or
10
 
//  modify it under the terms of the GNU Lesser General Public
11
 
//  License as published by the Free Software Foundation; either
12
 
//  version 2.1 of the License, or (at your option) any later version.
13
 
//
14
 
//  This library is distributed in the hope that it will be useful,
15
 
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
16
 
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17
 
//  Lesser General Public License for more details.
18
 
//
19
 
//  You should have received a copy of the GNU Lesser General Public
20
 
//  License along with this library; if not, write to the Free Software
21
 
//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
22
 
//
23
 
// --------------------------------------------------------------------------
24
 
// $Maintainer: Clemens Groepl, Chris Bielow  $
 
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-2013.
 
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  $
25
32
// $Authors: $
26
33
// --------------------------------------------------------------------------
27
34
 
37
44
namespace OpenMS
38
45
{
39
46
  class String;
40
 
        class FactoryBase;
 
47
  class FactoryBase;
41
48
 
42
49
  /**
43
 
        @brief Holds pointers to unique instance of a singleton factory.
44
 
                
45
 
                @note: NEVER(!) include this file anywhere (except for the SingletonRegistry.C)! :D
46
 
                
47
 
                @ingroup Concept
 
50
    @brief Holds pointers to unique instance of a singleton factory.
 
51
 
 
52
        @note: NEVER(!) include this file anywhere (except for the SingletonRegistry.C)! :D
 
53
 
 
54
        @ingroup Concept
48
55
  */
49
56
  class OPENMS_DLLAPI SingletonRegistry
50
57
  {
51
58
    friend class singletonsNeedNoFriends; //some versions of gcc would warn otherwise
52
59
 
53
 
  private:
54
 
    /// Function signature of creator function 
55
 
    typedef std::map<String, FactoryBase*> Map;
 
60
private:
 
61
    /// Function signature of creator function
 
62
    typedef std::map<String, FactoryBase *> Map;
56
63
    typedef Map::const_iterator MapIterator;
57
64
 
58
 
    /// destructor 
 
65
    /// destructor
59
66
    virtual ~SingletonRegistry(){}
60
67
 
61
68
    /// C'Tor
62
69
    SingletonRegistry(){}
63
70
 
64
 
    /// singleton access to SingletonRegistry 
65
 
    static SingletonRegistry* instance_()
 
71
    /// singleton access to SingletonRegistry
 
72
    static SingletonRegistry * instance_()
66
73
    {
67
74
      if (!singletonRegistryInstance_)
68
 
                        {
69
 
                                singletonRegistryInstance_ = new SingletonRegistry();
 
75
      {
 
76
        singletonRegistryInstance_ = new SingletonRegistry();
70
77
      }
71
78
      return singletonRegistryInstance_;
72
79
    }
73
80
 
74
 
  public:
75
 
    
76
 
                /// return DefaultParamHandler according to unique identifier @p name  
77
 
    static FactoryBase* getFactory(const String& name)
 
81
public:
 
82
 
 
83
    /// return DefaultParamHandler according to unique identifier @p name
 
84
    static FactoryBase * getFactory(const String & name)
78
85
    {
79
 
        MapIterator it = instance_()->inventory_.find(name);
 
86
      MapIterator it = instance_()->inventory_.find(name);
80
87
      if (it != instance_()->inventory_.end())
81
 
                        {
82
 
                                return it->second;
83
 
                        }
84
 
      else 
85
 
                        {
86
 
        throw Exception::InvalidValue(__FILE__, __LINE__, __PRETTY_FUNCTION__, "This Factory is not registered with SingletonRegistry!",name.c_str());
87
 
                        }
 
88
      {
 
89
        return it->second;
 
90
      }
 
91
      else
 
92
      {
 
93
        throw Exception::InvalidValue(__FILE__, __LINE__, __PRETTY_FUNCTION__, "This Factory is not registered with SingletonRegistry!", name.c_str());
 
94
      }
88
95
    }
89
 
    
 
96
 
90
97
    /**
91
 
        @brief register new concrete Factory 
92
 
     
 
98
        @brief register new concrete Factory
 
99
 
93
100
       \param name unique name for Factory of certain type
94
101
       \param instance pointer to this Factory
95
102
    */
96
 
    static void registerFactory(const String& name, FactoryBase* instance)
 
103
    static void registerFactory(const String & name, FactoryBase * instance)
97
104
    {
98
105
      instance_()->inventory_[name] = instance;
99
106
    }
100
 
                
101
 
                /// Returns if a factory is registered
102
 
                static bool isRegistered(String name)
103
 
                {
 
107
 
 
108
    /// Returns if a factory is registered
 
109
    static bool isRegistered(String name)
 
110
    {
104
111
      if (instance_()->inventory_.find(name) != instance_()->inventory_.end())
105
 
                        {
106
 
                                return true;
107
 
                        }
108
 
                        return false;
109
 
                }
110
 
                
111
 
  private:
 
112
      {
 
113
        return true;
 
114
      }
 
115
      return false;
 
116
    }
 
117
 
 
118
private:
112
119
 
113
120
    Map inventory_;
114
 
    static SingletonRegistry* singletonRegistryInstance_;
 
121
    static SingletonRegistry * singletonRegistryInstance_;
115
122
  };
116
 
  
117
 
  
 
123
 
 
124
 
118
125
}
119
126
#endif //OPENMS_CONCEPT_SINGLETONREGISTRY_H