Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Enumerations | Functions
Teuchos::SystemInformation Namespace Reference

Enumerations

enum  RegistrationResult { REGISTERED, ALREADY_PRESENT, FAILURE }
 

Functions

bool commandIsAvailable (const std::string &command)
 Check whether a command is available on the system. More...
 
std::string runCommandAndCaptureOutput (const std::string &command)
 Run a command and capture its output. More...
 
RegistrationResult registerEnvironmentVariable (const std::string &variableName)
 Register an environment variable that should be tracked. More...
 
void registerAllPrefixedVariables (const std::string &prefix)
 
RegistrationResult registerCommand (const std::string &commandLabel, const std::string &commandToRunAndCapture="", const std::string &commandToCheckForExistence="")
 Register a command. More...
 
void initializeCollection ()
 Track commonly used environment variables and commands. More...
 
std::map< std::string,
std::string > 
collectSystemInformation ()
 Collect information about the system. More...
 

Enumeration Type Documentation

Enumerator
REGISTERED 
ALREADY_PRESENT 
FAILURE 

Definition at line 38 of file Teuchos_SystemInformation.hpp.

Function Documentation

bool Teuchos::SystemInformation::commandIsAvailable ( const std::string &  command)

Check whether a command is available on the system.

Definition at line 44 of file Teuchos_SystemInformation.cpp.

std::string Teuchos::SystemInformation::runCommandAndCaptureOutput ( const std::string &  command)

Run a command and capture its output.

Definition at line 49 of file Teuchos_SystemInformation.cpp.

RegistrationResult Teuchos::SystemInformation::registerEnvironmentVariable ( const std::string &  variableName)

Register an environment variable that should be tracked.

Definition at line 68 of file Teuchos_SystemInformation.cpp.

void Teuchos::SystemInformation::registerAllPrefixedVariables ( const std::string &  prefix)

Register all variables with a given prefix that can be found in the environment.

Definition at line 82 of file Teuchos_SystemInformation.cpp.

RegistrationResult Teuchos::SystemInformation::registerCommand ( const std::string &  commandLabel,
const std::string &  commandToRunAndCapture,
const std::string &  commandToCheckForExistence 
)

Register a command.

Definition at line 104 of file Teuchos_SystemInformation.cpp.

void Teuchos::SystemInformation::initializeCollection ( )

Track commonly used environment variables and commands.

Definition at line 138 of file Teuchos_SystemInformation.cpp.

std::map< std::string, std::string > Teuchos::SystemInformation::collectSystemInformation ( )

Collect information about the system.

Definition at line 240 of file Teuchos_SystemInformation.cpp.