G4HnMessenger Class Reference

#include <G4HnMessenger.hh>

Inheritance diagram for G4HnMessenger:

Collaboration diagram for G4HnMessenger:

Public Member Functions
	G4HnMessenger (G4HnManager &manager)
virtual	~G4HnMessenger ()
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	SetHnAsciiCmd ()
void	SetHnActivationCmd ()
void	SetHnActivationToAllCmd ()
void	SetHnPlottingCmd ()
void	SetHnPlottingToAllCmd ()

Private Attributes
G4HnManager &	fManager
	Associated class. More...
std::unique_ptr< G4AnalysisMessengerHelper >	fHelper
std::unique_ptr< G4UIcmdWithAnInteger >	fSetHnAsciiCmd
std::unique_ptr< G4UIcommand >	fSetHnActivationCmd
std::unique_ptr< G4UIcmdWithABool >	fSetHnActivationAllCmd
std::unique_ptr< G4UIcommand >	fSetHnPlottingCmd
std::unique_ptr< G4UIcmdWithABool >	fSetHnPlottingAllCmd

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 47 of file G4HnMessenger.hh.

Constructor & Destructor Documentation

G4HnMessenger()

G4HnMessenger::G4HnMessenger ( G4HnManager &  manager )

explicit

Definition at line 44 of file G4HnMessenger.cc.

  : G4UImessenger(),
    fManager(manager),
    fHelper(nullptr),
    fSetHnAsciiCmd(nullptr), 
    fSetHnActivationCmd(nullptr),
    fSetHnActivationAllCmd(nullptr),
    fSetHnPlottingCmd(nullptr),
    fSetHnPlottingAllCmd(nullptr)
{ 
  G4String hnType = fManager.GetHnType();
  hnType.toLower();
  fHelper = G4Analysis::make_unique<G4AnalysisMessengerHelper>(hnType);

  SetHnAsciiCmd();
  SetHnActivationCmd();
  SetHnActivationToAllCmd();
  SetHnPlottingCmd();
  SetHnPlottingToAllCmd();
}

Here is the call graph for this function:

~G4HnMessenger()

G4HnMessenger::~G4HnMessenger ( )

virtual

Definition at line 66 of file G4HnMessenger.cc.

{}

Member Function Documentation

SetHnActivationCmd()

void G4HnMessenger::SetHnActivationCmd ( )

private

Definition at line 87 of file G4HnMessenger.cc.

{
  auto hnId = new G4UIparameter("id", 'i', false);
  hnId->SetGuidance(fHelper->Update("OBJECT id"));
  hnId->SetParameterRange("id>=0");

  auto hnActivation = new G4UIparameter("hnActivation", 's', true);
  hnActivation->SetGuidance(fHelper->Update("OBJECT activation"));
  hnActivation->SetDefaultValue("none");

  fSetHnActivationCmd 
    = G4Analysis::make_unique<G4UIcommand>(fHelper->Update("/analysis/HNTYPE_/setActivation"), this);
  fSetHnActivationCmd->SetGuidance(
      fHelper->Update("Set activation for the NDIM_D LOBJECT of given id"));
  fSetHnActivationCmd->SetParameter(hnId);
  fSetHnActivationCmd->SetParameter(hnActivation);
  fSetHnActivationCmd->AvailableForStates(G4State_PreInit, G4State_Idle);
}  

Here is the caller graph for this function:

SetHnActivationToAllCmd()

void G4HnMessenger::SetHnActivationToAllCmd ( )

private

Definition at line 107 of file G4HnMessenger.cc.

{
  fSetHnActivationAllCmd 
    = G4Analysis::make_unique<G4UIcmdWithABool>(fHelper->Update("/analysis/HNTYPE_/setActivationToAll"), this);
  fSetHnActivationAllCmd->SetGuidance(
    fHelper->Update("Set activation to all NDIM_D LOBJECTs"));
  fSetHnActivationAllCmd->SetParameterName("Activation",false);
}  

Here is the caller graph for this function:

SetHnAsciiCmd()

void G4HnMessenger::SetHnAsciiCmd ( )

private

Definition at line 74 of file G4HnMessenger.cc.

{
  fSetHnAsciiCmd
    = G4Analysis::make_unique<G4UIcmdWithAnInteger>(fHelper->Update("/analysis/HNTYPE_/setAscii"), this);
  fSetHnAsciiCmd->SetGuidance(
    fHelper->Update("Print NDIM_D LOBJECT of given id on ascii file."));

  fSetHnAsciiCmd->SetParameterName("id",false);
  fSetHnAsciiCmd->SetRange("id>=0");
  fSetHnAsciiCmd->AvailableForStates(G4State_PreInit, G4State_Idle);
}

Here is the caller graph for this function:

SetHnPlottingCmd()

void G4HnMessenger::SetHnPlottingCmd ( )

private

Definition at line 117 of file G4HnMessenger.cc.

{
  auto hnId = new G4UIparameter("id", 'i', false);
  hnId->SetGuidance(fHelper->Update("OBJECT id"));
  hnId->SetParameterRange("id>=0");

  auto hnPlotting = new G4UIparameter("hnPlotting", 's', true);
  hnPlotting->SetGuidance(fHelper->Update("(In)Activate OBJECT plotting"));
  hnPlotting->SetDefaultValue("none");

  fSetHnPlottingCmd 
    = G4Analysis::make_unique<G4UIcommand>(fHelper->Update("/analysis/HNTYPE_/setPlotting"), this);
  fSetHnPlottingCmd->SetGuidance(
      fHelper->Update("(In)Activate batch plotting of the NDIM_D LOBJECT of given id"));
  fSetHnPlottingCmd->SetParameter(hnId);
  fSetHnPlottingCmd->SetParameter(hnPlotting);
  fSetHnPlottingCmd->AvailableForStates(G4State_PreInit, G4State_Idle);
}  

Here is the caller graph for this function:

SetHnPlottingToAllCmd()

void G4HnMessenger::SetHnPlottingToAllCmd ( )

private

Definition at line 137 of file G4HnMessenger.cc.

{
  fSetHnPlottingAllCmd 
    = G4Analysis::make_unique<G4UIcmdWithABool>(fHelper->Update("/analysis/HNTYPE_/setPlottingToAll"), this);
  fSetHnPlottingAllCmd->SetGuidance(
    fHelper->Update("(In)Activate batch plotting of all NDIM_D LOBJECTs"));
  fSetHnPlottingAllCmd->SetParameterName("Plotting",false);
}  

Here is the caller graph for this function:

SetNewValue()

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

finalvirtual

Reimplemented from G4UImessenger.

Definition at line 151 of file G4HnMessenger.cc.

{
  if ( command == fSetHnAsciiCmd.get() ) { 
    auto id = fSetHnAsciiCmd->GetNewIntValue(newValues);
    fManager.SetAscii(id, true); 
  }      
  else if ( command == fSetHnActivationCmd.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.SetActivation(id, activation);     
    }
    else {
      // Should never happen but let's check anyway for consistency
      fHelper->WarnAboutParameters(command, parameters.size());
    }  
  }
  else if ( command == fSetHnActivationAllCmd.get() ) { 
    auto activation = fSetHnActivationAllCmd->GetNewBoolValue(newValues);
    fManager.SetActivation(activation);
  }  
  else if ( command == fSetHnPlottingCmd.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.SetPlotting(id, activation);     
    }
    else {
      // Should never happen but let's check anyway for consistency
      fHelper->WarnAboutParameters(command, parameters.size());
    }  
  }
  else if ( command == fSetHnPlottingAllCmd.get() ) { 
    auto activation = fSetHnPlottingAllCmd->GetNewBoolValue(newValues);
    fManager.SetPlotting(activation);
  }  
}  

Here is the call graph for this function:

Member Data Documentation

fHelper

std::unique_ptr<G4AnalysisMessengerHelper> G4HnMessenger::fHelper

private

Definition at line 64 of file G4HnMessenger.hh.

fManager

G4HnManager& G4HnMessenger::fManager

private

Associated class.

Definition at line 63 of file G4HnMessenger.hh.

fSetHnActivationAllCmd

std::unique_ptr<G4UIcmdWithABool> G4HnMessenger::fSetHnActivationAllCmd

private

Definition at line 68 of file G4HnMessenger.hh.

fSetHnActivationCmd

std::unique_ptr<G4UIcommand> G4HnMessenger::fSetHnActivationCmd

private

Definition at line 67 of file G4HnMessenger.hh.

fSetHnAsciiCmd

std::unique_ptr<G4UIcmdWithAnInteger> G4HnMessenger::fSetHnAsciiCmd

private

Definition at line 66 of file G4HnMessenger.hh.

fSetHnPlottingAllCmd

std::unique_ptr<G4UIcmdWithABool> G4HnMessenger::fSetHnPlottingAllCmd

private

Definition at line 70 of file G4HnMessenger.hh.

fSetHnPlottingCmd

std::unique_ptr<G4UIcommand> G4HnMessenger::fSetHnPlottingCmd

private

Definition at line 69 of file G4HnMessenger.hh.

---

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

• G4HnMessenger.hh
• G4HnMessenger.cc