G4FTFTuningsMessenger Class Reference

#include <G4FTFTuningsMessenger.hh>

Inheritance diagram for G4FTFTuningsMessenger:

Public Member Functions
	G4FTFTuningsMessenger ()
	~G4FTFTuningsMessenger ()
void	SetNewValue (G4UIcommand *command, G4String newValues) override
Public Member Functions inherited from G4UImessenger
	G4UImessenger ()=default
	G4UImessenger (const G4String &path, const G4String &dsc, G4bool commandsToBeBroadcasted=true)
virtual	~G4UImessenger ()
virtual G4String	GetCurrentValue (G4UIcommand *command)
G4bool	CommandsShouldBeInMaster () const

Additional Inherited Members
Protected Member Functions inherited from G4UImessenger
G4String	ItoS (G4int i)
G4String	LtoS (G4long l)
G4String	DtoS (G4double a)
G4String	BtoS (G4bool b)
G4int	StoI (const G4String &s)
G4long	StoL (const G4String &s)
G4double	StoD (const G4String &s)
G4bool	StoB (G4String s)
void	AddUIcommand (G4UIcommand *newCommand)
void	CreateDirectory (const G4String &path, const G4String &dsc, G4bool commandsToBeBroadcasted=true)
template<typename T >
T *	CreateCommand (const G4String &cname, const G4String &dsc)
Protected Attributes inherited from G4UImessenger
G4UIdirectory *	baseDir = nullptr
G4String	baseDirName = ""
G4bool	commandsShouldBeInMaster = false

Detailed Description

Definition at line 44 of file G4FTFTuningsMessenger.hh.

Constructor & Destructor Documentation

G4FTFTuningsMessenger()

G4FTFTuningsMessenger::G4FTFTuningsMessenger ( )

explicit

Definition at line 39 of file G4FTFTuningsMessenger.cc.

                                             {
  // These two commands select an alternative set of FTF parameters (called "tune"):
  // either via its integer index
  theFTFTuneIndexCmd = new G4UIcmdWithAnInteger( "/process/had/models/ftf/selectTuneByIndex", this );
  theFTFTuneIndexCmd->SetGuidance( "Select one FTF set of parameters (tune) via its index: 0 (default), 1, 2, ..." );
  theFTFTuneIndexCmd->SetParameterName( "indexFTFTune", true );
  theFTFTuneIndexCmd->SetDefaultValue( 0 );
  theFTFTuneIndexCmd->SetRange( "indexFTFTune>=0" );
  theFTFTuneIndexCmd->AvailableForStates( G4State_PreInit );
  // or via its string name
  theFTFTuneNameCmd = new G4UIcmdWithAString( "/process/had/models/ftf/selectTuneByName", this );
  theFTFTuneNameCmd->SetGuidance( "Select one FTF set of parametes (tune) via its name (string)." );
  theFTFTuneNameCmd->SetGuidance( " (default) is the default." );
  theFTFTuneNameCmd->SetParameterName( "nameFTFTune", true );
  theFTFTuneNameCmd->SetDefaultValue( "default" );
  theFTFTuneNameCmd->AvailableForStates( G4State_PreInit );
}

~G4FTFTuningsMessenger()

G4FTFTuningsMessenger::~G4FTFTuningsMessenger

(

)

Definition at line 58 of file G4FTFTuningsMessenger.cc.

                                              {
  delete theFTFTuneIndexCmd;
  delete theFTFTuneNameCmd;
}

Member Function Documentation

SetNewValue()

void G4FTFTuningsMessenger::SetNewValue ( G4UIcommand * command, G4String newValues )

overridevirtual

Reimplemented from G4UImessenger.

Definition at line 64 of file G4FTFTuningsMessenger.cc.

                                                                                  {
  if ( command == theFTFTuneIndexCmd  ||  command == theFTFTuneNameCmd ) {
    G4int index = -999;
    if ( command == theFTFTuneIndexCmd ) {
      G4int value = theFTFTuneIndexCmd->GetNewIntValue( newValues );
      if ( value >= 0  &&  value < G4FTFTunings::sNumberOfTunes ) {
        index = value;
      } else {
        G4ExceptionDescription ed;
        ed << "The FTF tune index=" << value << " value is wrong!";
        command->CommandFailed( ed );
      }
    } else {
      for ( G4int i = 0; i < G4FTFTunings::sNumberOfTunes; ++i ) {
        if ( newValues == G4FTFTunings::Instance()->GetTuneName(i) ) {
          index = i;
          break;
        }
      }
      if ( index < 0 ) {
        G4ExceptionDescription ed;
        ed << "The FTF tune name=" << newValues << " is not found!";
        command->CommandFailed( ed );
      }
    }
    if ( index >= 0 ) {
      // Tune applicability state: 0 means switched off; 1 means switched on.
      G4FTFTunings::Instance()->SetTuneApplicabilityState(index, 1);
    }
  }
}

---

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

• G4FTFTuningsMessenger.hh
• G4FTFTuningsMessenger.cc