Pythia8_UserHooks::UserSetting< T > Class Template Reference

#include <UserSetting.h>

Collaboration diagram for Pythia8_UserHooks::UserSetting< T >:

Public Member Functions
	UserSetting (const std::string &name, const T &defaultValue)
T	operator() (Pythia8::Settings *settingsPtr)

Protected Attributes
std::string	m_paramName
T	m_param
Pythia8::Settings *	m_settingsPtr
bool	m_retrieved

Private Member Functions
T	uncachedRetrieve ()
double	uncachedRetrieve ()
int	uncachedRetrieve ()
bool	uncachedRetrieve ()
std::string	uncachedRetrieve ()

Detailed Description

template<class T>
class Pythia8_UserHooks::UserSetting< T >

Definition at line 17 of file UserSetting.h.

Constructor & Destructor Documentation

UserSetting()

template<class T>

Pythia8_UserHooks::UserSetting< T >::UserSetting ( const std::string & name, const T & defaultValue )

inline

Definition at line 21 of file UserSetting.h.

                                                             :
    m_paramName(name),
    m_param(defaultValue),
    m_settingsPtr(0),
    m_retrieved(false){
      
      typename std::map<std::string, T>::const_iterator test = UserHooksFactory::userSettings<T>().find(m_paramName);
      if(test != UserHooksFactory::userSettings<T>().end()) throw std::runtime_error("Duplicate user-defined setting already exists: " + m_paramName);
      UserHooksFactory::userSettings<T>()[m_paramName] = defaultValue;
      
    }

Member Function Documentation

operator()()

template<class T>

T Pythia8_UserHooks::UserSetting< T >::operator() ( Pythia8::Settings * settingsPtr )

inline

Definition at line 33 of file UserSetting.h.

                                              {
    
      if(m_settingsPtr == 0 && settingsPtr == 0) throw std::runtime_error("settingsPtr is not yet initialised!");
      
      if(m_retrieved && m_settingsPtr == settingsPtr) return m_param;
      
      m_settingsPtr = settingsPtr;
      m_param = uncachedRetrieve();
      m_retrieved = true;
      return m_param;
    };

uncachedRetrieve() [1/5]

template<class T>

T Pythia8_UserHooks::UserSetting< T >::uncachedRetrieve ( )

private

uncachedRetrieve() [2/5]

double Pythia8_UserHooks::UserSetting< double >::uncachedRetrieve ( )

inlineprivate

Definition at line 59 of file UserSetting.h.

                                                     {
    if(m_settingsPtr->isParm(m_paramName)){
      return m_settingsPtr->parm(m_paramName);
    }
    
    throw std::runtime_error("UserSetting " + m_paramName + " does not exist!");
    return m_param;
  }

uncachedRetrieve() [3/5]

int Pythia8_UserHooks::UserSetting< int >::uncachedRetrieve ( )

inlineprivate

Definition at line 69 of file UserSetting.h.

                                               {
    if(not m_settingsPtr->isMode(m_paramName)){
      throw std::runtime_error("UserSetting " + m_paramName + " does not exist!");
    }
    return m_settingsPtr->mode(m_paramName);
  }

uncachedRetrieve() [4/5]

bool Pythia8_UserHooks::UserSetting< bool >::uncachedRetrieve ( )

inlineprivate

Definition at line 77 of file UserSetting.h.

                                                 {
    if(not m_settingsPtr->isFlag(m_paramName)){
      throw std::runtime_error("UserSetting " + m_paramName + " does not exist!");
    }
  return m_settingsPtr->flag(m_paramName);
  }

uncachedRetrieve() [5/5]

std::string Pythia8_UserHooks::UserSetting< std::string >::uncachedRetrieve ( )

inlineprivate

Definition at line 86 of file UserSetting.h.

                                                           {
    if(not m_settingsPtr->isWord(m_paramName)){
      throw std::runtime_error("UserSetting " + m_paramName + " does not exist!");
    }
    return m_settingsPtr->word(m_paramName);
  }

Member Data Documentation

m_param

template<class T>

T Pythia8_UserHooks::UserSetting< T >::m_param

protected

Definition at line 48 of file UserSetting.h.

m_paramName

template<class T>

std::string Pythia8_UserHooks::UserSetting< T >::m_paramName

protected

Definition at line 47 of file UserSetting.h.

m_retrieved

template<class T>

bool Pythia8_UserHooks::UserSetting< T >::m_retrieved

protected

Definition at line 50 of file UserSetting.h.

m_settingsPtr

template<class T>

Pythia8::Settings* Pythia8_UserHooks::UserSetting< T >::m_settingsPtr

protected

Definition at line 49 of file UserSetting.h.

---

The documentation for this class was generated from the following file:

• UserSetting.h