G4AnalysisMessengerHelper Class Reference

#include <G4AnalysisMessengerHelper.hh>

Collaboration diagram for G4AnalysisMessengerHelper:

Classes
struct	BinData
struct	ValueData

Public Member Functions
	G4AnalysisMessengerHelper (const G4String &hnType)
	~G4AnalysisMessengerHelper ()
std::unique_ptr< G4UIdirectory >	CreateHnDirectory () const
std::unique_ptr< G4UIcommand >	CreateSetTitleCommand (G4UImessenger *messenger) const
std::unique_ptr< G4UIcommand >	CreateSetBinsCommand (const G4String &axis, G4UImessenger *messenger) const
std::unique_ptr< G4UIcommand >	CreateSetValuesCommand (const G4String &axis, G4UImessenger *messenger) const
std::unique_ptr< G4UIcommand >	CreateSetAxisCommand (const G4String &axis, G4UImessenger *messenger) const
void	GetBinData (BinData &data, std::vector< G4String > &parameters, G4int &counter) const
void	GetValueData (ValueData &data, std::vector< G4String > &parameters, G4int &counter) const
void	WarnAboutParameters (G4UIcommand *command, G4int nofParameters) const
void	WarnAboutSetCommands () const

Private Member Functions
G4String	Update (const G4String &str, const G4String &axis="") const

Private Attributes
G4String	fHnType

Friends
class	G4HnMessenger

Detailed Description

Definition at line 45 of file G4AnalysisMessengerHelper.hh.

Constructor & Destructor Documentation

G4AnalysisMessengerHelper()

G4AnalysisMessengerHelper::G4AnalysisMessengerHelper ( const G4String &  hnType )

explicit

Definition at line 79 of file G4AnalysisMessengerHelper.cc.

  : fHnType(hnType)
{}

~G4AnalysisMessengerHelper()

G4AnalysisMessengerHelper::~G4AnalysisMessengerHelper

(

)

Definition at line 84 of file G4AnalysisMessengerHelper.cc.

{}

Member Function Documentation

CreateHnDirectory()

std::unique_ptr< G4UIdirectory > G4AnalysisMessengerHelper::CreateHnDirectory

(

)

const

Definition at line 134 of file G4AnalysisMessengerHelper.cc.

{
  std::unique_ptr<G4UIdirectory> directory(new G4UIdirectory(Update("/analysis/HNTYPE_/")));
  directory->SetGuidance(Update("NDIM_D LOBJECT control"));
  return directory;
}

Here is the call graph for this function:

CreateSetAxisCommand()

std::unique_ptr< G4UIcommand > G4AnalysisMessengerHelper::CreateSetAxisCommand	(	const G4String &	axis,
		G4UImessenger *	messenger
	)		const

Definition at line 259 of file G4AnalysisMessengerHelper.cc.

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

  auto parAxis = new G4UIparameter("axis", 's', true);
  parAxis->SetGuidance(Update("Histogram AXIS-axis title", axis));
  parAxis->SetDefaultValue("none");

  std::unique_ptr<G4UIcommand> command( 
    new G4UIcommand(Update("/analysis/HNTYPE_/setUAXISaxis", axis), messenger));
  command->SetGuidance(Update("Set AXIS-axis title for the NDIM_D LOBJECT of given id", axis));
  command->SetParameter(parId);
  command->SetParameter(parAxis);
  command->AvailableForStates(G4State_PreInit, G4State_Idle);

  return command;
}

Here is the call graph for this function:

CreateSetBinsCommand()

std::unique_ptr< G4UIcommand > G4AnalysisMessengerHelper::CreateSetBinsCommand	(	const G4String &	axis,
		G4UImessenger *	messenger
	)		const

Definition at line 166 of file G4AnalysisMessengerHelper.cc.

