G4EnvironmentUtils.hh File Reference

#include <cstdlib>
#include <iomanip>
#include <iostream>
#include <map>
#include <mutex>
#include <sstream>
#include <string>
#include "G4Exception.hh"
#include "G4ExceptionSeverity.hh"
#include "G4String.hh"
#include "G4ios.hh"

Go to the source code of this file.

Data Structures
class	G4EnvSettings

Functions
G4String	G4GetDataEnv (const std::string &env_id, const char *originOfException, const char *exceptionCode, G4ExceptionSeverity severity, const char *description)
template<typename _Tp >
_Tp	G4GetEnv (const std::string &env_id, _Tp _default, const std::string &msg)
template<typename _Tp >
_Tp	G4GetEnv (const std::string &env_id, _Tp _default=_Tp())
template<>
G4bool	G4GetEnv (const std::string &env_id, bool _default)
void	G4PrintEnv (std::ostream &os=G4cout)

Function Documentation

G4GetDataEnv()

G4String G4GetDataEnv ( const std::string &  env_id, const char *  originOfException, const char *  exceptionCode, G4ExceptionSeverity  severity, const char *  description  )

inline

Definition at line 198 of file G4EnvironmentUtils.hh.

{
  char* env_var = std::getenv(env_id.c_str());
  if(env_var)
  {
    std::string str_var = std::string(env_var);
    std::istringstream iss(str_var);
    G4String var = "";
    iss >> var;
    // record value defined by environment
    G4EnvSettings::GetInstance()->insert<G4String>(env_id, var);
    return var;
  }
 
  // issue an exception
  G4Exception(originOfException, exceptionCode, severity, description);
 
  // return default initialized
  return "";
}

References G4Exception(), G4EnvSettings::GetInstance(), and G4EnvSettings::insert().

G4GetEnv() [1/3]

template<typename _Tp >

_Tp G4GetEnv	(	const std::string &	env_id,
		_Tp	_default,
		const std::string &	msg
	)

Definition at line 167 of file G4EnvironmentUtils.hh.

{
  char* env_var = std::getenv(env_id.c_str());
  if(env_var)
  {
    std::string str_var = std::string(env_var);
    std::istringstream iss(str_var);
    _Tp var = _Tp();
    iss >> var;
    G4cout << "Environment variable \"" << env_id << "\" enabled with "
           << "value == " << var << ". " << msg << G4endl;
    // record value defined by environment
    G4EnvSettings::GetInstance()->insert<_Tp>(env_id, var);
    return var;
  }
  // record default value
  G4EnvSettings::GetInstance()->insert<_Tp>(env_id, _default);
 
  // return default if not specified in environment
  return _default;
}

References G4cout, G4endl, G4EnvSettings::GetInstance(), and G4EnvSettings::insert().

G4GetEnv() [2/3]

template<typename _Tp >

_Tp G4GetEnv	(	const std::string &	env_id,
		_Tp	_default = _Tp()
	)

Definition at line 116 of file G4EnvironmentUtils.hh.

{
  char* env_var = std::getenv(env_id.c_str());
  if(env_var)
  {
    std::string str_var = std::string(env_var);
    std::istringstream iss(str_var);
    _Tp var = _Tp();
    iss >> var;
    // record value defined by environment
    G4EnvSettings::GetInstance()->insert<_Tp>(env_id, var);
    return var;
  }
  // record default value
  G4EnvSettings::GetInstance()->insert<_Tp>(env_id, _default);
 
  // return default if not specified in environment
  return _default;
}

References G4EnvSettings::GetInstance(), and G4EnvSettings::insert().

G4GetEnv() [3/3]

template<>

G4bool G4GetEnv ( const std::string &  env_id, bool  _default  )

inline

Definition at line 143 of file G4EnvironmentUtils.hh.

{
  char* env_var = std::getenv(env_id.c_str());
  if(env_var)
  {
    // record value defined by environment
    G4EnvSettings::GetInstance()->insert<bool>(env_id, true);
    return true;
  }
  // record default value
  G4EnvSettings::GetInstance()->insert<bool>(env_id, false);
 
  // return default if not specified in environment
  return _default;
}

References G4EnvSettings::GetInstance(), and G4EnvSettings::insert().

G4PrintEnv()

void G4PrintEnv ( std::ostream &  os = G4cout )

inline

Definition at line 226 of file G4EnvironmentUtils.hh.

{
  os << (*G4EnvSettings::GetInstance());
}

References G4EnvSettings::GetInstance().