rambrain
Public Member Functions | Private Member Functions | Private Attributes | List of all members
rambrain::rambrainglobals::rambrainConfig Class Reference

Main class for handling configuration throughout the library and for the user. More...

#include <rambrainconfig.h>

Public Member Functions

 rambrainConfig ()
 Construct a new config handling class. More...
 
 ~rambrainConfig ()
 Destructs the throught the config initiated swap and manager. More...
 
void reinit (bool reread=true)
 Reinitialises the system. More...
 
void setCustomConfigPath (const string &path)
 Simple setter. More...
 
const configuration & getConfig ()
 Simple getter. More...
 
void resizeMemory (global_bytesize memory)
 Simple setter. More...
 
void resizeSwap (global_bytesize memory)
 Simple setter. More...
 

Private Member Functions

void init ()
 
void clean ()
 

Private Attributes

configReader config
 
managedSwap * swap
 
managedMemory * manager
 

Detailed Description

Main class for handling configuration throughout the library and for the user.

Definition at line 37 of file rambrainconfig.h.

Constructor & Destructor Documentation

rambrain::rambrainglobals::rambrainConfig::rambrainConfig ( )

Construct a new config handling class.

Reads in the config and sets up the system.

Note
Do not do this yourself, rather use the supplied instance rambrainglobals::config

Definition at line 35 of file rambrainconfig.cpp.

rambrain::rambrainglobals::rambrainConfig::~rambrainConfig ( )

Destructs the throught the config initiated swap and manager.

Definition at line 41 of file rambrainconfig.cpp.

Member Function Documentation

void rambrain::rambrainglobals::rambrainConfig::clean ( )
private

Clean up the system and delete instances

Definition at line 88 of file rambrainconfig.cpp.

const configuration& rambrain::rambrainglobals::rambrainConfig::getConfig ( )
inline

Simple getter.

Definition at line 69 of file rambrainconfig.h.

void rambrain::rambrainglobals::rambrainConfig::init ( )
private

Initialise the system

Definition at line 69 of file rambrainconfig.cpp.

void rambrain::rambrainglobals::rambrainConfig::reinit ( bool  reread = true)

Reinitialises the system.

Parameters
rereadIf the / a config file should be rereaad before resetting up the main classes

Definition at line 46 of file rambrainconfig.cpp.

void rambrain::rambrainglobals::rambrainConfig::resizeMemory ( global_bytesize  memory)

Simple setter.

Definition at line 55 of file rambrainconfig.cpp.

void rambrain::rambrainglobals::rambrainConfig::resizeSwap ( global_bytesize  memory)

Simple setter.

Warning
Currently only extending may be supported, ergo this means to reinitiate the main classes and to throw away the old ones deleting all existing managed pointers

Definition at line 62 of file rambrainconfig.cpp.

void rambrain::rambrainglobals::rambrainConfig::setCustomConfigPath ( const string &  path)
inline

Simple setter.

Definition at line 62 of file rambrainconfig.h.

Member Data Documentation

configReader rambrain::rambrainglobals::rambrainConfig::config
private

Definition at line 93 of file rambrainconfig.h.

managedMemory* rambrain::rambrainglobals::rambrainConfig::manager
private

Definition at line 95 of file rambrainconfig.h.

managedSwap* rambrain::rambrainglobals::rambrainConfig::swap
private

Definition at line 94 of file rambrainconfig.h.

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