Class xlifepp::Environment#

class Environment#

Collaboration diagram for xlifepp::Environment:

Class Environment stores environment (!) variables and methods to build them.

Public Functions

Environment(Language lang = _en)#: constructor

inline ~Environment()#: destructor

inline string_t geoMacroFilePath() const#: returns path to geo macro file (for runtime mesh generation with gmsh)

inline bool known() const#: returns true if the machine name is not empty

inline int language() const#: return language as an int

string_t languageString() const#: returns language as a string

void localizedStrings()#

builds localized strings

reads dictionnary words from file format: # string_family_id string_id word … create an MsgFormat object for each item read

inline string_t machineName() const#: returns machine name

inline string_t msgFilePath() const#: returns path to error files

void names()#

defines OS and machine names

find OS and machine names

inline int numberOfLanguages()#: return number of recognized languages

inline string_t osName() const#: returns OS name

void printDictionary(std::ostream&)#: print dictionary

void printHeader(const Timer&)#: display logo and header information on console

void printHeader(std::ofstream&)#: display logo and header information on aux files

void processor()#

defines processor or machine type name

Search for processor or machine type name.

inline string_t processorName() const#: returns processor or machine type name

void rebuild()#: true constructor

int returnedFunctionType(const string_t &s)#: return type of returned function value

int returnedKernelType(const string_t &s)#: return type of returned kernel function value

void setGeoMacroFilePath()#

defines path to xlife++ geo macro file (for runtime mesh generation with gmsh)

Default path to message and error files.

void setMsgFilePath()#

defines path to xlife++ error files

Default path to message and error files.

void version()#: defines version number and date of XLiFE++ from the VERSION.txt file

Public Static Functions

static inline std::vector<string_t> authorizedSaveToFileExtensions()#: return the list of authorized file extensions in saveToFile routines

static inline void authorizedSaveToFileExtensions(const std::vector<string_t> &extensions)#: sets the list of authorized file extensions in saveToFile routines

static inline string_t gmshExe()#: return gmsh binary

static inline string_t installPath()#: return installation path

static inline string_t paraviewExe()#: return paraview binary

static inline bool running()#: returns running state

static inline std::vector<string_t> systemKeys()#: return the list of system keys

static inline void systemKeys(const std::vector<string_t> &keys)#: return the list of system keys

static inline string_t visuTermVecMPath()#: return path to visuTermVec.m

Friends

friend string_t words(const bool)#: accessor to words with a boolean

friend string_t words(const char*)#: accessor to words with a const char* (needed to avoid automatic cast to bool type)

friend string_t words(const string_t&)#

accessor to words with a string_t

external function to manage localized strings

friend string_t words(const string_t&, int)#: accessor to enumWords