G4HadronicDeveloperParameters Class Reference

#include <G4HadronicDeveloperParameters.hh>

Public Member Functions
G4bool	DeveloperGet (const std::string name, G4bool &value)
G4bool	DeveloperGet (const std::string name, G4double &value)
G4bool	DeveloperGet (const std::string name, G4int &value)
void	Dump (const std::string name)
G4bool	Get (const std::string name, G4bool &value)
G4bool	Get (const std::string name, G4double &value)
G4bool	Get (const std::string name, G4int &value)
G4bool	GetDefault (const std::string name, G4bool &value)
G4bool	GetDefault (const std::string name, G4double &value)
G4bool	GetDefault (const std::string name, G4int &value)
G4bool	Set (const std::string name, const G4bool)
G4bool	Set (const std::string name, const G4double)
G4bool	Set (const std::string name, const G4int)
G4bool	SetDefault (const std::string name, const G4bool value)
G4bool	SetDefault (const std::string name, const G4double value, G4double lower_limit=-DBL_MAX, G4double upper_limit=DBL_MAX)
G4bool	SetDefault (const std::string name, const G4int value, G4int lower_limit=-INT_MAX, G4int upper_limit=INT_MAX)

Static Public Member Functions
static G4HadronicDeveloperParameters &	GetInstance ()

Private Member Functions
G4bool	check_value_within_limits (std::pair< const G4double, const G4double > &, G4double)
G4bool	check_value_within_limits (std::pair< const G4int, const G4int > &, G4int)
	G4HadronicDeveloperParameters ()
	G4HadronicDeveloperParameters (const G4HadronicDeveloperParameters &)
G4bool	get (const std::string name, G4bool &value, G4bool check_change=false)
G4bool	get (const std::string name, G4double &value, G4bool check_change=false)
G4bool	get (const std::string name, G4int &value, G4bool check_change=false)
void	issue_has_changed (const std::string &name)
void	issue_is_already_defined (const std::string &name)
void	issue_is_modified (const std::string &name)
void	issue_no_param (const std::string &name)
void	issue_non_eligible_value (const std::string &name)
G4HadronicDeveloperParameters &	operator= (const G4HadronicDeveloperParameters &)

Private Attributes
std::map< std::string, const G4bool >	b_defaults
std::map< std::string, G4bool >	b_values
std::map< std::string, const G4double >	defaults
std::map< std::string, const G4int >	i_defaults
std::map< std::string, std::pair< const G4int, const G4int > >	i_limits
std::map< std::string, G4int >	i_values
std::map< std::string, std::pair< const G4double, const G4double > >	limits
std::map< std::string, G4double >	values

Detailed Description

Definition at line 36 of file G4HadronicDeveloperParameters.hh.

Constructor & Destructor Documentation

G4HadronicDeveloperParameters() [1/2]

G4HadronicDeveloperParameters::G4HadronicDeveloperParameters ( )

private

Definition at line 33 of file G4HadronicDeveloperParameters.cc.

                                                            {
}

G4HadronicDeveloperParameters() [2/2]

G4HadronicDeveloperParameters::G4HadronicDeveloperParameters ( const G4HadronicDeveloperParameters &  )

private

Definition at line 36 of file G4HadronicDeveloperParameters.cc.

                                                                                                  { 
}

Member Function Documentation

check_value_within_limits() [1/2]

G4bool G4HadronicDeveloperParameters::check_value_within_limits ( std::pair< const G4double, const G4double > &  alimits, G4double  value  )

private

Definition at line 293 of file G4HadronicDeveloperParameters.cc.

                                                                                                                                       {
   if ( alimits.first <= value && value <= alimits.second ) {
      return true;
   } else {
      return false;
   }
}

Referenced by Set().

check_value_within_limits() [2/2]

G4bool G4HadronicDeveloperParameters::check_value_within_limits ( std::pair< const G4int, const G4int > &  alimits, G4int  value  )

private

Definition at line 301 of file G4HadronicDeveloperParameters.cc.

                                                                                                                              {
   if ( alimits.first <= value && value <= alimits.second ) {
      return true;
   } else {
      return false;
   }
}

DeveloperGet() [1/3]

G4bool G4HadronicDeveloperParameters::DeveloperGet	(	const std::string	name,
		G4bool &	value
	)

Definition at line 242 of file G4HadronicDeveloperParameters.cc.

                                                                                         {
   return get( name , value , true );
}

References get(), and G4InuclParticleNames::name().

Referenced by G4FTFParamCollBaryonProj::G4FTFParamCollBaryonProj(), G4FTFParamCollMesonProj::G4FTFParamCollMesonProj(), G4FTFParamCollPionProj::G4FTFParamCollPionProj(), and G4CascadeParameters::Initialize().