{
  auto parId = new G4UIparameter("id", 'i', false);
  parId->SetGuidance(Update( "OBJECT id"));
  parId->SetParameterRange("id>=0");
  
  auto parNbins = new G4UIparameter("nbins", 'i', false);
  parNbins->SetGuidance("Number of bins");
  
  auto parValMin = new G4UIparameter("valMin", 'd', false);
  parValMin->SetGuidance("Minimum value, expressed in unit");
  
  auto parValMax = new G4UIparameter("valMax", 'd', false);
  parValMax->SetGuidance("Maximum value, expressed in unit");
  
  auto parValUnit = new G4UIparameter("valUnit", 's', true);
  parValUnit->SetGuidance("The unit applied to filled values and valMin, valMax");
  parValUnit->SetDefaultValue("none");

  auto parValFcn = new G4UIparameter("valFcn", 's', true);
  parValFcn->SetParameterCandidates("log log10 exp none");
  G4String fcnGuidance = "The function applied to filled values (log, log10, exp, none).\n";
  fcnGuidance += "Note that the unit parameter cannot be omitted in this case,\n";
  fcnGuidance += "but none value should be used instead.";
  parValFcn->SetGuidance(fcnGuidance);
  parValFcn->SetDefaultValue("none");

  auto parValBinScheme = new G4UIparameter("valBinScheme", 's', true);
  parValBinScheme->SetParameterCandidates("linear log");
  G4String binSchemeGuidance = "The binning scheme (linear, log).\n";
  binSchemeGuidance 
    += "Note that the unit and fcn parameters cannot be omitted in this case,\n";
  binSchemeGuidance += "but none value should be used instead.";
  parValBinScheme->SetGuidance(binSchemeGuidance);
  parValBinScheme->SetDefaultValue("linear");
 
  std::unique_ptr<G4UIcommand> command(
    new G4UIcommand(Update("/analysis/HNTYPE_/setUAXIS", axis), messenger));
  command->SetGuidance(Update("Set parameters for the NDIM_D LOBJECT of given id:"));
  command->SetGuidance(
    Update("  nAXISbins; AXISvalMin; AXISvalMax; AXISunit; AXISfunction; AXISbinScheme", axis));
  command->SetParameter(parId);
  command->SetParameter(parNbins);
  command->SetParameter(parValMin);
  command->SetParameter(parValMax);
  command->SetParameter(parValUnit);
  command->SetParameter(parValFcn);
  command->SetParameter(parValBinScheme);
  command->AvailableForStates(G4State_PreInit, G4State_Idle);

  return command;
}  

Here is the call graph for this function:

CreateSetTitleCommand()

std::unique_ptr< G4UIcommand > G4AnalysisMessengerHelper::CreateSetTitleCommand

(

G4UImessenger *

messenger

)

const

Definition at line 143 of file G4AnalysisMessengerHelper.cc.

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

  auto parTitle = new G4UIparameter("title", 's', true);
  parTitle->SetGuidance(Update("OBJECT title"));
  parTitle->SetDefaultValue("none");

  std::unique_ptr<G4UIcommand> command(
    new G4UIcommand(Update("/analysis/HNTYPE_/setTitle"), messenger));
  command->SetGuidance(Update("Set title for the NDIM_D LOBJECT of given id"));
  command->SetParameter(parId);
  command->SetParameter(parTitle);
  command->AvailableForStates(G4State_PreInit, G4State_Idle);

  return command;
}  

Here is the call graph for this function:

CreateSetValuesCommand()

std::unique_ptr< G4UIcommand > G4AnalysisMessengerHelper::CreateSetValuesCommand	(	const G4String &	axis,
		G4UImessenger *	messenger
	)		const

Definition at line 222 of file G4AnalysisMessengerHelper.cc.

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

  auto parValMin = new G4UIparameter("valMin", 'd', false);
  parValMin->SetGuidance(Update("Minimum AXIS-value expressed in unit", axis));
  
  auto parValMax = new G4UIparameter("valMax", 'd', false);
  parValMax->SetGuidance(Update("Maximum AXIS-value expressed in unit", axis));
  
  auto parValUnit = new G4UIparameter("valUnit", 's', true);
  parValUnit->SetGuidance("The unit applied to filled values and valMin, valMax");
  parValUnit->SetDefaultValue("none");

  auto parValFcn = new G4UIparameter("valFcn", 's', true);
  parValFcn->SetParameterCandidates("log log10 exp none");
  G4String fcnGuidance = "The function applied to filled values (log, log10, exp, none).\n";
  fcnGuidance += "Note that the unit parameter cannot be omitted in this case,\n";
  fcnGuidance += "but none value should be used instead.";
  parValFcn->SetGuidance(fcnGuidance);
  parValFcn->SetDefaultValue("none");

  std::unique_ptr<G4UIcommand> command(
    new G4UIcommand(Update("/analysis/HNTYPE_/setUAXIS", axis), messenger));
  command->SetGuidance(Update("Set parameters for the NDIM_D LOBJECT of #id:"));
  command->SetGuidance(
    Update("  AXISvalMin; AXISvalMax; AXISunit; AXISfunction", axis));
  command->AvailableForStates(G4State_PreInit, G4State_Idle);

  return command;
}  

