NEST  2.6.0,not_revisioned_source_dir@0
Classes | Public Member Functions | Public Attributes | Private Member Functions | Private Attributes | List of all members
SLIStartup Class Reference

#include <slistartup.h>

Inheritance diagram for SLIStartup:
SLIModule

Classes

class  GetenvFunction
 

Public Member Functions

 SLIStartup (int, char **)
 
 ~SLIStartup ()
 
void init (SLIInterpreter *)
 Initialise the module. More...
 
const std::string name (void) const
 Return name of the module. More...
 
- Public Member Functions inherited from SLIModule
virtual ~SLIModule ()
 
virtual const std::string commandstring (void) const
 Return sli command sequence to be executed for initialisation. More...
 
void install (std::ostream &, SLIInterpreter *)
 Print installation message via interpreter message command. More...
 

Public Attributes

Name argv_name
 
Name prgname_name
 
Name exitcode_name
 
Name prgmajor_name
 
Name prgminor_name
 
Name prgpatch_name
 
Name prgbuilt_name
 
Name prefix_name
 
Name prgsourcedir_name
 
Name prgbuilddir_name
 
Name prgdatadir_name
 
Name prgdocdir_name
 
Name host_name
 
Name hostos_name
 
Name hostvendor_name
 
Name hostcpu_name
 
Name getenv_name
 
Name statusdict_name
 
Name start_name
 
Name intsize_name
 
Name longsize_name
 
Name havelonglong_name
 
Name longlongsize_name
 
Name doublesize_name
 
Name pointersize_name
 
Name architecturedict_name
 
Name platform_name
 
Name threading_name
 
Name have_mpi_name
 
Name ismpi_name
 
Name have_gsl_name
 
Name have_music_name
 
Name have_libneurosim_name
 
Name ndebug_name
 
Name exitcodes_name
 
Name exitcode_success_name
 
Name exitcode_scripterror_name
 
Name exitcode_abort_name
 
Name exitcode_userabort_name
 
Name exitcode_segfault_name
 
Name exitcode_exception_name
 
Name exitcode_fatal_name
 
Name exitcode_unknownerror_name
 
Name environment_name
 
GetenvFunction getenvfunction
 

Private Member Functions

std::string locateSLIInstallationPath (void)
 
bool checkpath (std::string const &, std::string &) const
 Returns true, if the interpreter startup file sli-init.sli is in the supplied path and false otherwise. More...
 
std::string getenv (const std::string &) const
 
std::string checkenvpath (std::string const &, SLIInterpreter *, std::string) const
 Checks if the environment variable envvar contains a directory. More...
 

Private Attributes

const std::string startupfilename
 
const std::string slilibpath
 
std::string slihomepath
 
std::string slidocdir
 
Token targs
 
int verbosity_
 
bool debug_
 

Constructor & Destructor Documentation

SLIStartup::SLIStartup ( int  argc,
char **  argv 
)
SLIStartup::~SLIStartup ( )
inline

Member Function Documentation

std::string SLIStartup::checkenvpath ( std::string const &  envvar,
SLIInterpreter i,
std::string  defaultval = "" 
) const
private

Checks if the environment variable envvar contains a directory.

If yes, the path is returned, else an empty string is returned.

References getenv(), SLIInterpreter::M_ERROR, and SLIInterpreter::message().

Referenced by init().

bool SLIStartup::checkpath ( std::string const &  path,
std::string &  result 
) const
private

Returns true, if the interpreter startup file sli-init.sli is in the supplied path and false otherwise.

References slilibpath, and startupfilename.

Referenced by init().

std::string SLIStartup::getenv ( const std::string &  v) const
private
void SLIStartup::init ( SLIInterpreter )
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.

Implements SLIModule.

