NEST main@caf0ae8
 
Loading...
Searching...
No Matches
nest::ModuleManager Class Reference

#include <module_manager.h>

Inheritance diagram for nest::ModuleManager:
[legend]
Collaboration diagram for nest::ModuleManager:
[legend]

Public Member Functions

 ModuleManager ()
 
 ~ModuleManager () override
 
void initialize (const bool) override
 Prepare manager for operation.
 
void finalize (const bool) override
 Take down manager after operation.
 
void reinitialize_dynamic_modules ()
 
void get_status (Dictionary &) override
 Retrieve the status of the manager.
 
void set_status (const Dictionary &) override
 Set the status of the manager.
 
void install (const std::string &)
 
- Public Member Functions inherited from nest::ManagerInterface
 ManagerInterface (ManagerInterface const &)=delete
 
void operator= (ManagerInterface const &)=delete
 
 ManagerInterface ()
 
virtual ~ManagerInterface ()
 
virtual void prepare ()
 
virtual void cleanup ()
 

Constructor & Destructor Documentation

◆ ModuleManager()

nest::ModuleManager::ModuleManager ( )
inline

◆ ~ModuleManager()

nest::ModuleManager::~ModuleManager ( )
inlineoverride

Member Function Documentation

◆ finalize()

void nest::ModuleManager::finalize ( const bool  adjust_number_of_threads_or_rng_only)
inlineoverridevirtual

Take down manager after operation.

After this method has completed, all dynamic data structures created by the manager shall be deallocated and containers emptied. Plain variables need not be reset.

Note
Finalization of any given manager may depend on other managers not having been finalized yet. KernelManager::finalize() is responsible for calling the initialization routines on the specific managers in correct order, i.e., the opposite order of initialize() calls.
Parameters
adjust_number_of_threads_or_rng_onlyPass true if calling from kernel_manager::change_number_of_threads() to limit operations to those necessary for thread adjustment.
See also
initialize()

Implements nest::ManagerInterface.

◆ get_status()

void nest::ModuleManager::get_status ( Dictionary &  )
inlineoverridevirtual

Retrieve the status of the manager.

Note
This would ideally be a const function. However, some managers delay the update of internal variables up to the point where they are needed (e.g., before reporting their values to the user, or before simulate is called). An example for this pattern is the call to update_delay_extrema_() right at the beginning of ConnectionManager::get_status().
See also
set_status()

Implements nest::ManagerInterface.

◆ initialize()

void nest::ModuleManager::initialize ( const bool  adjust_number_of_threads_or_rng_only)
inlineoverridevirtual

Prepare manager for operation.

After this method has completed, the manager should be completely initialized and "ready for action".

Note
Initialization of any given manager may depend on other managers having been initialized before. KernelManager::initialize() is responsible for calling the initialization routines on the specific managers in correct order.
Parameters
adjust_number_of_threads_or_rng_onlyPass true if calling from kernel_manager::change_number_of_threads() or RandomManager::get_status() to limit operations to those necessary for thread adjustment or switch or re-seeding of RNG.
See also
finalize()

Implements nest::ManagerInterface.

◆ install()

void nest::ModuleManager::install ( const std::string &  )
inline

Referenced by nest::install_module().

Here is the caller graph for this function:

◆ reinitialize_dynamic_modules()

void nest::ModuleManager::reinitialize_dynamic_modules ( )
inline

Referenced by nest::KernelManager::change_number_of_threads().

Here is the caller graph for this function:

◆ set_status()

void nest::ModuleManager::set_status ( const Dictionary &  )
inlineoverridevirtual

Set the status of the manager.

See also
get_status()

Implements nest::ManagerInterface.


The documentation for this class was generated from the following file: