G4NtupleMessenger Class Reference

#include <G4NtupleMessenger.hh>

Inheritance diagram for G4NtupleMessenger:

Collaboration diagram for G4NtupleMessenger:

Public Member Functions
	G4NtupleMessenger (G4VAnalysisManager *manager)
virtual	~G4NtupleMessenger ()
virtual void	SetNewValue (G4UIcommand *command, G4String value) final
Public Member Functions inherited from G4UImessenger
	G4UImessenger ()
	G4UImessenger (const G4String &path, const G4String &dsc, G4bool commandsToBeBroadcasted=true)
virtual	~G4UImessenger ()
virtual G4String	GetCurrentValue (G4UIcommand *command)
G4bool	operator== (const G4UImessenger &messenger) const
G4bool	CommandsShouldBeInMaster () const

Private Member Functions
void	SetActivationCmd ()
void	SetActivationToAllCmd ()

Private Attributes
G4VAnalysisManager *	fManager
	Associated class. More...
std::unique_ptr< G4UIdirectory >	fNtupleDir
std::unique_ptr< G4UIcommand >	fSetActivationCmd
std::unique_ptr< G4UIcmdWithABool >	fSetActivationAllCmd

Additional Inherited Members
Protected Member Functions inherited from G4UImessenger
G4String	ItoS (G4int i)
G4String	DtoS (G4double a)
G4String	BtoS (G4bool b)
G4int	StoI (G4String s)
G4double	StoD (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
G4String	baseDirName
G4bool	commandsShouldBeInMaster

Detailed Description

Definition at line 45 of file G4NtupleMessenger.hh.

Constructor & Destructor Documentation

G4NtupleMessenger()

G4NtupleMessenger::G4NtupleMessenger ( G4VAnalysisManager *  manager )

explicit

Definition at line 43 of file G4NtupleMessenger.cc.

  : G4UImessenger(),
    fManager(manager),
    fSetActivationCmd(nullptr),
    fSetActivationAllCmd(nullptr)
{
  fNtupleDir = G4Analysis::make_unique<G4UIdirectory>("/analysis/ntuple/");
  fNtupleDir->SetGuidance("ntuple control");
  
  SetActivationCmd();
  SetActivationToAllCmd();
}

Here is the call graph for this function:

~G4NtupleMessenger()

G4NtupleMessenger::~G4NtupleMessenger ( )

virtual

Definition at line 57 of file G4NtupleMessenger.cc.

{
}

Member Function Documentation

SetActivationCmd()

void G4NtupleMessenger::SetActivationCmd ( )

private

Definition at line 66 of file G4NtupleMessenger.cc.

{
  auto ntupleId = new G4UIparameter("NtupleId", 'i', false);
  ntupleId->SetGuidance("Ntuple id");
  ntupleId->SetParameterRange("NtupleId>=0");

  auto ntupleActivation = new G4UIparameter("NtupleActivation", 's', true);
  ntupleActivation->SetGuidance("Ntuple activation");
  ntupleActivation->SetDefaultValue("none");

  fSetActivationCmd = G4Analysis::make_unique<G4UIcommand>("/analysis/ntuple/setActivation", this);
  G4String guidance("Set activation for the ntuple of given id");

  fSetActivationCmd->SetGuidance(guidance);
  fSetActivationCmd->SetParameter(ntupleId);
  fSetActivationCmd->SetParameter(ntupleActivation);
  fSetActivationCmd->AvailableForStates(G4State_PreInit, G4State_Idle);
}  

Here is the caller graph for this function:

SetActivationToAllCmd()

void G4NtupleMessenger::SetActivationToAllCmd ( )

private

Definition at line 86 of file G4NtupleMessenger.cc.

{
  fSetActivationAllCmd 
    = G4Analysis::make_unique<G4UIcmdWithABool>("/analysis/ntuple/setActivationToAll", this);
  G4String guidance("Set activation to all ntuples");
  fSetActivationAllCmd->SetGuidance(guidance);
  fSetActivationAllCmd->SetParameterName("AllNtupleActivation",false);
}  

Here is the caller graph for this function:

SetNewValue()

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

finalvirtual

Reimplemented from G4UImessenger.

Definition at line 100 of file G4NtupleMessenger.cc.

{
  if ( command == fSetActivationCmd.get() ) {
    // tokenize parameters in a vector
    std::vector<G4String> parameters;
    G4Analysis::Tokenize(newValues, parameters);
    // check consistency
    if ( G4int(parameters.size()) == command->GetParameterEntries() ) {
      auto counter = 0;
      auto id = G4UIcommand::ConvertToInt(parameters[counter++]);
      auto activation = G4UIcommand::ConvertToBool(parameters[counter++]);
      fManager->SetNtupleActivation(id, activation);     
    }
    else {
      // Should never happen but let's check anyway for consistency
      G4ExceptionDescription description;
      description 
        << "Got wrong number of \"" << command->GetCommandName() 
        << "\" parameters: " << parameters.size()
        << " instead of " << command->GetParameterEntries() 
        << " expected" << G4endl;
      G4Exception("G4NtupleMessenger::SetNewValue",
                  "Analysis_W013", JustWarning, description);
    }  
  }
  else if ( command == fSetActivationAllCmd.get() ) {
    auto activation = fSetActivationAllCmd->GetNewBoolValue(newValues);
    fManager->SetNtupleActivation(activation);
  }  
}  

Here is the call graph for this function:

Member Data Documentation

fManager

G4VAnalysisManager* G4NtupleMessenger::fManager

private

Associated class.

Definition at line 58 of file G4NtupleMessenger.hh.

fNtupleDir

std::unique_ptr<G4UIdirectory> G4NtupleMessenger::fNtupleDir

private

Definition at line 60 of file G4NtupleMessenger.hh.

fSetActivationAllCmd

std::unique_ptr<G4UIcmdWithABool> G4NtupleMessenger::fSetActivationAllCmd

private

Definition at line 62 of file G4NtupleMessenger.hh.

fSetActivationCmd

std::unique_ptr<G4UIcommand> G4NtupleMessenger::fSetActivationCmd

private

Definition at line 61 of file G4NtupleMessenger.hh.

---

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

• G4NtupleMessenger.hh
• G4NtupleMessenger.cc