NEST main@caf0ae8
 
Loading...
Searching...
No Matches
manager_interface.h
Go to the documentation of this file.
1/*
2 * manager_interface.h
3 *
4 * This file is part of NEST.
5 *
6 * Copyright (C) 2004 The NEST Initiative
7 *
8 * NEST is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * NEST is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with NEST. If not, see <http://www.gnu.org/licenses/>.
20 *
21 */
22
23#ifndef MANAGER_INTERFACE_H
24#define MANAGER_INTERFACE_H
25
26// Includes from nestkernel:
27#include "nest_types.h"
28
29// Includes from libnestutil:
30#include "dictionary.h"
31
32namespace nest
33{
34
46{
47public:
48 ManagerInterface( ManagerInterface const& ) = delete; // do not implement
49 void operator=( ManagerInterface const& ) = delete; // do not implement
50
51public:
53 {
54 }
55
57 {
58 }
59
77 virtual void initialize( const bool adjust_number_of_threads_or_rng_only ) = 0;
78
97 virtual void finalize( const bool adjust_number_of_threads_or_rng_only ) = 0;
98
104 virtual void set_status( const Dictionary& ) = 0;
105
118 virtual void get_status( Dictionary& ) = 0;
119
120 virtual void prepare() {};
121 virtual void cleanup() {};
122};
123}
124
125#endif /* MANAGER_INTERFACE_H */
Dictionary class for interface to Python and C++ API.
Definition dictionary.h:213
Interface for kernel manager classes.
Definition manager_interface.h:46
virtual void set_status(const Dictionary &)=0
Set the status of the manager.
virtual void initialize(const bool adjust_number_of_threads_or_rng_only)=0
Prepare manager for operation.
virtual void prepare()
Definition manager_interface.h:120
virtual void finalize(const bool adjust_number_of_threads_or_rng_only)=0
Take down manager after operation.
virtual void cleanup()
Definition manager_interface.h:121
void operator=(ManagerInterface const &)=delete
virtual void get_status(Dictionary &)=0
Retrieve the status of the manager.
virtual ~ManagerInterface()
Definition manager_interface.h:56
ManagerInterface(ManagerInterface const &)=delete
ManagerInterface()
Definition manager_interface.h:52
Namespace for the NEST simulation kernel.
Definition beta_normalization_factor.h:33