ESPResSo
Extensible Simulation Package for Research on Soft Matter Systems
Loading...
Searching...
No Matches
script_interface/system/System.hpp
Go to the documentation of this file.
1/*
2 * Copyright (C) 2013-2022 The ESPResSo project
3 *
4 * This file is part of ESPResSo.
5 *
6 * ESPResSo is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 *
11 * ESPResSo 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 General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19
20#pragma once
21
23
26
27#include <memory>
28#include <string>
29
30namespace ScriptInterface {
31namespace System {
32
33/**
34 * @brief Script interface wrapper for the system class.
35 *
36 * See @ref SystemClassDesign for more details.
37 */
38class System : public AutoParameters<System> {
39 struct Leaves;
40 std::shared_ptr<::System::System> m_instance;
41 std::shared_ptr<Leaves> m_leaves;
42
43public:
44 System();
45
46 void do_construct(VariantMap const &params) override;
47 Variant do_call_method(std::string const &name,
48 VariantMap const &parameters) override;
49
50 auto const &get_system() const { return *m_instance; }
51
52private:
53 template <typename LeafType>
54 void do_set_default_parameter(std::string const &name);
55 std::string get_internal_state() const override;
56 void set_internal_state(std::string const &state) override;
57};
58
59} // namespace System
60} // namespace ScriptInterface
Bind parameters in the script interface.
boost::string_ref name() const
void do_construct(VariantMap const &params) override
void set_internal_state(std::string const &state) override
Variant do_call_method(std::string const &name, VariantMap const &parameters) override
std::string get_internal_state() const override
Serialize particles.
T get_value(Variant const &v)
Extract value of specific type T from a Variant.
std::unordered_map< std::string, Variant > VariantMap
Definition Variant.hpp:69
boost::make_recursive_variant< None, bool, int, std::size_t, double, std::string, ObjectRef, Utils::Vector3b, Utils::Vector3i, Utils::Vector2d, Utils::Vector3d, Utils::Vector4d, std::vector< int >, std::vector< double >, std::vector< boost::recursive_variant_ >, std::unordered_map< int, boost::recursive_variant_ >, std::unordered_map< std::string, boost::recursive_variant_ > >::type Variant
Possible types for parameters.
Definition Variant.hpp:67
static SteepestDescentParameters params
Currently active steepest descent instance.
Container for leaves of the system class.