Collect information about the runtime environment. More...

#include <map>
#include <string>

Namespaces
namespace	Teuchos
	The Teuchos namespace contains all of the classes, structs and enums used by Teuchos, as well as a number of utility routines.

Functions
bool	Teuchos::SystemInformation::commandIsAvailable (const std::string &command)
	Check whether a command is available on the system.

std::string	Teuchos::SystemInformation::runCommandAndCaptureOutput (const std::string &command)
	Run a command and capture its output.

RegistrationResult	Teuchos::SystemInformation::registerEnvironmentVariable (const std::string &variableName)
	Register an environment variable that should be tracked.

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

RegistrationResult	Teuchos::SystemInformation::registerEnvironmentVariablePrefix (const std::string &prefix)
	Register an environment variable prefix that should be tracked.

RegistrationResult	Teuchos::SystemInformation::registerCommand (const std::string &commandLabel, const std::string &commandToRunAndCapture="", const std::string &commandToCheckForExistence="")
	Register a command.

void	Teuchos::SystemInformation::initializeCollection ()
	Track commonly used environment variables and commands.

std::map< std::string, std::string >	Teuchos::SystemInformation::collectSystemInformation ()
	Collect information about the system.

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.

Function Documentation

◆ commandIsAvailable()

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

Check whether a command is available on the system.

Definition at line 50 of file Teuchos_SystemInformation.cpp.

◆ runCommandAndCaptureOutput()

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

Run a command and capture its output.

Definition at line 55 of file Teuchos_SystemInformation.cpp.

◆ registerEnvironmentVariable()

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

Register an environment variable that should be tracked.

Definition at line 74 of file Teuchos_SystemInformation.cpp.

◆ registerAllPrefixedVariables()

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 88 of file Teuchos_SystemInformation.cpp.

◆ registerEnvironmentVariablePrefix()

RegistrationResult Teuchos::SystemInformation::registerEnvironmentVariablePrefix ( const std::string & prefix )

Register an environment variable prefix that should be tracked.

Definition at line 112 of file Teuchos_SystemInformation.cpp.

◆ registerCommand()

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

Register a command.

Definition at line 127 of file Teuchos_SystemInformation.cpp.

◆ initializeCollection()

void Teuchos::SystemInformation::initializeCollection ( )

Track commonly used environment variables and commands.

Definition at line 161 of file Teuchos_SystemInformation.cpp.

◆ collectSystemInformation()

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

Collect information about the system.

Definition at line 263 of file Teuchos_SystemInformation.cpp.

Namespaces

Functions