-
Notifications
You must be signed in to change notification settings - Fork 28
/
interface.h
164 lines (133 loc) · 5.25 KB
/
interface.h
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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
/*
Copyright (C) 2018-2024 by the authors of the World Builder code.
This file is part of the World Builder.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.
This program 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 for more details.
You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
#ifndef WORLD_BUILDER_FEATURES_CONTINENTAL_PLATE_MODELS_COMPOSITION_INTERFACE_H
#define WORLD_BUILDER_FEATURES_CONTINENTAL_PLATE_MODELS_COMPOSITION_INTERFACE_H
#include "world_builder/parameters.h"
#include "world_builder/objects/natural_coordinate.h"
namespace WorldBuilder
{
/**
* This class is an interface for the specific plate tectonic feature classes,
* such as continental plate, oceanic plate and subduction zone.
*/
namespace Features
{
namespace ContinentalPlateModels
{
namespace Composition
{
class ObjectFactory;
class Interface
{
public:
/**
* constructor
*/
Interface();
/**
* Destructor
*/
virtual
~Interface();
/**
* declare and read in the world builder file into the parameters class
*/
static
void declare_entries(Parameters &prm,
const std::string &parent_name,
const std::vector<std::string> &required_entries);
/**
* declare and read in the world builder file into the parameters class
*/
virtual
void parse_entries(Parameters &prm, const std::vector<Point<2>> &coordinates) = 0;
/**
* takes composition and position and returns a composition.
*/
virtual
double get_composition(const Point<3> &position,
const Objects::NaturalCoordinate &position_in_natural_coordinates,
const double depth,
const unsigned int composition_number,
double composition,
const double feature_min_depth,
const double feature_max_depth) const = 0;
/**
* A function to register a new type. This is part of the automatic
* registration of the object factory.
*/
static void registerType(const std::string &name,
void ( * /*declare_entries*/)(Parameters &, const std::string &),
ObjectFactory *factory);
/**
* A function to create a new type. This is part of the automatic
* registration of the object factory.
*/
static std::unique_ptr<Interface> create(const std::string &name, WorldBuilder::World *world);
/**
* Returns the name of the plugin
*/
std::string get_name() const
{
return name;
};
protected:
/**
* A pointer to the world class to retrieve variables.
*/
WorldBuilder::World *world;
std::string name;
private:
static std::map<std::string, ObjectFactory *> &get_factory_map()
{
static std::map<std::string, ObjectFactory *> factories;
return factories;
}
static std::map<std::string, void ( *)(Parameters &,const std::string &)> &get_declare_map()
{
static std::map<std::string, void ( *)(Parameters &,const std::string &)> declares;
return declares;
}
};
/**
* A class to create new objects
*/
class ObjectFactory
{
public:
virtual std::unique_ptr<Interface> create(World *world) = 0;
};
/**
* A macro which should be in every derived cpp file to automatically
* register it. Because this is a library, we need some extra measures
* to ensure that the static variable is actually initialized.
*/
#define WB_REGISTER_FEATURE_CONTINENTAL_PLATE_COMPOSITION_MODEL(klass,name) \
class klass##Factory : public ObjectFactory { \
public: \
klass##Factory() \
{ \
Interface::registerType(#name, klass::declare_entries, this); \
} \
std::unique_ptr<Interface> create(World *world) override final { \
return std::unique_ptr<Interface>(new klass(world)); \
} \
}; \
static klass##Factory global_##klass##Factory;
} // namespace Composition
} // namespace ContinentalPlateModels
} // namespace Features
} // namespace WorldBuilder
#endif