Teuchos_SystemInformation.hpp File Reference

Collect information about the runtime environment. More...

#include <map>
#include <string>

Include dependency graph for Teuchos_SystemInformation.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
	Teuchos::SystemInformation

Enumerations
enum	Teuchos::SystemInformation::RegistrationResult { Teuchos::SystemInformation::REGISTERED, Teuchos::SystemInformation::ALREADY_PRESENT, Teuchos::SystemInformation::FAILURE }

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

Detailed Description

Collect information about the runtime environment.

This tool collects the values of environment variables and the output of commands for debugging purposes. Several useful variables and commands are pre-registered. Additional environment variables can be added by setting export TEUCHOS_USER_ENVIRONMENT_VARIABLES=MY_FANCY_VARIABLE;MY_LESS_FANCY_VARIABLE Additional commands can be added by setting export TEUCHOS_USER_COMMANDS=label_for_the_command;command_to_call;executable_that_is_checked_for_availabilty;.... The collection of data can be triggered by passing a –print-system-info to any Teuchos::CommandLineProcessor

Definition in file Teuchos_SystemInformation.hpp.