Regina Calculation Engine
Static Public Member Functions
regina::NGlobalDirs Class Reference

Provides global routines that return directories in which various components of Regina are installed on the system. More...

#include <nglobaldirs.h>

List of all members.

Static Public Member Functions

static std::string home ()
 Returns Regina's primary home directory on the system.
static std::string pythonModule ()
 Returns the directory in which Regina's python module is installed.
static std::string pythonLibs ()
 Returns the directory in which optional "helper" Python libraries are installed.
static std::string examples ()
 Returns the directory in which example data files and census data files are installed.
static std::string engineDocs ()
 Returns the directory in which API documentation for Regina's calculation engine is installed.

Detailed Description

Provides global routines that return directories in which various components of Regina are installed on the system.

These routines are only useful with a normal installation of Regina. Specifically, they return the relevant directories as they should be according to the arguments given to the configure script at build time. If Regina is being run directly out of the source tree, or if files were moved around after Regina was installed, then these directories might well not exist.

It is possible that, in future versions of Regina, these routines will support more interesting scenarios, such as running out of the source tree or moving ready-made "application bundles" around the system.


Member Function Documentation

static std::string regina::NGlobalDirs::engineDocs ( ) [static]

Returns the directory in which API documentation for Regina's calculation engine is installed.

Warning:
Currently this routine only returns useful results if Regina has been properly installed on the system. See the NGlobalDirs class notes for further details.
Returns:
Regina's calculation engine documentation directory.
static std::string regina::NGlobalDirs::examples ( ) [static]

Returns the directory in which example data files and census data files are installed.

Warning:
Currently this routine only returns useful results if Regina has been properly installed on the system. See the NGlobalDirs class notes for further details.
Returns:
Regina's example and census data directory.
static std::string regina::NGlobalDirs::home ( ) [static]

Returns Regina's primary home directory on the system.

This directory should contains subdirectories scripts/, icons/, examples/ and so on.

Warning:
Currently this routine only returns useful results if Regina has been properly installed on the system. See the NGlobalDirs class notes for further details.
Returns:
Regina's primary home directory.
static std::string regina::NGlobalDirs::pythonLibs ( ) [static]

Returns the directory in which optional "helper" Python libraries are installed.

These libraries are not a formal part of Regina, but can be made to load automatically as extra user libraries through Regina's python settings.

Warning:
Currently this routine only returns useful results if Regina has been properly installed on the system. See the NGlobalDirs class notes for further details.
Returns:
Regina's optional Python library directory.
static std::string regina::NGlobalDirs::pythonModule ( ) [static]

Returns the directory in which Regina's python module is installed.

Warning:
Currently this routine only returns useful results if Regina has been properly installed on the system. See the NGlobalDirs class notes for further details.
Returns:
Regina's python module directory.

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

Copyright © 1999-2009, Ben Burton
This software is released under the GNU General Public License.
For further information, or to submit a bug or other problem, please contact Ben Burton (bab@debian.org).