DeveloperGet() [2/3]

G4bool G4HadronicDeveloperParameters::DeveloperGet	(	const std::string	name,
		G4double &	value
	)

Definition at line 192 of file G4HadronicDeveloperParameters.cc.

                                                                                           {
   return get( name , value , true );
}

References get(), and G4InuclParticleNames::name().

DeveloperGet() [3/3]

G4bool G4HadronicDeveloperParameters::DeveloperGet	(	const std::string	name,
		G4int &	value
	)

Definition at line 217 of file G4HadronicDeveloperParameters.cc.

                                                                                        {
   return get( name , value , true );
}

References get(), and G4InuclParticleNames::name().

Dump()

void G4HadronicDeveloperParameters::Dump

(

const std::string

name

)

Definition at line 263 of file G4HadronicDeveloperParameters.cc.

                                                               {
   //const std::map<std::string,G4double>::iterator it = values.find( name );
   if ( b_values.find( name ) != b_values.end() ) {
      G4cout << "G4HadronicDeveloperParameters: "
      << "name = " << name 
      << ", default value = " << b_defaults.find( name )->second
      << ", current value = " << b_values.find( name )->second
      << "." << G4endl;
   } else if ( i_values.find( name ) != i_values.end() ) {
      G4cout << "G4HadronicDeveloperParameters: "
      << "name = " << name 
      << ", default value = " << i_defaults.find( name )->second
      << ", lower limit = " << i_limits.find( name )->second.first
      << ", upper limit = " << i_limits.find( name )->second.second
      << ", current value = " << i_values.find( name )->second
      << "." << G4endl;
   } else if ( values.find( name ) != values.end() ) {
      G4cout << "G4HadronicDeveloperParameters: "
      << "name = " << name 
      << ", default value = " << defaults.find( name )->second
      << ", lower limit = " << limits.find( name )->second.first
      << ", upper limit = " << limits.find( name )->second.second
      << ", current value = " << values.find( name )->second
      << "." << G4endl;
   } else {
      /*Parameter of "name" does not exist*/
      issue_no_param( name );
   }
}

References b_defaults, b_values, defaults, G4cout, G4endl, i_defaults, i_limits, i_values, issue_no_param(), limits, G4InuclParticleNames::name(), and values.

Get() [1/3]

G4bool G4HadronicDeveloperParameters::Get	(	const std::string	name,
		G4bool &	value
	)

Definition at line 238 of file G4HadronicDeveloperParameters.cc.

                                                                                {
   return get( name , value );
}

References get(), and G4InuclParticleNames::name().

get() [1/3]

G4bool G4HadronicDeveloperParameters::get ( const std::string  name, G4bool &  value, G4bool  check_change = false  )

private

Definition at line 196 of file G4HadronicDeveloperParameters.cc.

                                                                                                      {
   G4bool status = false;
   const std::map<std::string,G4bool>::iterator it = b_values.find( name );
   if ( it != b_values.end() ) {
      status = true;
      value = it->second;
      if ( check_change && value != b_defaults.find(name)->second ) {
         //Parameter "name" has changed from default
         issue_is_modified( name );
      }
   } else { 
      //Parameter of "name" does not exist
      issue_no_param( name );
   }
   return status;
}

References b_defaults, b_values, issue_is_modified(), issue_no_param(), and G4InuclParticleNames::name().

Referenced by DeveloperGet(), and Get().

Get() [2/3]

G4bool G4HadronicDeveloperParameters::Get	(	const std::string	name,
		G4double &	value
	)

Definition at line 188 of file G4HadronicDeveloperParameters.cc.

                                                                                  {
   return get( name , value );
}

References get(), and G4InuclParticleNames::name().

get() [2/3]

G4bool G4HadronicDeveloperParameters::get ( const std::string  name, G4double &  value, G4bool  check_change = false  )

private

Definition at line 246 of file G4HadronicDeveloperParameters.cc.

                                                                                                        {
   G4bool status = false;
   const std::map<std::string,G4double>::iterator it = values.find( name );
   if ( it != values.end() ) {
      status = true;
      value = it->second;
      if ( check_change && value != defaults.find(name)->second ) {
         /*Parameter "name" has changed from default*/
         issue_is_modified( name );
      }
   } else { 
      /*Parameter of "name" does not exist*/
      issue_no_param( name );
   }
   return status;
}

References defaults, issue_is_modified(), issue_no_param(), G4InuclParticleNames::name(), and values.

Get() [3/3]

