#include <G4AnalysisMessenger.hh>

Inheritance diagram for G4AnalysisMessenger:

Public Member Functions
G4bool	CommandsShouldBeInMaster () const

	G4AnalysisMessenger ()=delete

	G4AnalysisMessenger (G4VAnalysisManager *manager)

virtual G4String	GetCurrentValue (G4UIcommand *command)

G4bool	operator!= (const G4UImessenger &messenger) const

G4bool	operator== (const G4UImessenger &messenger) const

void	SetH1HnManager (G4HnManager &h1HnManager)

void	SetH2HnManager (G4HnManager &h2HnManager)

void	SetH3HnManager (G4HnManager &h3HnManager)

virtual void	SetNewValue (G4UIcommand *command, G4String value) final

void	SetP1HnManager (G4HnManager &p1HnManager)

void	SetP2HnManager (G4HnManager &p2HnManager)

virtual	~G4AnalysisMessenger ()

Protected Member Functions
void	AddUIcommand (G4UIcommand *newCommand)

G4String	BtoS (G4bool b)

template<typename T >
T *	CreateCommand (const G4String &cname, const G4String &dsc)

void	CreateDirectory (const G4String &path, const G4String &dsc, G4bool commandsToBeBroadcasted=true)

G4String	DtoS (G4double a)

G4String	ItoS (G4int i)

G4bool	StoB (G4String s)

G4double	StoD (G4String s)

G4int	StoI (G4String s)

G4long	StoL (G4String s)

Protected Attributes
G4UIdirectory *	baseDir = nullptr

G4String	baseDirName = ""

G4bool	commandsShouldBeInMaster = false

Private Attributes
std::unique_ptr< G4UIdirectory >	fAnalysisDir

std::unique_ptr< G4UIcmdWithAnInteger >	fCompressionCmd

std::unique_ptr< G4FileMessenger >	fFileMessenger

std::unique_ptr< G4HnMessenger >	fH1HnMessenger

std::unique_ptr< G4H1Messenger >	fH1Messenger

std::unique_ptr< G4HnMessenger >	fH2HnMessenger

std::unique_ptr< G4H2Messenger >	fH2Messenger

std::unique_ptr< G4HnMessenger >	fH3HnMessenger

std::unique_ptr< G4H3Messenger >	fH3Messenger

G4VAnalysisManager *	fManager { nullptr }
	Associated class. More...

std::unique_ptr< G4NtupleMessenger >	fNtupleMessenger

std::unique_ptr< G4HnMessenger >	fP1HnMessenger

std::unique_ptr< G4P1Messenger >	fP1Messenger

std::unique_ptr< G4HnMessenger >	fP2HnMessenger

std::unique_ptr< G4P2Messenger >	fP2Messenger

std::unique_ptr< G4UIcmdWithABool >	fSetActivationCmd

std::unique_ptr< G4UIcmdWithAnInteger >	fVerboseCmd

Detailed Description

Definition at line 57 of file G4AnalysisMessenger.hh.

Constructor & Destructor Documentation

◆ G4AnalysisMessenger() [1/2]

G4AnalysisMessenger::G4AnalysisMessenger ( G4VAnalysisManager * manager )

explicit

Definition at line 47 of file G4AnalysisMessenger.cc.

  : G4UImessenger(),
    fManager(manager)
{
  fAnalysisDir = std::make_unique<G4UIdirectory>("/analysis/");
  fAnalysisDir->SetGuidance("analysis control");
 
  fSetActivationCmd = std::make_unique<G4UIcmdWithABool>("/analysis/setActivation",this);
  G4String guidance = "Set activation. \n";
  guidance += "When this option is enabled, only the histograms marked as activated\n";
  guidance += "are returned, filled or saved on file.\n";
  guidance += "No warning is issued when Get or Fill is called on inactive histogram.";
  fSetActivationCmd->SetGuidance(guidance);
  fSetActivationCmd->SetParameterName("Activation",false);
 
  fVerboseCmd = std::make_unique<G4UIcmdWithAnInteger>("/analysis/verbose",this);
  fVerboseCmd->SetGuidance("Set verbose level");
  fVerboseCmd->SetParameterName("VerboseLevel",false);
  fVerboseCmd->SetRange("VerboseLevel>=0 && VerboseLevel<=4");
 
  fCompressionCmd = std::make_unique<G4UIcmdWithAnInteger>("/analysis/compression",this);
  fCompressionCmd->SetGuidance("Set compression level");
  fCompressionCmd->SetParameterName("CompressionLevel",false);
  fCompressionCmd->SetRange("CompressionLevel>=0 && CompressionLevel<=4");
 
  fFileMessenger = std::make_unique<G4FileMessenger>(manager);
  fH1Messenger = std::make_unique<G4H1Messenger>(manager);
  fH2Messenger = std::make_unique<G4H2Messenger>(manager);
  fH3Messenger = std::make_unique<G4H3Messenger>(manager);
  fP1Messenger = std::make_unique<G4P1Messenger>(manager);
  fP2Messenger = std::make_unique<G4P2Messenger>(manager);
  fNtupleMessenger = std::make_unique<G4NtupleMessenger>(manager);
}

