NEST  2.6.0,not_revisioned_source_dir@0
Public Member Functions | List of all members
DynModule Class Referenceabstract

Base class for dynamically loadable SLI interpreter modules. More...

#include <dynmodule.h>

Public Member Functions

virtual ~DynModule ()
 
virtual void init (SLIInterpreter *, nest::Network *)=0
 Initialise the module. More...
 
virtual void unregister (SLIInterpreter *, nest::Network *)
 Unregister the symbols defined in module. More...
 
virtual const std::string name (void) const =0
 Return name of the module. More...
 
virtual const std::string commandstring (void) const
 Return sli command sequence to be executed for initialisation. More...
 
void install (std::ostream &, SLIInterpreter *, nest::Network *)
 Print installation message via interpreter message command. More...
 

Detailed Description

Base class for dynamically loadable SLI interpreter modules.

Constructor & Destructor Documentation

virtual DynModule::~DynModule ( )
inlinevirtual

Member Function Documentation

const std::string DynModule::commandstring ( void  ) const
virtual

Return sli command sequence to be executed for initialisation.

Referenced by SLIInterpreter::addlinkeddynmodule(), and nest::DynamicLoaderModule::LoadModuleFunction::execute().

virtual void DynModule::init ( SLIInterpreter ,
nest::Network  
)
pure virtual

Initialise the module.

When this function is called, most of the interpreter's fascilities are up and running. However, depending on where in the interpreter's bootstrap sequence the module is initialised, not all services may be available.

Referenced by install().

void DynModule::install ( std::ostream &  ,
SLIInterpreter i,
nest::Network net 
)

Print installation message via interpreter message command.

References init(), SLIInterpreter::message(), and name().

Referenced by SLIInterpreter::addlinkeddynmodule(), and nest::DynamicLoaderModule::LoadModuleFunction::execute().

virtual const std::string DynModule::name ( void  ) const
pure virtual
virtual void DynModule::unregister ( SLIInterpreter ,
nest::Network  
)
inlinevirtual

Unregister the symbols defined in module.

Referenced by nest::DynamicLoaderModule::UnloadModuleFunction::execute().


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