← Back to branch summary

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

« back to all changes in this revision

Viewing changes to include/OpenMS/CONCEPT/Factory.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/Factory.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
 
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.
22
29
//
23
30
// --------------------------------------------------------------------------
24
31
// $Maintainer: Chris Bielow $
42
49
  class String;
43
50
 
44
51
  /**
45
 
        @brief Returns FactoryProduct* based on the name of the desired concrete FactoryProduct
46
 
                
47
 
                Every factory product base class T has to implement the static function registerChildren that registers all classes S derived from T at Factory<T>.
48
 
 
49
 
                Every class S derived from T has to implement the function "static T* create()" which is going to be registered at Factory<T>.
50
 
                Additionally the function "static String getProductName()" is required, which returns the name the class is registered by.
51
 
                
52
 
                @ingroup Concept
 
52
    @brief Returns FactoryProduct* based on the name of the desired concrete FactoryProduct
 
53
 
 
54
        Every factory product base class T has to implement the static function registerChildren that registers all classes S derived from T at Factory<T>.
 
55
 
 
56
        Every class S derived from T has to implement the function "static T* create()" which is going to be registered at Factory<T>.
 
57
        Additionally the function "static String getProductName()" is required, which returns the name the class is registered by.
 
58
 
 
59
        @ingroup Concept
53
60
  */
54
61
  template <typename FactoryProduct>
55
 
  class Factory
56
 
        : public FactoryBase
 
62
  class Factory :
 
63
    public FactoryBase