References fAnalysisDir, fCompressionCmd, fFileMessenger, fH1Messenger, fH2Messenger, fH3Messenger, fNtupleMessenger, fP1Messenger, fP2Messenger, fSetActivationCmd, and fVerboseCmd.

◆ G4AnalysisMessenger() [2/2]

G4AnalysisMessenger::G4AnalysisMessenger ( )

delete

◆ ~G4AnalysisMessenger()

G4AnalysisMessenger::~G4AnalysisMessenger ( )

virtualdefault

Member Function Documentation

◆ AddUIcommand()

void G4UImessenger::AddUIcommand ( G4UIcommand * newCommand )

protectedinherited

Definition at line 149 of file G4UImessenger.cc.

{
  G4cerr << "Warning : Old style definition of G4UIcommand <"
         << newCommand->GetCommandPath() << ">." << G4endl;
}

References G4cerr, G4endl, and G4UIcommand::GetCommandPath().

◆ BtoS()

G4String G4UImessenger::BtoS ( G4bool b )

protectedinherited

Definition at line 98 of file G4UImessenger.cc.

{
  G4String vl = "0";
  if(b)
    vl = "true";
  return vl;
}

◆ CommandsShouldBeInMaster()

G4bool G4UImessenger::CommandsShouldBeInMaster ( ) const

inlineinherited

Definition at line 77 of file G4UImessenger.hh.

    {
      return commandsShouldBeInMaster;
    }

References G4UImessenger::commandsShouldBeInMaster.

Referenced by G4UIcommand::G4UIcommandCommonConstructorCode().

◆ CreateCommand()

template<typename T >

T * G4UImessenger::CreateCommand	(	const G4String &	cname,
		const G4String &	dsc
	)

protectedinherited

Definition at line 110 of file G4UImessenger.hh.

{
  G4String path;
  if(cname[0] != '/')
  {
    path = baseDirName + cname;
    if(path[0] != '/')
      path = "/" + path;
  }
 
  T* command = new T(path.c_str(), this);
  command->SetGuidance(dsc.c_str());
 
  return command;
}

References G4UImessenger::baseDirName.

◆ CreateDirectory()

void G4UImessenger::CreateDirectory	(	const G4String &	path,
		const G4String &	dsc,
		G4bool	commandsToBeBroadcasted = `true`
	)

protectedinherited

Definition at line 156 of file G4UImessenger.cc.

{
  G4UImanager* ui = G4UImanager::GetUIpointer();
 
  G4String fullpath = path;
  if(fullpath.back() != '/')
    fullpath.append("/");
 
  G4UIcommandTree* tree = ui->GetTree()->FindCommandTree(fullpath.c_str());
  if(tree != nullptr)
  {
    baseDirName = tree->GetPathName();
  }
  else
  {
    baseDir     = new G4UIdirectory(fullpath.c_str(), commandsToBeBroadcasted);
    baseDirName = fullpath;
    baseDir->SetGuidance(dsc.c_str());
  }
}

References G4UImessenger::baseDir, G4UImessenger::baseDirName, G4UIcommandTree::FindCommandTree(), G4UIcommandTree::GetPathName(), G4UImanager::GetTree(), G4UImanager::GetUIpointer(), and G4UIcommand::SetGuidance().

Referenced by G4MoleculeShootMessenger::G4MoleculeShootMessenger(), and G4UImessenger::G4UImessenger().

◆ DtoS()

G4String G4UImessenger::DtoS ( G4double a )

protectedinherited

Definition at line 90 of file G4UImessenger.cc.

{
  std::ostringstream os;
  os << a;
  return G4String(os.str());
}

