pipelinefactory.h 4.82 KB
Newer Older
1
2
3
4
5
6
7
// ================================================================================================
// 
// This file is part of the CAMPVis Software Framework.
// 
// If not explicitly stated otherwise: Copyright (C) 2012, all rights reserved,
//      Christian Schulte zu Berge <christian.szb@in.tum.de>
//      Chair for Computer Aided Medical Procedures
8
9
//      Technische Universität München
//      Boltzmannstr. 3, 85748 Garching b. München, Germany
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
// For a full list of authors and contributors, please refer to the file "AUTHORS.txt".
// 
// The licensing of this softare is not yet resolved. Until then, redistribution in source or
// binary forms outside the CAMP chair is not permitted, unless explicitly stated in legal form.
// However, the names of the original authors and the above copyright notice must retain in its
// original state in any case.
// 
// Legal disclaimer provided by the BSD license:
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY 
// AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR 
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
// 
// ================================================================================================

#ifndef PIPELINEFACTORY_H__
#define PIPELINEFACTORY_H__

#include "tgt/logmanager.h"
#include "tgt/singleton.h"

#include <tbb/atomic.h>
37
#include <tbb/spin_mutex.h>
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

#include <map>
#include <string>
#include <vector>

namespace campvis {
    class AbstractPipeline;
    class DataContainer;

    /**
     * Factory for creating pipelines by their name.
     * Using some template-magic, PipelineFactory is able to register pipelines during static 
     * initialization in cooperation with the PipelineRegistrar.
     * 
     * \note    PipelineFactory is a thread-safe lazy-instantiated singleton.
     */
    class PipelineFactory {
    public:
        /**
         * Returns a reference to the PipelineFactory singleton.
         * Creates the singleton if necessary
         * \return  *_singleton
         */
61
        static PipelineFactory& getRef();
62
63
	
	static void deinit();
64

65
66
67
        std::vector<std::string> getRegisteredPipelines() const;

        AbstractPipeline* createPipeline(const std::string& id, DataContainer* dc) const;
68
69
70
71
72
73
74
75
76

        /**
         * Statically registers the pipeline of type T using \a callee as factory method.
         * \note    The template instantiation of PipelineRegistrar takes care of calling this method.
         * \param   callee  Factory method to call to create an instance of type T
         * \return  The registration index.
         */
        template<typename T>
        size_t registerPipeline(AbstractPipeline* (* callee)(DataContainer*)) {
77
78
79
80
81
82
83
84
85
86
            tbb::spin_mutex::scoped_lock lock(_mutex);

            std::map<std::string, AbstractPipeline* (*)(DataContainer*)>::iterator it = _pipelineMap.lower_bound(T::getId());
            if (it == _pipelineMap.end() || it->first != T::getId()) {
                _pipelineMap.insert(it, std::make_pair(T::getId(), callee));
            }
            else {
                tgtAssert(false, "Registered two pipelines with the same ID.");
            }
            
87
88
89
90
            return _pipelineMap.size();
        }

    private:
91
        mutable tbb::spin_mutex _mutex;
92
93
        static tbb::atomic<PipelineFactory*> _singleton;    ///< the singleton object

94
        std::map<std::string, AbstractPipeline* (*)(DataContainer*)> _pipelineMap;
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
    };


// ================================================================================================

    template<typename T>
    class PipelineRegistrar {
    public:
        /**
         * Static factory method for creating the pipeline of type T.
         * \param   dc  DataContainer for the created pipeline to work on.
         * \return  A newly created pipeline of type T. Caller has to take ownership of the pointer.
         */
        static AbstractPipeline* create(DataContainer* dc) {
            return new T(dc);
        }

    private:
        /// static helper field to ensure registration at static initialization time.
        static const size_t _factoryId;
    };

    template<typename T>
    const size_t PipelineRegistrar<T>::_factoryId = PipelineFactory::getRef().registerPipeline<T>(&PipelineRegistrar<T>::create);

}

#endif // PIPELINEFACTORY_H__