G4PlotMessenger Class Reference

#include <G4PlotMessenger.hh>

Inheritance diagram for G4PlotMessenger:

Collaboration diagram for G4PlotMessenger:

Public Member Functions
	G4PlotMessenger (G4PlotParameters *plotParameters)
virtual	~G4PlotMessenger ()
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	SetStyleCmd ()
void	SetLayoutCmd ()
void	SetDimensionsCmd ()

Private Attributes
G4PlotParameters *	fPlotParameters
	Associated class. More...
std::unique_ptr< G4AnalysisMessengerHelper >	fHelper
std::unique_ptr< G4UIdirectory >	fDirectory
std::unique_ptr< G4UIcommand >	fSetLayoutCmd
std::unique_ptr< G4UIcommand >	fSetDimensionsCmd
std::unique_ptr< G4UIcmdWithAString >	fSetStyleCmd

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 G4PlotMessenger.hh.

Constructor & Destructor Documentation

G4PlotMessenger()

G4PlotMessenger::G4PlotMessenger ( G4PlotParameters *  plotParameters )

explicit

Definition at line 48 of file G4PlotMessenger.cc.

  : G4UImessenger(),
    fPlotParameters(plotParameters),
    fHelper(nullptr),
    fDirectory(nullptr),
    fSetLayoutCmd(nullptr),
    fSetDimensionsCmd(nullptr), 
    fSetStyleCmd(nullptr)
{  
  fHelper = G4Analysis::make_unique<G4AnalysisMessengerHelper>("plot");

  fDirectory = fHelper->CreateHnDirectory();

  SetStyleCmd();
  SetLayoutCmd();
  SetDimensionsCmd();
}

Here is the call graph for this function:

~G4PlotMessenger()

G4PlotMessenger::~G4PlotMessenger ( )

virtual

Definition at line 67 of file G4PlotMessenger.cc.

{}

Member Function Documentation

SetDimensionsCmd()

void G4PlotMessenger::SetDimensionsCmd ( )

private

Definition at line 134 of file G4PlotMessenger.cc.

{
  auto width = new G4UIparameter("width", 'i', false);
  width->SetGuidance("The page width.");
  
  auto height = new G4UIparameter("height", 'i', false);
  height->SetGuidance("The page height.");
  
  fSetDimensionsCmd = G4Analysis::make_unique<G4UIcommand>("/analysis/plot/setDimensions", this);
  fSetDimensionsCmd->SetGuidance("Set the plotter window size (width and height) in pixels.");
  fSetDimensionsCmd->SetParameter(width);
  fSetDimensionsCmd->SetParameter(height);
  fSetDimensionsCmd->AvailableForStates(G4State_PreInit, G4State_Idle);
}  

Here is the caller graph for this function:

SetLayoutCmd()

void G4PlotMessenger::SetLayoutCmd ( )

private

Definition at line 95 of file G4PlotMessenger.cc.

{
  auto columns = new G4UIparameter("columns", 'i', false);
  columns->SetGuidance("The number of columns in the page layout.");
  G4String range = "columns>=1 && columns<=";
  std::ostringstream osMaxColumns;
  osMaxColumns << fPlotParameters->GetMaxColumns();
  range.append(osMaxColumns.str());
  columns->SetParameterRange(range);
  
  auto rows = new G4UIparameter("rows", 'i', false);
  rows->SetGuidance("The number of rows in the page layout.");
  range = "rows>=1 && rows<=";
  std::ostringstream osMaxRows;
  osMaxRows << fPlotParameters->GetMaxRows();
  range.append(osMaxRows.str());
  rows->SetParameterRange(range);

  fSetLayoutCmd = G4Analysis::make_unique<G4UIcommand>("/analysis/plot/setLayout", this);
  // Guidance text:
  // Set page layout (number of columns and rows per page).
  //    Suported layouts: 
  //    columns = 1 .. maxValueAllowed
  //    rows    = 1 .. maxValueAllowed, and >= columns
  fSetLayoutCmd->SetGuidance("Set page layout (number of columns and rows per page).");
  fSetLayoutCmd->SetGuidance("   Suported layouts: ");
  G4String guidance = "  columns = 1 .. ";
  guidance.append(osMaxColumns.str());
  fSetLayoutCmd->SetGuidance(guidance);
  guidance = "  rows    = 1 .. ";
  guidance.append(osMaxRows.str());
  guidance.append(" and  >= columns");
  fSetLayoutCmd->SetGuidance(guidance);
  fSetLayoutCmd->SetParameter(columns);
  fSetLayoutCmd->SetParameter(rows);
  fSetLayoutCmd->AvailableForStates(G4State_PreInit, G4State_Idle);
}  