Referenced by G4ScoreQuantityMessenger::FilterCommands(), and G4UIcontrolMessenger::SetNewValue().

◆ GetCurrentValue()

G4String G4UImessenger::GetCurrentValue ( G4UIcommand * command )

virtualinherited

Definition at line 58 of file G4UImessenger.cc.

{
  G4String nullString;
  return nullString;
}

Referenced by G4UIcommand::DoIt(), and G4UIcommand::GetCurrentValue().

◆ ItoS()

G4String G4UImessenger::ItoS ( G4int i )

protectedinherited

Definition at line 82 of file G4UImessenger.cc.

{
  std::ostringstream os;
  os << i;
  return G4String(os.str());
}

Referenced by G4GenericMessenger::DeclareMethod(), and G4ParticleGunMessenger::GetCurrentValue().

◆ operator!=()

G4bool G4UImessenger::operator!= ( const G4UImessenger & messenger ) const

inherited

Definition at line 76 of file G4UImessenger.cc.

{
  return this != &messenger;
}

◆ operator==()

G4bool G4UImessenger::operator== ( const G4UImessenger & messenger ) const

inherited

Definition at line 70 of file G4UImessenger.cc.

{
  return this == &messenger;
}

◆ SetH1HnManager()

void G4AnalysisMessenger::SetH1HnManager ( G4HnManager & h1HnManager )

Definition at line 89 of file G4AnalysisMessenger.cc.

{
  fH1HnMessenger = std::make_unique<G4HnMessenger>(h1HnManager);
}

References fH1HnMessenger.

◆ SetH2HnManager()

void G4AnalysisMessenger::SetH2HnManager ( G4HnManager & h2HnManager )

Definition at line 95 of file G4AnalysisMessenger.cc.

{
  fH2HnMessenger = std::make_unique<G4HnMessenger>(h2HnManager);
}

References fH2HnMessenger.

◆ SetH3HnManager()

void G4AnalysisMessenger::SetH3HnManager ( G4HnManager & h3HnManager )

Definition at line 101 of file G4AnalysisMessenger.cc.

{
  fH3HnMessenger = std::make_unique<G4HnMessenger>(h3HnManager);
}

References fH3HnMessenger.

◆ SetNewValue()

void G4AnalysisMessenger::SetNewValue	(	G4UIcommand *	command,
		G4String	value
	)

finalvirtual

Reimplemented from G4UImessenger.

Definition at line 119 of file G4AnalysisMessenger.cc.

{
  if ( command == fSetActivationCmd.get() ) {
    fManager->SetActivation(fSetActivationCmd->GetNewBoolValue(newValues));
  }
  else if ( command == fVerboseCmd.get() ) {
    fManager->SetVerboseLevel(fVerboseCmd->GetNewIntValue(newValues));
  }
  else if ( command == fCompressionCmd.get() ) {
    fManager->SetCompressionLevel(fCompressionCmd->GetNewIntValue(newValues));
  }
}

References fCompressionCmd, fManager, fSetActivationCmd, fVerboseCmd, G4VAnalysisManager::SetActivation(), G4VAnalysisManager::SetCompressionLevel(), and G4VAnalysisManager::SetVerboseLevel().

◆ SetP1HnManager()

void G4AnalysisMessenger::SetP1HnManager ( G4HnManager & p1HnManager )

Definition at line 107 of file G4AnalysisMessenger.cc.

{
  fP1HnMessenger = std::make_unique<G4HnMessenger>(p1HnManager);
}

References fP1HnMessenger.

◆ SetP2HnManager()

void G4AnalysisMessenger::SetP2HnManager ( G4HnManager & p2HnManager )

Definition at line 113 of file G4AnalysisMessenger.cc.

{
  fP2HnMessenger = std::make_unique<G4HnMessenger>(p2HnManager);
}

References fP2HnMessenger.

◆ StoB()

G4bool G4UImessenger::StoB ( G4String s )

protectedinherited

Definition at line 137 of file G4UImessenger.cc.

{
  G4String v = G4StrUtil::to_upper_copy(str);
  G4bool vl = false;
  if(v == "Y" || v == "YES" || v == "1" || v == "T" || v == "TRUE")
  {
    vl = true;
  }
  return vl;
}

References G4StrUtil::to_upper_copy().