G4bool G4HadronicDeveloperParameters::Get	(	const std::string	name,
		G4int &	value
	)

Definition at line 213 of file G4HadronicDeveloperParameters.cc.

                                                                               {
   return get( name , value );
}

References get(), and G4InuclParticleNames::name().

get() [3/3]

G4bool G4HadronicDeveloperParameters::get ( const std::string  name, G4int &  value, G4bool  check_change = false  )

private

Definition at line 221 of file G4HadronicDeveloperParameters.cc.

                                                                                                     {
   G4bool status = false;
   const std::map<std::string,G4int>::iterator it = i_values.find( name );
   if ( it != i_values.end() ) {
      status = true;
      value = it->second;
      if ( check_change && value != i_defaults.find(name)->second ) {
         //Parameter "name" has changed from default
         issue_is_modified( name );
      }
   } else { 
      //Parameter of "name" does not exist
      issue_no_param( name );
   }
   return status;
}

References i_defaults, i_values, issue_is_modified(), issue_no_param(), and G4InuclParticleNames::name().

GetDefault() [1/3]

G4bool G4HadronicDeveloperParameters::GetDefault	(	const std::string	name,
		G4bool &	value
	)

Definition at line 149 of file G4HadronicDeveloperParameters.cc.

                                                                                       {
   G4bool status = false;
   const std::map<std::string,const G4bool>::iterator it = b_defaults.find( name );
   if ( it != b_defaults.end() ) {
      status = true;
      value = it->second;
   } else { 
      /*Parameter of "name" does not exist*/
      issue_no_param( name );
   }
   return status;
}

References b_defaults, issue_no_param(), and G4InuclParticleNames::name().

GetDefault() [2/3]

G4bool G4HadronicDeveloperParameters::GetDefault	(	const std::string	name,
		G4double &	value
	)

Definition at line 175 of file G4HadronicDeveloperParameters.cc.

                                                                                         {
   G4bool status = false;
   const std::map<std::string,const G4double>::iterator it = defaults.find( name );
   if ( it != defaults.end() ) {
      status = true;
      value = it->second;
   } else { 
      /*Parameter of "name" does not exist*/
      issue_no_param( name );
   }
   return status;
}

References defaults, issue_no_param(), and G4InuclParticleNames::name().

GetDefault() [3/3]

G4bool G4HadronicDeveloperParameters::GetDefault	(	const std::string	name,
		G4int &	value
	)

Definition at line 162 of file G4HadronicDeveloperParameters.cc.

                                                                                      {
   G4bool status = false;
   const std::map<std::string,const G4int>::iterator it = i_defaults.find( name );
   if ( it != i_defaults.end() ) {
      status = true;
      value = it->second;
   } else { 
      /*Parameter of "name" does not exist*/
      issue_no_param( name );
   }
   return status;
}

References i_defaults, issue_no_param(), and G4InuclParticleNames::name().

GetInstance()

G4HadronicDeveloperParameters & G4HadronicDeveloperParameters::GetInstance ( )

static

Definition at line 28 of file G4HadronicDeveloperParameters.cc.

                                                                         {
    static  G4HadronicDeveloperParameters instance;
    return instance;
}

issue_has_changed()

void G4HadronicDeveloperParameters::issue_has_changed ( const std::string &  name )

private

Definition at line 316 of file G4HadronicDeveloperParameters.cc.

                                                                             {
   std::string text("Parameter ");
   text += name;  
   text += " has already been changed once.";
   G4Exception( "G4HadronicDeveloperParameters" , "HadDevPara_002", FatalException , text.c_str() );
}

References FatalException, G4Exception(), and G4InuclParticleNames::name().

Referenced by Set().

issue_is_already_defined()

void G4HadronicDeveloperParameters::issue_is_already_defined ( const std::string &  name )

private

Definition at line 328 of file G4HadronicDeveloperParameters.cc.

                                                                                    {
   std::string text("Parameter ");
   text += name;  
   text += " is already defined.";
   G4Exception( "G4HadronicDeveloperParameters" , "HadDevPara_004", FatalException , text.c_str() );
}

References FatalException, G4Exception(), and G4InuclParticleNames::name().

Referenced by SetDefault().

issue_is_modified()

void G4HadronicDeveloperParameters::issue_is_modified ( const std::string &  name )

private

Definition at line 334 of file G4HadronicDeveloperParameters.cc.

                                                                             {
   std::string text("Parameter ");
   text += name;  
   text += " has changed from default value.";
   G4Exception( "G4HadronicDeveloperParameters" , "HadDevPara_005", JustWarning , text.c_str() );
}

