World Builder  1.1.0-pre
A geodynamic initial conditions generator
plugin_system.h
Go to the documentation of this file.
1 /*
2  Copyright (C) 2018-2024 by the authors of the World Builder code.
3 
4  This file is part of the World Builder.
5 
6  This program is free software: you can redistribute it and/or modify
7  it under the terms of the GNU Lesser General Public License as published
8  by the Free Software Foundation, either version 2 of the License, or
9  (at your option) any later version.
10 
11  This program is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU Lesser General Public License for more details.
15 
16  You should have received a copy of the GNU Lesser General Public License
17  along with this program. If not, see <https://www.gnu.org/licenses/>.
18 */
19 
20 #ifndef WORLD_BUILDER_TYPES_PLUGIN_SYSTEM_H
21 #define WORLD_BUILDER_TYPES_PLUGIN_SYSTEM_H
22 
23 
25 
26 
27 namespace WorldBuilder
28 {
29  class Parameters;
30 
31  namespace Types
32  {
33 
38  class PluginSystem final: public Interface
39  {
40  public:
44  PluginSystem(std::string default_value_,
45  void ( *declare_entries)(Parameters &, const std::string &, const std::vector<std::string> &),
46  std::vector<std::string> required_entries,
47  const bool allow_multiple = true);
48 
49 
53  PluginSystem(PluginSystem const &plugin_system);
54 
58  ~PluginSystem() override final;
59 
63  void write_schema(Parameters &prm,
64  const std::string &name,
65  const std::string &documentation) const override final;
66 
67 
68  std::string default_value;
69  void( *declare_entries)(Parameters &, const std::string &, const std::vector<std::string> &);
70  std::vector<std::string> required_entries;
72 
73  protected:
74  PluginSystem *clone_impl() const override final
75  {
76  return new PluginSystem(*this);
77  };
78 
79  private:
80 
81  };
82  } // namespace Types
83 } // namespace WorldBuilder
84 
85 #endif
std::vector< std::string > required_entries
Definition: plugin_system.h:70
void write_schema(Parameters &prm, const std::string &name, const std::string &documentation) const override final
PluginSystem * clone_impl() const override final
Definition: plugin_system.h:74
PluginSystem(std::string default_value_, void(*declare_entries)(Parameters &, const std::string &, const std::vector< std::string > &), std::vector< std::string > required_entries, const bool allow_multiple=true)
void(* declare_entries)(Parameters &, const std::string &, const std::vector< std::string > &)
Definition: plugin_system.h:69