Referenced by G4LocalThreadCoutMessenger::SetNewValue(), G4CascadeParamMessenger::SetNewValue(), G4ScoreQuantityMessenger::SetNewValue(), and G4ScoringMessenger::SetNewValue().

◆ StoD()

G4double G4UImessenger::StoD ( G4String s )

protectedinherited

Definition at line 127 of file G4UImessenger.cc.

{
  G4double vl;
  const char* t = str;
  std::istringstream is(t);
  is >> vl;
  return vl;
}

Referenced by G4ScoreQuantityMessenger::FParticleWithEnergyCommand(), G4ParticleGunMessenger::IonCommand(), G4GeneralParticleSourceMessenger::IonCommand(), G4UIcontrolMessenger::SetNewValue(), G4MatScanMessenger::SetNewValue(), G4VisCommandSceneAddText::SetNewValue(), G4VisCommandSceneAddText2D::SetNewValue(), G4ScoreQuantityMessenger::SetNewValue(), G4ScoringMessenger::SetNewValue(), and G4PolarizationMessenger::SetNewValue().

◆ StoI()

G4int G4UImessenger::StoI ( G4String s )

protectedinherited

Definition at line 107 of file G4UImessenger.cc.

{
  G4int vl;
  const char* t = str;
  std::istringstream is(t);
  is >> vl;
  return vl;
}

Referenced by G4ScoringMessenger::Fill1D(), G4ParticleGunMessenger::IonCommand(), G4GeneralParticleSourceMessenger::IonCommand(), G4ParticleGunMessenger::IonLevelCommand(), G4GeneralParticleSourceMessenger::IonLvlCommand(), G4ScoringMessenger::MeshBinCommand(), G4LocalThreadCoutMessenger::SetNewValue(), G4UIcontrolMessenger::SetNewValue(), G4MatScanMessenger::SetNewValue(), G4GMocrenMessenger::SetNewValue(), G4ScoreQuantityMessenger::SetNewValue(), and G4ScoringMessenger::SetNewValue().

◆ StoL()

G4long G4UImessenger::StoL ( G4String s )

protectedinherited

Definition at line 117 of file G4UImessenger.cc.

{
  G4long vl;
  const char* t = str;
  std::istringstream is(t);
  is >> vl;
  return vl;
}

Referenced by G4RunMessenger::SetNewValue().

Field Documentation

◆ baseDir

G4UIdirectory* G4UImessenger::baseDir = nullptr

protectedinherited

Definition at line 102 of file G4UImessenger.hh.

Referenced by G4UImessenger::CreateDirectory(), and G4UImessenger::~G4UImessenger().

◆ baseDirName

G4String G4UImessenger::baseDirName = ""

protectedinherited

Definition at line 103 of file G4UImessenger.hh.

Referenced by G4UImessenger::CreateCommand(), and G4UImessenger::CreateDirectory().

◆ commandsShouldBeInMaster

G4bool G4UImessenger::commandsShouldBeInMaster = false

protectedinherited

Definition at line 104 of file G4UImessenger.hh.

Referenced by G4UImessenger::CommandsShouldBeInMaster(), and G4GeneralParticleSourceMessenger::G4GeneralParticleSourceMessenger().

◆ fAnalysisDir

std::unique_ptr<G4UIdirectory> G4AnalysisMessenger::fAnalysisDir

private

Definition at line 90 of file G4AnalysisMessenger.hh.

Referenced by G4AnalysisMessenger().

◆ fCompressionCmd

std::unique_ptr<G4UIcmdWithAnInteger> G4AnalysisMessenger::fCompressionCmd

private

Definition at line 93 of file G4AnalysisMessenger.hh.

Referenced by G4AnalysisMessenger(), and SetNewValue().

◆ fFileMessenger

std::unique_ptr<G4FileMessenger> G4AnalysisMessenger::fFileMessenger

private

Definition at line 77 of file G4AnalysisMessenger.hh.

Referenced by G4AnalysisMessenger().

◆ fH1HnMessenger

std::unique_ptr<G4HnMessenger> G4AnalysisMessenger::fH1HnMessenger

private

Definition at line 84 of file G4AnalysisMessenger.hh.

Referenced by SetH1HnManager().

◆ fH1Messenger

std::unique_ptr<G4H1Messenger> G4AnalysisMessenger::fH1Messenger

private

Definition at line 78 of file G4AnalysisMessenger.hh.

Referenced by G4AnalysisMessenger().

◆ fH2HnMessenger