References G4Exception(), JustWarning, and G4InuclParticleNames::name().

Referenced by get().

issue_no_param()

void G4HadronicDeveloperParameters::issue_no_param ( const std::string &  name )

private

Definition at line 309 of file G4HadronicDeveloperParameters.cc.

                                                                         {
   std::string text("Parameter ");
   text += name;  
   text += " does not exist.";
   G4Exception( "G4HadronicDeveloperParameters" , "HadDevPara_001", FatalException , text.c_str() );
}

References FatalException, G4Exception(), and G4InuclParticleNames::name().

Referenced by Dump(), get(), GetDefault(), and Set().

issue_non_eligible_value()

void G4HadronicDeveloperParameters::issue_non_eligible_value ( const std::string &  name )

private

Definition at line 322 of file G4HadronicDeveloperParameters.cc.

                                                                                    {
   std::string text("The value of the parameter ");
   text += name;  
   text += " is outside the allowable range.";
   G4Exception( "G4HadronicDeveloperParameters" , "HadDevPara_003", FatalException , text.c_str() );
}

References FatalException, G4Exception(), and G4InuclParticleNames::name().

Referenced by Set().

operator=()

G4HadronicDeveloperParameters & G4HadronicDeveloperParameters::operator= ( const G4HadronicDeveloperParameters &  )

private

Set() [1/3]

G4bool G4HadronicDeveloperParameters::Set	(	const std::string	name,
		const G4bool	value
	)

Definition at line 83 of file G4HadronicDeveloperParameters.cc.

                                                                                    {
   G4bool status = false;
   const std::map<std::string,G4bool>::iterator it = b_values.find( name );
   if ( it != b_values.end() ) {
      if ( it->second == b_defaults.find(name)->second ) {
         status = true;
         it->second = value;
      } else {
         /*change more than once*/
         issue_has_changed( name );
      }
   } else {
      /*Parameter of "name" does not exist*/
      issue_no_param( name );
   }
   return status;
}

References b_defaults, b_values, issue_has_changed(), issue_no_param(), and G4InuclParticleNames::name().

Set() [2/3]

G4bool G4HadronicDeveloperParameters::Set	(	const std::string	name,
		const G4double	value
	)

Definition at line 125 of file G4HadronicDeveloperParameters.cc.

                                                                                      {
   G4bool status = false;
   const std::map<std::string,G4double>::iterator it = values.find( name );
   if ( it != values.end() ) {
      if ( it->second == defaults.find(name)->second ) {
         if ( check_value_within_limits( limits.find(name)->second , value ) ) {
            /*value is OK*/
            status = true;
            it->second = value;
         } else {
            /*Value is outside of valid range*/
            issue_non_eligible_value( name );
         }
      } else {
         /*change more than once*/
         issue_has_changed( name );
      }
   } else {
      /*Parameter of "name" does not exist*/
      issue_no_param( name );
   }
   return status;
}

References check_value_within_limits(), defaults, issue_has_changed(), issue_no_param(), issue_non_eligible_value(), limits, G4InuclParticleNames::name(), and values.

Set() [3/3]

G4bool G4HadronicDeveloperParameters::Set	(	const std::string	name,
		const G4int	value
	)

Definition at line 101 of file G4HadronicDeveloperParameters.cc.

                                                                                   {
   G4bool status = false;
   const std::map<std::string,G4int>::iterator it = i_values.find( name );
   if ( it != i_values.end() ) {
      if ( it->second == i_defaults.find(name)->second ) {
         if ( check_value_within_limits( i_limits.find(name)->second , value ) ) {
            /*value is OK*/
            status = true;
            it->second = value;
         } else {
            /*Value is outside of valid range*/
            issue_non_eligible_value( name );
         }
      } else {
         /*change more than once*/
         issue_has_changed( name );
      }
   } else {
      /*Parameter of "name" does not exist*/
      issue_no_param( name );
   }
   return status;
}

References check_value_within_limits(), i_defaults, i_limits, i_values, issue_has_changed(), issue_no_param(), issue_non_eligible_value(), and G4InuclParticleNames::name().

SetDefault() [1/3]

G4bool G4HadronicDeveloperParameters::SetDefault	(	const std::string	name,
		const G4bool	value
	)

Definition at line 39 of file G4HadronicDeveloperParameters.cc.

                                                                                           {
   G4bool status = false;
   const std::map< std::string , const G4bool >::iterator it = b_defaults.find( name );
   if ( it == b_defaults.end() ) {
      status = true;
      b_defaults.insert( std::pair<std::string, const G4bool>( name , value ) );
      b_values.insert( std::pair<std::string, G4bool>( name , value ) );
   } else {
            /*error*/
      issue_is_already_defined( name );
   }
   return status;
}