Here is the call graph for this function:

Here is the caller graph for this function:

SetNewValue()

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

finalvirtual

Reimplemented from G4UImessenger.

Definition at line 154 of file G4PlotMessenger.cc.

{
  // tokenize parameters in a vector
  std::vector<G4String> parameters;
  G4Analysis::Tokenize(newValues, parameters);
  // check consistency
  if ( G4int(parameters.size()) != command->GetParameterEntries() ) {
    // Should never happen but let's check anyway for consistency
    fHelper->WarnAboutParameters(command, parameters.size());
    return;
  }  

  if ( command == fSetLayoutCmd.get() ) { 
    auto counter = 0;
    auto columns = G4UIcommand::ConvertToInt(parameters[counter++]);
    auto rows = G4UIcommand::ConvertToInt(parameters[counter++]);
    fPlotParameters->SetLayout(columns, rows);
  }
  else if ( command == fSetDimensionsCmd.get() ) {
    auto counter = 0;
    auto width = G4UIcommand::ConvertToInt(parameters[counter++]);
    auto height = G4UIcommand::ConvertToInt(parameters[counter++]);
    fPlotParameters->SetDimensions(width, height);
  }
#if defined(TOOLS_USE_FREETYPE)
  else if ( command == fSetStyleCmd.get() ) {
    fPlotParameters->SetStyle(newValues);
  }
#endif
}  

Here is the call graph for this function:

SetStyleCmd()

void G4PlotMessenger::SetStyleCmd ( )

private

Definition at line 75 of file G4PlotMessenger.cc.

{
  fSetStyleCmd = G4Analysis::make_unique<G4UIcmdWithAString>("/analysis/plot/setStyle",this);
#if defined(TOOLS_USE_FREETYPE)
  fSetStyleCmd->SetGuidance("Set plotting style from: ");
  fSetStyleCmd->SetGuidance("  ROOT_default:  ROOT style with high resolution fonts");
  fSetStyleCmd->SetGuidance("  hippodraw:     hippodraw style with high resolution fonts");
  fSetStyleCmd->SetGuidance("  inlib_default: PAW style with low resolution fonts");
  fSetStyleCmd->SetParameterName("Style", false);
#else
  fSetStyleCmd->SetGuidance("Only one plotting style is available in low resolution: ");
  fSetStyleCmd->SetGuidance("  inlib_default: PAW style with low resolution fonts");
  fSetStyleCmd->SetParameterName("Style", false);
  fSetStyleCmd->SetCandidates("inlib_default");
#endif
  fSetStyleCmd->SetCandidates(fPlotParameters->GetAvailableStyles());
  fSetStyleCmd->AvailableForStates(G4State_PreInit, G4State_Idle);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

fDirectory

std::unique_ptr<G4UIdirectory> G4PlotMessenger::fDirectory

private

Definition at line 63 of file G4PlotMessenger.hh.

fHelper

std::unique_ptr<G4AnalysisMessengerHelper> G4PlotMessenger::fHelper

private

Definition at line 62 of file G4PlotMessenger.hh.

fPlotParameters

G4PlotParameters* G4PlotMessenger::fPlotParameters

private

Associated class.

Definition at line 61 of file G4PlotMessenger.hh.

fSetDimensionsCmd

std::unique_ptr<G4UIcommand> G4PlotMessenger::fSetDimensionsCmd

private

Definition at line 66 of file G4PlotMessenger.hh.

fSetLayoutCmd

std::unique_ptr<G4UIcommand> G4PlotMessenger::fSetLayoutCmd

private

Definition at line 65 of file G4PlotMessenger.hh.

fSetStyleCmd

std::unique_ptr<G4UIcmdWithAString> G4PlotMessenger::fSetStyleCmd

private

Definition at line 67 of file G4PlotMessenger.hh.

---

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

• G4PlotMessenger.hh
• G4PlotMessenger.cc