std::unique_ptr<G4HnMessenger> G4AnalysisMessenger::fH2HnMessenger

private

Definition at line 85 of file G4AnalysisMessenger.hh.

Referenced by SetH2HnManager().

◆ fH2Messenger

std::unique_ptr<G4H2Messenger> G4AnalysisMessenger::fH2Messenger

private

Definition at line 79 of file G4AnalysisMessenger.hh.

Referenced by G4AnalysisMessenger().

◆ fH3HnMessenger

std::unique_ptr<G4HnMessenger> G4AnalysisMessenger::fH3HnMessenger

private

Definition at line 86 of file G4AnalysisMessenger.hh.

Referenced by SetH3HnManager().

◆ fH3Messenger

std::unique_ptr<G4H3Messenger> G4AnalysisMessenger::fH3Messenger

private

Definition at line 80 of file G4AnalysisMessenger.hh.

Referenced by G4AnalysisMessenger().

◆ fManager

G4VAnalysisManager* G4AnalysisMessenger::fManager { nullptr }

private

Associated class.

Definition at line 76 of file G4AnalysisMessenger.hh.

Referenced by SetNewValue().

◆ fNtupleMessenger

std::unique_ptr<G4NtupleMessenger> G4AnalysisMessenger::fNtupleMessenger

private

Definition at line 83 of file G4AnalysisMessenger.hh.

Referenced by G4AnalysisMessenger().

◆ fP1HnMessenger

std::unique_ptr<G4HnMessenger> G4AnalysisMessenger::fP1HnMessenger

private

Definition at line 87 of file G4AnalysisMessenger.hh.

Referenced by SetP1HnManager().

◆ fP1Messenger

std::unique_ptr<G4P1Messenger> G4AnalysisMessenger::fP1Messenger

private

Definition at line 81 of file G4AnalysisMessenger.hh.

Referenced by G4AnalysisMessenger().

◆ fP2HnMessenger

std::unique_ptr<G4HnMessenger> G4AnalysisMessenger::fP2HnMessenger

private

Definition at line 88 of file G4AnalysisMessenger.hh.

Referenced by SetP2HnManager().

◆ fP2Messenger

std::unique_ptr<G4P2Messenger> G4AnalysisMessenger::fP2Messenger

private

Definition at line 82 of file G4AnalysisMessenger.hh.

Referenced by G4AnalysisMessenger().

◆ fSetActivationCmd

std::unique_ptr<G4UIcmdWithABool> G4AnalysisMessenger::fSetActivationCmd

private

Definition at line 91 of file G4AnalysisMessenger.hh.

Referenced by G4AnalysisMessenger(), and SetNewValue().

◆ fVerboseCmd

std::unique_ptr<G4UIcmdWithAnInteger> G4AnalysisMessenger::fVerboseCmd

private

Definition at line 92 of file G4AnalysisMessenger.hh.

Referenced by G4AnalysisMessenger(), and SetNewValue().

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

source/analysis/management/include/G4AnalysisMessenger.hh
source/analysis/management/src/G4AnalysisMessenger.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ G4AnalysisMessenger() [1/2]

◆ G4AnalysisMessenger() [2/2]

◆ ~G4AnalysisMessenger()

Member Function Documentation

◆ AddUIcommand()

◆ BtoS()

◆ CommandsShouldBeInMaster()

◆ CreateCommand()

◆ CreateDirectory()

◆ DtoS()

◆ GetCurrentValue()

◆ ItoS()

◆ operator!=()

◆ operator==()

◆ SetH1HnManager()

◆ SetH2HnManager()

◆ SetH3HnManager()

◆ SetNewValue()

◆ SetP1HnManager()

◆ SetP2HnManager()

◆ StoB()

◆ StoD()

◆ StoI()

◆ StoL()

Field Documentation

◆ baseDir

◆ baseDirName

◆ commandsShouldBeInMaster

◆ fAnalysisDir

◆ fCompressionCmd

◆ fFileMessenger

◆ fH1HnMessenger

◆ fH1Messenger

◆ fH2HnMessenger

◆ fH2Messenger

◆ fH3HnMessenger

◆ fH3Messenger

◆ fManager

◆ fNtupleMessenger

◆ fP1HnMessenger

◆ fP1Messenger

◆ fP2HnMessenger

◆ fP2Messenger

◆ fSetActivationCmd

◆ fVerboseCmd