Here is the call graph for this function:

GetBinData()

void G4AnalysisMessengerHelper::GetBinData	(	BinData &	data,
		std::vector< G4String > &	parameters,
		G4int &	counter
	)		const

Definition at line 281 of file G4AnalysisMessengerHelper.cc.

{
  data.fNbins = G4UIcommand::ConvertToInt(parameters[counter++]); 
  data.fVmin = G4UIcommand::ConvertToDouble(parameters[counter++]); 
  data.fVmax = G4UIcommand::ConvertToDouble(parameters[counter++]); ; 
  data.fSunit = parameters[counter++];
  data.fSfcn = parameters[counter++];
  data.fSbinScheme = parameters[counter++];
}

Here is the call graph for this function:

GetValueData()

void G4AnalysisMessengerHelper::GetValueData	(	ValueData &	data,
		std::vector< G4String > &	parameters,
		G4int &	counter
	)		const

Definition at line 294 of file G4AnalysisMessengerHelper.cc.

{
  data.fVmin = G4UIcommand::ConvertToDouble(parameters[counter++]); 
  data.fVmax = G4UIcommand::ConvertToDouble(parameters[counter++]); ; 
  data.fSunit = parameters[counter++];
  data.fSfcn = parameters[counter++];
}

Here is the call graph for this function:

Update()

G4String G4AnalysisMessengerHelper::Update ( const G4String &  str, const G4String &  axis = ""  ) const

private

Definition at line 92 of file G4AnalysisMessengerHelper.cc.

{
  G4String newStr(str);

  // Hn, Pn
  G4String upperHnType(str);
  upperHnType.toUpper();
  Replace(newStr, "UHNTYPE_", upperHnType);

  // hn, pn
  Replace(newStr, "HNTYPE_", fHnType);
  
  // n = 1,2,3
  G4String second = fHnType.substr(1,1);
  Replace(newStr, "NDIM_", second);
  
  // histogram, profile
  G4String lowerObjectType(ObjectType(fHnType));
  lowerObjectType.toLower();
  Replace(newStr, "LOBJECT", lowerObjectType);
  
  // Histogram, Profile
  Replace(newStr, "OBJECT", ObjectType(fHnType));
  
  // X, Y, Z
  G4String upperAxis(axis);
  upperAxis.toUpper();
  Replace(newStr, "UAXIS", upperAxis);
  
  // x, y, z
  Replace(newStr, "AXIS", axis);

  // return result
  return newStr;
}

Here is the call graph for this function:

Here is the caller graph for this function:

WarnAboutParameters()

void G4AnalysisMessengerHelper::WarnAboutParameters	(	G4UIcommand *	command,
		G4int	nofParameters
	)		const

Definition at line 305 of file G4AnalysisMessengerHelper.cc.

{
  G4ExceptionDescription description;
  description 
    << "Got wrong number of \"" << command->GetCommandName() 
    << "\" parameters: " << nofParameters
    << " instead of " << command->GetParameterEntries() 
    << " expected" << G4endl;
  G4String methodName(Update("G4UHNTYPE_Messenger::SetNewValue"));  
  G4Exception(methodName,
              "Analysis_W013", JustWarning, description);
}

Here is the call graph for this function:

WarnAboutSetCommands()

void G4AnalysisMessengerHelper::WarnAboutSetCommands

(

)

const

Definition at line 320 of file G4AnalysisMessengerHelper.cc.

{
  G4ExceptionDescription description;
  description 
    << "Command setX, setY, setZ must be called sucessively in this order. " << G4endl
    << "Command was ignored." << G4endl;
  G4String methodName(Update("G4UHNTYPE_Messenger::SetNewValue"));  
  G4Exception(methodName,
              "Analysis_W013", JustWarning, description);
}

Here is the call graph for this function:

Friends And Related Function Documentation

G4HnMessenger

friend class G4HnMessenger

friend

Definition at line 79 of file G4AnalysisMessengerHelper.hh.

Member Data Documentation

fHnType

G4String G4AnalysisMessengerHelper::fHnType

private

Definition at line 112 of file G4AnalysisMessengerHelper.hh.

---

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

• G4AnalysisMessengerHelper.hh
• G4AnalysisMessengerHelper.cc