File: MMLMonitorDisplayFactory.h

package info (click to toggle)
camitk 6.0.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 389,496 kB
  • sloc: cpp: 103,476; sh: 2,448; python: 1,618; xml: 984; makefile: 128; perl: 84; sed: 20
file content (135 lines) | stat: -rw-r--r-- 4,464 bytes parent folder | download
1
2
3
4
5
6
7
8
9
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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
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
123
124
125
126
127
128
129
130
131
132
133
134
135
/*****************************************************************************
 * $CAMITK_LICENCE_BEGIN$
 *
 * CamiTK - Computer Assisted Medical Intervention ToolKit
 * (c) 2001-2025 Univ. Grenoble Alpes, CNRS, Grenoble INP - UGA, TIMC, 38000 Grenoble, France
 *
 * Visit http://camitk.imag.fr for more information
 *
 * This file is part of CamiTK.
 *
 * CamiTK is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * CamiTK is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with CamiTK.  If not, see <http://www.gnu.org/licenses/>.
 *
 * $CAMITK_LICENCE_END$
 ****************************************************************************/

#ifndef MMLMonitorDisplayFactory_H
#define MMLMonitorDisplayFactory_H

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

// Monitor includes
#include "Monitor.h"
#include "MMLComponentAPI.h"

class MMLMonitorDisplay;
class MMLComponent;
/**
 * @ingroup group_cepmodeling_components_mml
 *
 * @brief
 * A Factory for creating MMLMonitorDiplay
 *
 *
 **/
class MMLCOMPONENT_API MMLMonitorDisplayFactory {

public:

    /// return the unique instance of the factory
    static MMLMonitorDisplayFactory* getInstance();

    /**
    * Register a class into the map
    * A registered class can be created using createMonitorDisplay().
    *
    * C is a subclass of MMLMonitorDisplay.
    *
    * @param id unique id to associate with the Class C
    * @param type the type of monitor the class can display
    */
    template<typename C>
    bool registerClass(std::string id, Monitor::type type) {
        if (mapObjectCreator.find(id) != mapObjectCreator.end()) {
            return false;
        }
        else {
            mapObjectCreator.insert(std::pair<std::string, CreateMonitorDisplayFunctionPointer>(id, &createTheMonitorDisplay<C>));
            displaysByType[type].push_back(id);
            return true;
        }
    }

    /**
    * Register a class into the map for classes wich can display every types of monitors.
    *
    * C is a subclass of MMLMonitorDisplay.
    *
    * @param id unique id to associate with the Class C
    */
    template<typename C>
    bool registerClass(std::string id) {
        if (mapObjectCreator.find(id) != mapObjectCreator.end()) {
            return false;
        }
        else {
            mapObjectCreator.insert(std::pair<std::string, CreateMonitorDisplayFunctionPointer>(id, &createTheMonitorDisplay<C>));
            for (unsigned int i = 0; i < Monitor::typeCount; i++) {
                displaysByType[i].push_back(id);
            }

            return true;
        }
    }

    /// Returns true if id is in the map
    bool isRegistered(std::string id);

    ///Creates an MMLMonitorDisplay based on its string id or return null if there is no id in the map
    MMLMonitorDisplay* createMonitorDisplay(std::string id, Monitor* monitor, MMLComponent* manager);

    /// give the number of displays registered for a specified type
    unsigned int getNumberOfDisplaysByType(Monitor::type type);

    /// get a display name by its type and index
    std::string getDisplayByType(Monitor::type type, const unsigned int i);

private:

    MMLMonitorDisplayFactory() = default;

    using CreateMonitorDisplayFunctionPointer = MMLMonitorDisplay * (*)(Monitor* monitor, MMLComponent* manager);

    /// A map  between MonitorDisplay name as string to functions (CreateMonitorDisplayFunctionPointer)
    std::map<std::string, CreateMonitorDisplayFunctionPointer> mapObjectCreator;

    /**
    * function whose pointers are inserted into the map. C is the type of MMLMonitorDisplay
    * @return an MonitorDisplay which type is C
    */
    template<typename C>
    static MMLMonitorDisplay* createTheMonitorDisplay(Monitor* monitor, MMLComponent* manager) {
        return new C(monitor, manager);
    }

    /// list of displays by type
    std::vector<std::string> displaysByType[Monitor::typeCount];

    /// unique instance of the factory
    static MMLMonitorDisplayFactory* instance;
};


#endif // MMLMonitorDisplayFactory_H