References b_defaults, b_values, issue_is_already_defined(), and G4InuclParticleNames::name().

Referenced by anonymous_namespace{G4CascadeParameters.cc}::BERTParameters::BERTParameters(), and G4FTFSettingDefaultHDP::G4FTFSettingDefaultHDP().

SetDefault() [2/3]

G4bool G4HadronicDeveloperParameters::SetDefault	(	const std::string	name,
		const G4double	value,
		G4double	lower_limit = -DBL_MAX,
		G4double	upper_limit = DBL_MAX
	)

Definition at line 68 of file G4HadronicDeveloperParameters.cc.

                                                                                                                                           {
   G4bool status = false;
   const std::map< std::string , const G4double >::iterator it = defaults.find( name );
   if ( it == defaults.end() ) {
      status = true;
      defaults.insert( std::pair<std::string, const G4double>( name , value ) );
      values.insert( std::pair<std::string, G4double>( name , value ) );
      limits.insert( std::pair< std::string,std::pair< const G4double , const G4double> >( name, std::pair< const G4double , const G4double> ( lower_limit , upper_limit ) ) );
   } else {
            /*error*/
      issue_is_already_defined( name );
   }
   return status;
}

References defaults, issue_is_already_defined(), limits, G4InuclParticleNames::name(), and values.

SetDefault() [3/3]

G4bool G4HadronicDeveloperParameters::SetDefault	(	const std::string	name,
		const G4int	value,
		G4int	lower_limit = -INT_MAX,
		G4int	upper_limit = INT_MAX
	)

Definition at line 53 of file G4HadronicDeveloperParameters.cc.

                                                                                                                                  {
   G4bool status = false;
   const std::map< std::string , const G4int >::iterator it = i_defaults.find( name );
   if ( it == i_defaults.end() ) {
      status = true;
      i_defaults.insert( std::pair<std::string, const G4int>( name , value ) );
      i_values.insert( std::pair<std::string, G4int>( name , value ) );
      i_limits.insert( std::pair< std::string,std::pair< const G4int , const G4int> >( name, std::pair< const G4int , const G4int> ( lower_limit , upper_limit ) ) );
   } else {
            /*error*/
      issue_is_already_defined( name );
   }
   return status;
}

References i_defaults, i_limits, i_values, issue_is_already_defined(), and G4InuclParticleNames::name().

Field Documentation

b_defaults

std::map<std::string,const G4bool> G4HadronicDeveloperParameters::b_defaults

private

Definition at line 74 of file G4HadronicDeveloperParameters.hh.

Referenced by Dump(), get(), GetDefault(), Set(), and SetDefault().

b_values

std::map<std::string,G4bool> G4HadronicDeveloperParameters::b_values

private

Definition at line 73 of file G4HadronicDeveloperParameters.hh.

Referenced by Dump(), get(), Set(), and SetDefault().

defaults

std::map<std::string,const G4double> G4HadronicDeveloperParameters::defaults

private

Definition at line 81 of file G4HadronicDeveloperParameters.hh.

Referenced by Dump(), get(), GetDefault(), Set(), and SetDefault().

i_defaults

std::map<std::string,const G4int> G4HadronicDeveloperParameters::i_defaults

private

Definition at line 77 of file G4HadronicDeveloperParameters.hh.

Referenced by Dump(), get(), GetDefault(), Set(), and SetDefault().

i_limits

std::map<std::string,std::pair<const G4int,const G4int> > G4HadronicDeveloperParameters::i_limits

private

Definition at line 78 of file G4HadronicDeveloperParameters.hh.

Referenced by Dump(), Set(), and SetDefault().

i_values

std::map<std::string,G4int> G4HadronicDeveloperParameters::i_values

private

Definition at line 76 of file G4HadronicDeveloperParameters.hh.

Referenced by Dump(), get(), Set(), and SetDefault().

limits

std::map<std::string,std::pair<const G4double,const G4double> > G4HadronicDeveloperParameters::limits

private

Definition at line 82 of file G4HadronicDeveloperParameters.hh.

Referenced by Dump(), Set(), and SetDefault().

values

std::map<std::string,G4double> G4HadronicDeveloperParameters::values

private

Definition at line 80 of file G4HadronicDeveloperParameters.hh.

Referenced by Dump(), get(), Set(), and SetDefault().

---

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

• source/processes/hadronic/util/include/G4HadronicDeveloperParameters.hh
• source/processes/hadronic/util/src/G4HadronicDeveloperParameters.cc