57
64
  {
58
65
    friend class singletonsNeedNoFriends; //some versions of gcc would warn otherwise
59
66
 
60
 
  private:
61
 
    /// Function signature of creator function 
62
 
    typedef FactoryProduct* (*FunctionType)();
 
67
private:
 
68
    /// Function signature of creator function
 
69
    typedef FactoryProduct * (*FunctionType)();
63
70
    typedef std::map<String, FunctionType> Map;
64
71
    typedef typename Map::const_iterator MapIterator;
65
 
                typedef Factory<FactoryProduct> FactoryType;
66
 
                
67
 
    /// Destructor 
 
72
    typedef Factory<FactoryProduct> FactoryType;
 
73
 
 
74
    /// Destructor
68
75
    virtual ~Factory(){}
69
76
 
70
77
    /// Constructor
72
79
    {
73
80
    }
74
81
 
75
 
    /// singleton access to Factory 
76
 
    static Factory* instance_()
 
82
    /// singleton access to Factory
 
83
    static Factory * instance_()
77
84
    {
78
 
                        if (!instance_ptr_)
79
 
                        {
80
 
                                // name of this Factory
81
 
                                String myName = typeid(FactoryType).name();
82
 
                                
83
 
                                //check if an instance of this kind of Factory already registered
84
 
                                if (!SingletonRegistry::isRegistered(myName))
85
 
                                {
86
 
                                        // if not registered yet ... add it
87
 
                                        instance_ptr_ = new Factory();
88
 
                                        // now, attention as ORDER of commands is important here:
89
 
                                        // first register the Factory
90
 
                                        SingletonRegistry::registerFactory(myName, instance_ptr_);
91
 
                                        // because this call, might use another instance of this factory, but we want the other instance to register the children with "US"
92
 
                                        FactoryProduct::registerChildren();
93
 
                                }
94
 
                                else
95
 
                                {
96
 
                                        // get instance of this factory from registry
97
 
                                        instance_ptr_ = static_cast<FactoryType*> (SingletonRegistry::getFactory(myName));                      
98
 
                                }
99
 
                        }
 
85
      if (!instance_ptr_)
 
86
      {
 
87
        // name of this Factory
 
88
        String myName = typeid(FactoryType).name();
 
89
 
 
90
        //check if an instance of this kind of Factory already registered
 
91
        if (!SingletonRegistry::isRegistered(myName))
 
92
        {
 
93
          // if not registered yet ... add it
 
94
          instance_ptr_ = new Factory();
 
95
          // now, attention as ORDER of commands is important here:
 
96
          // first register the Factory
 
97
          SingletonRegistry::registerFactory(myName, instance_ptr_);
 
98
          // because this call, might use another instance of this factory, but we want the other instance to register the children with "US"
 
99
          FactoryProduct::registerChildren();
 
100
        }
 
101
        else
 
102
        {
 
103
          // get instance of this factory from registry
 
104
          instance_ptr_ = static_cast<FactoryType *>(SingletonRegistry::getFactory(myName));
 
105
        }
 
106
      }
100
107
      return instance_ptr_;
101
108
    }
102
109
 
103
 
  public:
104
 
                
105
 
    /// return FactoryProduct according to unique identifier @p name  
106
 
    static FactoryProduct* create(const String& name)
 
110
public:
 
111
 
 
112
    /// return FactoryProduct according to unique identifier @p name
 
113
    static FactoryProduct * create(const String & name)
107
114
    {
108
 
        MapIterator it = instance_()->inventory_.find(name);
 
115
      MapIterator it = instance_()->inventory_.find(name);
109
116
      if (it != instance_()->inventory_.end())
110
 
                        {
111
 
                                return (*(it->second))();
112
 
                        }
113
 
      else 
114
 
                        {
115
 
        throw Exception::InvalidValue(__FILE__, __LINE__, __PRETTY_FUNCTION__, "This FactoryProduct is not registered!",name.c_str());
116
 
                        }
 
117
      {
 
118
        return (*(it->second))();
 
119
      }
 
120
      else
 
121
      {
 
122
        throw Exception::InvalidValue(__FILE__, __LINE__, __PRETTY_FUNCTION__, "This FactoryProduct is not registered!", name.c_str());
 
123
      }
117
124
    }
118
 
    
 
125
 
119
126
    /**
120
 
        @brief register new concrete FactoryProduct 
121
 
     
 
127
        @brief register new concrete FactoryProduct
 
128
 
122
129
       @param name unique name for concrete FactoryProduct
123
 
       @param creator default constructor for concrete FactoryProduct 
 
130
       @param creator default constructor for concrete FactoryProduct
124
131
    */
125
 
    static void registerProduct(const String& name, const FunctionType creator)
 
132
    static void registerProduct(const String & name, const FunctionType creator)
126
133
    {
127
134
      instance_()->inventory_[name] = creator;
128
135
    }
129
 
                
130
 
                /// Returns if a factory product is registered
131
 
                static bool isRegistered(const String& name)
132
 
                {
 
136
 
 
137
    /// Returns if a factory product is registered
 
138
    static bool isRegistered(const String & name)
 
139
    {
133
140
      if (instance_()->inventory_.find(name) != instance_()->inventory_.end())
134
 
                        {
135
 
                                return true;
136
 
                        }
137
 
                        return false;
138
 
                }
139
 
 
140
 
                /// Returns a list of registered products
141
 
                static std::vector<String> registeredProducts()
142
 
                {
143
 
                        std::vector<String> list;
144
 
      for (MapIterator it = instance_()->inventory_.begin(); it!=instance_()->inventory_.end(); ++it)
145
 
      {
146
 
                                list.push_back(it->first);
147
 
                        }
148
 
                        return list;
149
 
                }
150
 
                
151
 
  private:
 
141
      {
 
142
        return true;
 
143
      }
 
144
      return false;
 
145
    }
 
146
 
 
147
    /// Returns a list of registered products
 
148
    static std::vector<String> registeredProducts()
 
149
    {
 
150
      std::vector<String> list;
 
151
      for (MapIterator it = instance_()->inventory_.begin(); it != instance_()->inventory_.end(); ++it)
 
152
      {
 
153
        list.push_back(it->first);
 
154
      }
 
155
      return list;
 
156
    }
 
157
 
 
158
private:
152
159
 
153
160
    Map inventory_;
154
 
    static Factory* instance_ptr_;
 
161
    static Factory * instance_ptr_;
155
162
  };
156
 
  
157
 
  template<typename FactoryProduct> Factory<FactoryProduct>* Factory<FactoryProduct>::instance_ptr_ = 0;
158
 
    
 
163
 
 
164
  template <typename FactoryProduct>
 
165
  Factory<FactoryProduct> * Factory<FactoryProduct>::instance_ptr_ = 0;
 
166
 
159
167
}
160
168
#endif //OPENMS_CONCEPT_FACTORY_H