Computer Assited Medical Intervention Tool Kit  version 4.0
MMLMonitorDisplayFactory.h
Go to the documentation of this file.
1 /*****************************************************************************
2  * $CAMITK_LICENCE_BEGIN$
3  *
4  * CamiTK - Computer Assisted Medical Intervention ToolKit
5  * (c) 2001-2016 Univ. Grenoble Alpes, CNRS, TIMC-IMAG UMR 5525 (GMCAO)
6  *
7  * Visit http://camitk.imag.fr for more information
8  *
9  * This file is part of CamiTK.
10  *
11  * CamiTK is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * CamiTK is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU Lesser General Public License version 3 for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public License
21  * version 3 along with CamiTK. If not, see <http://www.gnu.org/licenses/>.
22  *
23  * $CAMITK_LICENCE_END$
24  ****************************************************************************/
25 
26 #ifndef MMLMonitorDisplayFactory_H
27 #define MMLMonitorDisplayFactory_H
28 
29 #include <map>
30 #include <vector>
31 #include <string>
32 
33 // Monitor includes
34 #include "Monitor.h"
35 #include "MMLComponentAPI.h"
36 
37 class MMLMonitorDisplay;
38 class MMLComponent;
48 
49 public:
50 
52  static MMLMonitorDisplayFactory* getInstance();
53 
63  template<typename C>
64  bool registerClass(std::string id, Monitor::type type) {
65  if (mapObjectCreator.find(id) != mapObjectCreator.end()) {
66  return false;
67  } else {
68  mapObjectCreator.insert( std::pair<std::string,CreateMonitorDisplayFunctionPointer>(id, &createTheMonitorDisplay<C> ) );
69  displaysByType[type].push_back(id);
70  return true;
71  }
72  }
73 
81  template<typename C>
82  bool registerClass(std::string id) {
83  if (mapObjectCreator.find(id) != mapObjectCreator.end()) {
84  return false;
85  } else {
86  mapObjectCreator.insert( std::pair<std::string,CreateMonitorDisplayFunctionPointer>(id, &createTheMonitorDisplay<C> ) );
87  for (unsigned int i=0; i<Monitor::typeCount; i++) {
88  displaysByType[i].push_back(id);
89  }
90 
91  return true;
92  }
93  }
94 
96  bool isRegistered(std::string id);
97 
99  MMLMonitorDisplay* createMonitorDisplay(std::string id,Monitor* monitor,MMLComponent* manager);
100 
102  unsigned int getNumberOfDisplaysByType(Monitor::type type);
103 
105  std::string getDisplayByType(Monitor::type type,const unsigned int i);
106 
107 private:
108 
110 
111  typedef MMLMonitorDisplay* (*CreateMonitorDisplayFunctionPointer)(Monitor* monitor,MMLComponent* manager);
112 
114  std::map<std::string, CreateMonitorDisplayFunctionPointer> mapObjectCreator;
115 
120  template<typename C>
122  return new C(monitor,manager);
123  }
124 
126  std::vector<std::string> displaysByType[Monitor::typeCount];
127 
130 };
131 
132 
133 #endif // MMLMonitorDisplayFactory_H
A Factory for creating MMLMonitorDiplay.
Definition: MMLMonitorDisplayFactory.h:47
static MMLMonitorDisplay * createTheMonitorDisplay(Monitor *monitor, MMLComponent *manager)
function whose pointers are inserted into the map.
Definition: MMLMonitorDisplayFactory.h:121
type
type of the values stored (please update typeCount and doc if you update the enum) SCALAR: the monito...
Definition: Monitor.h:60
#define MMLCOMPONENT_API
Definition: MMLComponentAPI.h:54
Generic class for MML Monitor 3D/Graphical representation.
Definition: MMLMonitorDisplay.h:45
This class manage an MML monitoring document ".mml".
Definition: MMLComponent.h:48
std::map< std::string, CreateMonitorDisplayFunctionPointer > mapObjectCreator
A map between MonitorDisplay name as string to functions (CreateMonitorDisplayFunctionPointer) ...
Definition: MMLMonitorDisplayFactory.h:114
static MMLMonitorDisplayFactory * instance
unique instance of the factory
Definition: MMLMonitorDisplayFactory.h:129
bool registerClass(std::string id)
Register a class into the map for classes wich can display every types of monitors.
Definition: MMLMonitorDisplayFactory.h:82
A monitor calculate and store followed data (ex:calculation between current position and references) ...
Definition: Monitor.h:49
bool registerClass(std::string id, Monitor::type type)
Register a class into the map A registered class can be created using createMonitorDisplay().
Definition: MMLMonitorDisplayFactory.h:64
static const unsigned int typeCount
number of possible types (siez of the previous enum). Please always update if the enum is updated...
Definition: Monitor.h:67