References architecturedict_name, argv_name, assert(), SLIInterpreter::backtrace_on(), SLIInterpreter::baselookup(), checkenvpath(), checkpath(), SLIInterpreter::createcommand(), debug_, SLIInterpreter::debug_mode_on(), SLIInterpreter::def(), doublesize_name, environ, environment_name, SLIInterpreter::EStack, exitcode_abort_name, exitcode_exception_name, exitcode_fatal_name, exitcode_name, exitcode_scripterror_name, exitcode_segfault_name, exitcode_success_name, exitcode_unknownerror_name, exitcode_userabort_name, exitcodes_name, getenv_name, getenvfunction, have_gsl_name, have_libneurosim_name, have_mpi_name, have_music_name, havelonglong_name, host_name, hostcpu_name, hostos_name, hostvendor_name, intsize_name, SLIInterpreter::iparse_name, longlongsize_name, longsize_name, SLIInterpreter::M_DEBUG, SLIInterpreter::M_FATAL, SLIInterpreter::M_INFO, SLIInterpreter::M_QUIET, SLIInterpreter::message(), ndebug_name, platform_name, pointersize_name, prefix_name, prgbuilddir_name, prgbuilt_name, prgdatadir_name, prgdocdir_name, prgmajor_name, prgminor_name, prgname_name, prgpatch_name, prgsourcedir_name, TokenStack::push(), TokenStack::push_move(), slidocdir, slihomepath, SLIsignalflag, start_name, SLIInterpreter::statusdict, statusdict_name, targs, threading_name, lockPTR< D >::valid(), SLIInterpreter::verbosity(), and verbosity_.

std::string SLIStartup::locateSLIInstallationPath ( void  )
private
const std::string SLIStartup::name ( void  ) const
inlinevirtual

Return name of the module.

Implements SLIModule.

Member Data Documentation

Name SLIStartup::architecturedict_name

Referenced by init().

Name SLIStartup::argv_name

Referenced by init().

bool SLIStartup::debug_
private

Referenced by init(), and SLIStartup().

Name SLIStartup::doublesize_name

Referenced by init().

Name SLIStartup::environment_name

Referenced by init().

Name SLIStartup::exitcode_abort_name

Referenced by init().

Name SLIStartup::exitcode_exception_name

Referenced by init().

Name SLIStartup::exitcode_fatal_name

Referenced by init().

Name SLIStartup::exitcode_name

Referenced by init().

Name SLIStartup::exitcode_scripterror_name

Referenced by init().

Name SLIStartup::exitcode_segfault_name

Referenced by init().

Name SLIStartup::exitcode_success_name

Referenced by init().

Name SLIStartup::exitcode_unknownerror_name

Referenced by init().

Name SLIStartup::exitcode_userabort_name

Referenced by init().

Name SLIStartup::exitcodes_name

Referenced by init().

Name SLIStartup::getenv_name

Referenced by init().

GetenvFunction SLIStartup::getenvfunction

Referenced by init().

Name SLIStartup::have_gsl_name

Referenced by init().

Name SLIStartup::have_libneurosim_name

Referenced by init().

Name SLIStartup::have_mpi_name

Referenced by init().

Name SLIStartup::have_music_name

Referenced by init().

Name SLIStartup::havelonglong_name

Referenced by init().

Name SLIStartup::host_name

Referenced by init().

Name SLIStartup::hostcpu_name

Referenced by init().

Name SLIStartup::hostos_name

Referenced by init().

Name SLIStartup::hostvendor_name

Referenced by init().

Name SLIStartup::intsize_name

Referenced by init().

Name SLIStartup::ismpi_name
Name SLIStartup::longlongsize_name

Referenced by init().

Name SLIStartup::longsize_name

Referenced by init().

Name SLIStartup::ndebug_name

Referenced by init().

Name SLIStartup::platform_name

Referenced by init().

Name SLIStartup::pointersize_name

Referenced by init().

Name SLIStartup::prefix_name

Referenced by init().

Name SLIStartup::prgbuilddir_name

Referenced by init().

Name SLIStartup::prgbuilt_name

Referenced by init().

Name SLIStartup::prgdatadir_name

Referenced by init().

Name SLIStartup::prgdocdir_name

Referenced by init().

Name SLIStartup::prgmajor_name

Referenced by init().

Name SLIStartup::prgminor_name

Referenced by init().

Name SLIStartup::prgname_name

Referenced by init().

Name SLIStartup::prgpatch_name

Referenced by init().

Name SLIStartup::prgsourcedir_name

Referenced by init().

std::string SLIStartup::slidocdir
private

Referenced by init().

std::string SLIStartup::slihomepath
private

Referenced by init().

const std::string SLIStartup::slilibpath
private

Referenced by checkpath().

Name SLIStartup::start_name

Referenced by init().

const std::string SLIStartup::startupfilename
private

Referenced by checkpath().

Name SLIStartup::statusdict_name

Referenced by init().

Token SLIStartup::targs
private

Referenced by init(), and SLIStartup().

Name SLIStartup::threading_name

Referenced by init().

int SLIStartup::verbosity_
private

Referenced by init(), and SLIStartup().


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