G4P2Messenger Class Reference

#include <G4P2Messenger.hh>

Inheritance diagram for G4P2Messenger:

Public Member Functions
G4bool	CommandsShouldBeInMaster () const
	G4P2Messenger ()=delete
	G4P2Messenger (G4VAnalysisManager *manager)
virtual G4String	GetCurrentValue (G4UIcommand *command)
G4bool	operator!= (const G4UImessenger &messenger) const
G4bool	operator== (const G4UImessenger &messenger) const
virtual void	SetNewValue (G4UIcommand *command, G4String value) final
virtual	~G4P2Messenger ()

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 Member Functions
void	CreateP2Cmd ()
void	SetP2Cmd ()

Private Attributes
std::unique_ptr< G4UIcommand >	fCreateP2Cmd
std::unique_ptr< G4UIdirectory >	fDirectory
std::unique_ptr< G4AnalysisMessengerHelper >	fHelper
G4VAnalysisManager *	fManager { nullptr }
	Associated class. More...
std::unique_ptr< G4UIcommand >	fSetP2Cmd
std::unique_ptr< G4UIcommand >	fSetP2TitleCmd
std::unique_ptr< G4UIcommand >	fSetP2XAxisCmd
std::unique_ptr< G4UIcommand >	fSetP2XAxisLogCmd
std::unique_ptr< G4UIcommand >	fSetP2XCmd
std::unique_ptr< G4UIcommand >	fSetP2YAxisCmd
std::unique_ptr< G4UIcommand >	fSetP2YAxisLogCmd
std::unique_ptr< G4UIcommand >	fSetP2YCmd
std::unique_ptr< G4UIcommand >	fSetP2ZAxisCmd
std::unique_ptr< G4UIcommand >	fSetP2ZAxisLogCmd
std::unique_ptr< G4UIcommand >	fSetP2ZCmd
G4AnalysisMessengerHelper::BinData	fXData
G4int	fXId { G4Analysis::kInvalidId }
G4AnalysisMessengerHelper::BinData	fYData
G4int	fYId { G4Analysis::kInvalidId }

Detailed Description

Definition at line 46 of file G4P2Messenger.hh.

Constructor & Destructor Documentation

G4P2Messenger() [1/2]

G4P2Messenger::G4P2Messenger ( G4VAnalysisManager *  manager )

explicit

Definition at line 39 of file G4P2Messenger.cc.

  : G4UImessenger(),
    fManager(manager)
{
  fHelper = std::make_unique<G4AnalysisMessengerHelper>("p2");
 
  fDirectory = fHelper->CreateHnDirectory();
 
  CreateP2Cmd();
 
  SetP2Cmd();
  fSetP2XCmd = fHelper->CreateSetBinsCommand("x", this);
  fSetP2YCmd = fHelper->CreateSetBinsCommand("y", this);
  fSetP2ZCmd = fHelper->CreateSetValuesCommand("z", this);
 
  fSetP2TitleCmd = fHelper->CreateSetTitleCommand(this);
  fSetP2XAxisCmd = fHelper->CreateSetAxisCommand("x", this);
  fSetP2YAxisCmd = fHelper->CreateSetAxisCommand("y", this);
  fSetP2ZAxisCmd = fHelper->CreateSetAxisCommand("z", this);
  fSetP2XAxisLogCmd = fHelper->CreateSetAxisLogCommand("x", this);
  fSetP2YAxisLogCmd = fHelper->CreateSetAxisLogCommand("y", this);
  fSetP2ZAxisLogCmd = fHelper->CreateSetAxisLogCommand("z", this);
}

References CreateP2Cmd(), fDirectory, fHelper, fSetP2TitleCmd, fSetP2XAxisCmd, fSetP2XAxisLogCmd, fSetP2XCmd, fSetP2YAxisCmd, fSetP2YAxisLogCmd, fSetP2YCmd, fSetP2ZAxisCmd, fSetP2ZAxisLogCmd, fSetP2ZCmd, and SetP2Cmd().

G4P2Messenger() [2/2]

G4P2Messenger::G4P2Messenger ( )

delete

~G4P2Messenger()

G4P2Messenger::~G4P2Messenger ( )

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().

CreateP2Cmd()

void G4P2Messenger::CreateP2Cmd ( )

private

Definition at line 71 of file G4P2Messenger.cc.

{
  auto p2Name = new G4UIparameter("name", 's', false);
  p2Name->SetGuidance("Profile name (label)");
 
  auto p2Title = new G4UIparameter("title", 's', false);
  p2Title->SetGuidance("Profile title");
 
  auto p2xNbins0 = new G4UIparameter("xnbins0", 'i', true);
  p2xNbins0->SetGuidance("Number of x-bins (default = 100)");
  p2xNbins0->SetGuidance("Can be reset with /analysis/p2/set command");
  p2xNbins0->SetDefaultValue(100);
 
  auto p2xValMin0 = new G4UIparameter("xvalMin0", 'd', true);
  p2xValMin0->SetGuidance("Minimum x-value, expressed in unit (default = 0.)");
  p2xValMin0->SetGuidance("Can be reset with /analysis/p2/set command");
  p2xValMin0->SetDefaultValue(0.);
 
  auto p2xValMax0 = new G4UIparameter("xvalMax0", 'd', true);
  p2xValMax0->SetGuidance("Maximum x-value, expressed in unit (default = 1.)");
  p2xValMax0->SetGuidance("Can be reset with /analysis/p2/set command");
  p2xValMax0->SetDefaultValue(1.);
 
  auto p2xValUnit0 = new G4UIparameter("xvalUnit0", 's', true);
  p2xValUnit0->SetGuidance("The unit applied to filled x-values and xvalMin0, xvalMax0");
  p2xValUnit0->SetDefaultValue("none");
 
  auto p2xValFcn0 = new G4UIparameter("xvalFcn0", 's', true);
  G4String fcnxGuidance = "The function applied to filled x-values (log, log10, exp, none).";
  p2xValFcn0->SetGuidance(fcnxGuidance);
  p2xValFcn0->SetParameterCandidates("log log10 exp none");
  p2xValFcn0->SetDefaultValue("none");
 
  auto p2xValBinScheme0 = new G4UIparameter("xvalBinScheme0", 's', true);
  G4String binSchemeGuidance = "The binning scheme (linear, log).";
  p2xValBinScheme0->SetParameterCandidates("linear log");
  p2xValBinScheme0->SetGuidance(binSchemeGuidance);
  p2xValBinScheme0->SetDefaultValue("linear");
 
  auto p2yNbins0 = new G4UIparameter("ynbins0", 'i', true);
  p2yNbins0->SetGuidance("Number of y-bins (default = 100)");
  p2yNbins0->SetGuidance("Can be reset with /analysis/p2/set command");
  p2yNbins0->SetDefaultValue(100);
 
  auto p2yValMin0 = new G4UIparameter("yvalMin0", 'd', true);
  p2yValMin0->SetGuidance("Minimum y-value, expressed in unit (default = 0.)");
  p2yValMin0->SetGuidance("Can be reset with /analysis/p2/set command");
  p2yValMin0->SetDefaultValue(0.);
 
  auto p2yValMax0 = new G4UIparameter("yvalMax0", 'd', true);
  p2yValMax0->SetGuidance("Maximum y-value, expressed in unit (default = 1.)");
  p2yValMax0->SetGuidance("Can be reset with /analysis/p2/set command");
  p2yValMax0->SetDefaultValue(1.);
 
  auto p2yValUnit0 = new G4UIparameter("yvalUnit0", 's', true);
  p2yValUnit0->SetGuidance("The unit applied to filled y-values and yvalMin0, yvalMax0");
  p2yValUnit0->SetDefaultValue("none");
 
  auto p2yValFcn0 = new G4UIparameter("yvalFcn0", 's', true);
  G4String fcnyGuidance = "The function applied to filled y-values (log, log10, exp, none).";
  p2yValFcn0->SetGuidance(fcnyGuidance);
  p2yValFcn0->SetParameterCandidates("log log10 exp none");
  p2yValFcn0->SetDefaultValue("none");
 
  auto p2yValBinScheme0 = new G4UIparameter("yvalBinScheme0", 's', true);
  p2yValBinScheme0->SetParameterCandidates("linear log");
  p2yValBinScheme0->SetGuidance(binSchemeGuidance);
  p2yValBinScheme0->SetDefaultValue("linear");
 
  auto p2zValMin0 = new G4UIparameter("zvalMin0", 'd', true);
  p2zValMin0->SetGuidance("Minimum z-value, expressed in unit (default = 0.)");
  p2zValMin0->SetGuidance("Can be reset with /analysis/p2/set command");
  p2zValMin0->SetDefaultValue(0.);
 
  auto p2zValMax0 = new G4UIparameter("zvalMax0", 'd', true);
  p2zValMax0->SetGuidance("Maximum z-value, expressed in unit (default = 1.)");
  p2zValMax0->SetGuidance("Can be reset with /analysis/p2/set command");
  p2zValMax0->SetDefaultValue(1.);
 
  auto p2zValUnit0 = new G4UIparameter("zvalUnit0", 's', true);
  p2zValUnit0->SetGuidance("The unit applied to filled z-values and zvalMin0, zvalMax0");
  p2zValUnit0->SetDefaultValue("none");
 
  auto p2zValFcn0 = new G4UIparameter("zvalFcn0", 's', true);
  G4String fcnzGuidance = "The function applied to filled z-values (log, log10, exp, none).";
  p2zValFcn0->SetGuidance(fcnzGuidance);
  p2zValFcn0->SetParameterCandidates("log log10 exp none");
  p2zValFcn0->SetDefaultValue("none");
 
  fCreateP2Cmd = std::make_unique<G4UIcommand>("/analysis/p2/create", this);
  fCreateP2Cmd->SetGuidance("Create 2D profile");
  fCreateP2Cmd->SetParameter(p2Name);
  fCreateP2Cmd->SetParameter(p2Title);
  fCreateP2Cmd->SetParameter(p2xNbins0);
  fCreateP2Cmd->SetParameter(p2xValMin0);
  fCreateP2Cmd->SetParameter(p2xValMax0);
  fCreateP2Cmd->SetParameter(p2xValUnit0);
  fCreateP2Cmd->SetParameter(p2xValFcn0);
  fCreateP2Cmd->SetParameter(p2xValBinScheme0);
  fCreateP2Cmd->SetParameter(p2yNbins0);
  fCreateP2Cmd->SetParameter(p2yValMin0);
  fCreateP2Cmd->SetParameter(p2yValMax0);
  fCreateP2Cmd->SetParameter(p2yValUnit0);
  fCreateP2Cmd->SetParameter(p2yValFcn0);
  fCreateP2Cmd->SetParameter(p2yValBinScheme0);
  fCreateP2Cmd->SetParameter(p2zValMin0);
  fCreateP2Cmd->SetParameter(p2zValMax0);
  fCreateP2Cmd->SetParameter(p2zValUnit0);
  fCreateP2Cmd->SetParameter(p2zValFcn0);
  fCreateP2Cmd->AvailableForStates(G4State_PreInit, G4State_Idle);
}

References fCreateP2Cmd, G4State_Idle, and G4State_PreInit.

Referenced by G4P2Messenger().

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

Reimplemented in G4ScoreQuantityMessenger, G4VisCommandModelCreate< Factory >, G4VisCommandListManagerList< Manager >, G4VisCommandListManagerSelect< Manager >, G4VisCommandManagerMode< Manager >, G4ToolsAnalysisMessenger, G4ScoringMessenger, G4EvManMessenger, G4GeneralParticleSourceMessenger, G4ParticleGunMessenger, G4GeometryMessenger, G4GenericMessenger, G4UIcontrolMessenger, GFlashShowerModelMessenger, G4DecayTableMessenger, G4ParticleMessenger, G4ParticlePropertyMessenger, G4tgrMessenger, G4PersistencyCenterMessenger, G4ProductionCutsTableMessenger, G4SchedulerMessenger, G4VITSteppingVerbose, G4MoleculeShootMessenger, G4MoleculeGunMessenger, G4ProcessManagerMessenger, G4ProcessTableMessenger, G4MatScanMessenger, G4RunMessenger, G4UserPhysicsListMessenger, G4TrackingMessenger, G4GMocrenMessenger, G4HepRepMessenger, G4VisCommandAbortReviewKeptEvents, G4VisCommandDrawOnlyToBeKeptEvents, G4VisCommandEnable, G4VisCommandList, G4VisCommandReviewKeptEvents, G4VisCommandVerbose, G4VisCommandGeometryList, G4VisCommandGeometryRestore, G4VisCommandGeometrySetColour, G4VisCommandGeometrySetDaughtersInvisible, G4VisCommandGeometrySetForceAuxEdgeVisible, G4VisCommandGeometrySetForceCloud, G4VisCommandGeometrySetForceSolid, G4VisCommandGeometrySetForceLineSegmentsPerCircle, G4VisCommandGeometrySetForceWireframe, G4VisCommandGeometrySetLineStyle, G4VisCommandGeometrySetLineWidth, G4VisCommandGeometrySetVisibility, G4VisCommandSceneActivateModel, G4VisCommandSceneCreate, G4VisCommandSceneEndOfEventAction, G4VisCommandSceneEndOfRunAction, G4VisCommandSceneList, G4VisCommandSceneNotifyHandlers, G4VisCommandSceneRemoveModel, G4VisCommandSceneSelect, G4VisCommandSceneShowExtents, G4VisCommandSceneAddArrow, G4VisCommandSceneAddArrow2D, G4VisCommandSceneAddAxes, G4VisCommandSceneAddDate, G4VisCommandSceneAddDigis, G4VisCommandSceneAddEventID, G4VisCommandSceneAddExtent, G4VisCommandSceneAddElectricField, G4VisCommandSceneAddFrame, G4VisCommandSceneAddGPS, G4VisCommandSceneAddGhosts, G4VisCommandSceneAddHits, G4VisCommandSceneAddLine, G4VisCommandSceneAddLine2D, G4VisCommandSceneAddLocalAxes, G4VisCommandSceneAddLogicalVolume, G4VisCommandSceneAddLogo, G4VisCommandSceneAddLogo2D, G4VisCommandSceneAddMagneticField, G4VisCommandSceneAddPSHits, G4VisCommandSceneAddScale, G4VisCommandSceneAddText, G4VisCommandSceneAddText2D, G4VisCommandSceneAddTrajectories, G4VisCommandSceneAddUserAction, G4VisCommandSceneAddVolume, G4VisCommandSceneAddPlotter, G4VisCommandSceneHandlerAttach, G4VisCommandSceneHandlerCreate, G4VisCommandSceneHandlerList, G4VisCommandSceneHandlerSelect, G4VisCommandSetArrow3DLineSegmentsPerCircle, G4VisCommandSetColour, G4VisCommandSetExtentForField, G4VisCommandSetLineWidth, G4VisCommandSetTextColour, G4VisCommandSetTextLayout, G4VisCommandSetTextSize, G4VisCommandSetTouchable, G4VisCommandSetVolumeForField, G4VisCommandsTouchable, G4VisCommandsTouchableSet, G4VisCommandViewerAddCutawayPlane, G4VisCommandViewerCentreOn, G4VisCommandViewerChangeCutawayPlane, G4VisCommandViewerClear, G4VisCommandViewerClearCutawayPlanes, G4VisCommandViewerClearTransients, G4VisCommandViewerClearVisAttributesModifiers, G4VisCommandViewerClone, G4VisCommandViewerColourByDensity, G4VisCommandViewerCopyViewFrom, G4VisCommandViewerCreate, G4VisCommandViewerDolly, G4VisCommandViewerFlush, G4VisCommandViewerInterpolate, G4VisCommandViewerList, G4VisCommandViewerPan, G4VisCommandViewerReset, G4VisCommandViewerRefresh, G4VisCommandViewerRebuild, G4VisCommandViewerSave, G4VisCommandViewerScale, G4VisCommandViewerSelect, G4VisCommandViewerUpdate, G4VisCommandViewerZoom, G4VisCommandViewerDefaultHiddenEdge, G4VisCommandViewerDefaultStyle, G4VisCommandsViewerSet, G4VModelCommand< T >, G4VModelCommand< M >, G4RTMessenger, G4ASCIITreeMessenger, G4VtkMessenger, G4PolarizationMessenger, and G4DNAChemistryManager.

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;
}

SetNewValue()

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

finalvirtual

Reimplemented from G4UImessenger.

Definition at line 287 of file G4P2Messenger.cc.

{
  // tokenize parameters in a vector
  std::vector<G4String> parameters;
  G4Analysis::Tokenize(newValues, parameters);
  // check consistency
  if ( parameters.size() != command->GetParameterEntries() ) {
    // Should never happen but let's check anyway for consistency
    fHelper->WarnAboutParameters(command, parameters.size());
    return;
  }
 
  if ( command == fCreateP2Cmd.get() ) {
    auto counter = 0;
    auto name = parameters[counter++];
    auto title = parameters[counter++];
    G4AnalysisMessengerHelper::BinData xdata;
    fHelper->GetBinData(xdata, parameters, counter);
    auto xunit = GetUnitValue(xdata.fSunit);
    G4AnalysisMessengerHelper::BinData ydata;
    fHelper->GetBinData(ydata, parameters, counter);
    auto yunit = GetUnitValue(ydata.fSunit);
    G4AnalysisMessengerHelper::ValueData zdata;
    fHelper->GetValueData(zdata, parameters, counter);
    auto zunit = GetUnitValue(zdata.fSunit);
    fManager->CreateP2(name, title,
                       xdata.fNbins, xdata.fVmin*xunit, xdata.fVmax*xunit,
                       ydata.fNbins, ydata.fVmin*yunit, ydata.fVmax*yunit,
                       zdata.fVmin*zunit, zdata.fVmax*zunit,
                       xdata.fSunit, ydata.fSunit, zdata.fSunit,
                       xdata.fSfcn, ydata.fSfcn, zdata.fSfcn,
                       xdata.fSbinScheme, ydata.fSbinScheme);
  }
  else if ( command == fSetP2Cmd.get() ) {
    auto counter = 0;
    auto id = G4UIcommand::ConvertToInt(parameters[counter++]);
    G4AnalysisMessengerHelper::BinData xdata;
    fHelper->GetBinData(xdata, parameters, counter);
    auto xunit = GetUnitValue(xdata.fSunit);
    G4AnalysisMessengerHelper::BinData ydata;
    fHelper->GetBinData(ydata, parameters, counter);
    auto yunit = GetUnitValue(ydata.fSunit);
    G4AnalysisMessengerHelper::ValueData zdata;
    fHelper->GetValueData(zdata, parameters, counter);
    auto zunit = GetUnitValue(zdata.fSunit);
    fManager->SetP2(id,
                    xdata.fNbins, xdata.fVmin*xunit, xdata.fVmax*xunit,
                    ydata.fNbins, ydata.fVmin*yunit, ydata.fVmax*yunit,
                    zdata.fVmin*zunit, zdata.fVmax*zunit,
                    xdata.fSunit, ydata.fSunit, zdata.fSunit,
                    xdata.fSfcn, ydata.fSfcn, zdata.fSfcn,
                    xdata.fSbinScheme, ydata.fSbinScheme);
  }
  else if ( command == fSetP2XCmd.get() ) {
    // Only save values
    auto counter = 0;
    fXId = G4UIcommand::ConvertToInt(parameters[counter++]);
    fHelper->GetBinData(fXData, parameters, counter);
  }
  else if ( command == fSetP2YCmd.get() ) {
    // Save values
    auto counter = 0;
    fYId = G4UIcommand::ConvertToInt(parameters[counter++]);
    // Check if setX command was called
    if ( fXId == -1 || fXId != fYId ) {
      fHelper->WarnAboutSetCommands();
      return;
    }
    fHelper->GetBinData(fYData, parameters, counter);
    // Set values
    // (another set may follow if setZ is also called)
    auto xunit = GetUnitValue(fXData.fSunit);
    auto yunit = GetUnitValue(fYData.fSunit);
    fManager->SetP2(fYId,
                    fXData.fNbins, fXData.fVmin*xunit, fXData.fVmax*xunit,
                    fYData.fNbins, fYData.fVmin*yunit, fYData.fVmax*yunit,
                    0., 0.,
                    fXData.fSunit, fYData.fSunit, "none",
                    fXData.fSfcn, fYData.fSfcn, "none",
                    fXData.fSbinScheme, fYData.fSbinScheme);
  }
  else if ( command == fSetP2ZCmd.get() ) {
    auto counter = 0;
    auto id = G4UIcommand::ConvertToInt(parameters[counter++]);
    // Check if setX and setY command was called
    if ( fXId == -1 || fXId != id ||
         fYId == -1 || fYId != id ) {
      fHelper->WarnAboutSetCommands();
      return;
    }
    auto xunit = GetUnitValue(fXData.fSunit);
    auto yunit = GetUnitValue(fYData.fSunit);
    G4AnalysisMessengerHelper::ValueData zdata;
    fHelper->GetValueData(zdata, parameters, counter);
    auto zunit = GetUnitValue(zdata.fSunit);
    fManager->SetP2(id,
                    fXData.fNbins, fXData.fVmin*xunit, fXData.fVmax*xunit,
                    fYData.fNbins, fYData.fVmin*yunit, fYData.fVmax*yunit,
                    zdata.fVmin*zunit, zdata.fVmax*zunit,
                    fXData.fSunit, fYData.fSunit, zdata.fSunit,
                    fXData.fSfcn, fYData.fSfcn, zdata.fSfcn,
                    fXData.fSbinScheme, fYData.fSbinScheme);
    fXId = -1;
    fYId = -1;
  }
  else if ( command == fSetP2TitleCmd.get() ) {
    auto counter = 0;
    auto id = G4UIcommand::ConvertToInt(parameters[counter++]);
    auto title = parameters[counter++];
    fManager->SetP2Title(id, title);
  }
  else if ( command == fSetP2XAxisCmd.get() ) {
    auto counter = 0;
    auto id = G4UIcommand::ConvertToInt(parameters[counter++]);
    auto xaxis = parameters[counter++];
    fManager->SetP2XAxisTitle(id, xaxis);
  }
  else if ( command == fSetP2YAxisCmd.get() ) {
    auto counter = 0;
    auto id = G4UIcommand::ConvertToInt(parameters[counter++]);
    auto yaxis = parameters[counter++];
    fManager->SetP2YAxisTitle(id, yaxis);
  }
  else if ( command == fSetP2ZAxisCmd.get() ) {
    auto counter = 0;
    auto id = G4UIcommand::ConvertToInt(parameters[counter++]);
    auto zaxis = parameters[counter++];
    fManager->SetP2ZAxisTitle(id, zaxis);
  }
  else if ( command == fSetP2XAxisLogCmd.get() ) {
    auto counter = 0;
    auto id = G4UIcommand::ConvertToInt(parameters[counter++]);
    auto xaxisLog = G4UIcommand::ConvertToBool(parameters[counter++]);
    fManager->SetP2XAxisIsLog(id, xaxisLog);
  }
  else if ( command == fSetP2YAxisLogCmd.get() ) {
    auto counter = 0;
    auto id = G4UIcommand::ConvertToInt(parameters[counter++]);
    auto yaxisLog = G4UIcommand::ConvertToBool(parameters[counter++]);
    fManager->SetP2YAxisIsLog(id, yaxisLog);
  }
  else if ( command == fSetP2ZAxisLogCmd.get() ) {
    auto counter = 0;
    auto id = G4UIcommand::ConvertToInt(parameters[counter++]);
    auto zaxisLog = G4UIcommand::ConvertToBool(parameters[counter++]);
    fManager->SetP2ZAxisIsLog(id, zaxisLog);
  }
}

References G4UIcommand::ConvertToBool(), G4UIcommand::ConvertToInt(), G4VAnalysisManager::CreateP2(), fCreateP2Cmd, fHelper, fManager, G4AnalysisMessengerHelper::BinData::fNbins, G4AnalysisMessengerHelper::BinData::fSbinScheme, fSetP2Cmd, fSetP2TitleCmd, fSetP2XAxisCmd, fSetP2XAxisLogCmd, fSetP2XCmd, fSetP2YAxisCmd, fSetP2YAxisLogCmd, fSetP2YCmd, fSetP2ZAxisCmd, fSetP2ZAxisLogCmd, fSetP2ZCmd, G4AnalysisMessengerHelper::BinData::fSfcn, G4AnalysisMessengerHelper::ValueData::fSfcn, G4AnalysisMessengerHelper::BinData::fSunit, G4AnalysisMessengerHelper::ValueData::fSunit, G4AnalysisMessengerHelper::BinData::fVmax, G4AnalysisMessengerHelper::ValueData::fVmax, G4AnalysisMessengerHelper::BinData::fVmin, G4AnalysisMessengerHelper::ValueData::fVmin, fXData, fXId, fYData, fYId, G4UIcommand::GetParameterEntries(), G4Analysis::GetUnitValue(), G4InuclParticleNames::name(), G4VAnalysisManager::SetP2(), G4VAnalysisManager::SetP2Title(), G4VAnalysisManager::SetP2XAxisIsLog(), G4VAnalysisManager::SetP2XAxisTitle(), G4VAnalysisManager::SetP2YAxisIsLog(), G4VAnalysisManager::SetP2YAxisTitle(), G4VAnalysisManager::SetP2ZAxisIsLog(), G4VAnalysisManager::SetP2ZAxisTitle(), and G4Analysis::Tokenize().

SetP2Cmd()

void G4P2Messenger::SetP2Cmd ( )

private

Definition at line 185 of file G4P2Messenger.cc.

{
  auto p2Id = new G4UIparameter("id", 'i', false);
  p2Id->SetGuidance("Profile id");
  p2Id->SetParameterRange("id>=0");
 
  auto p2xNbins = new G4UIparameter("xnbins", 'i', false);
  p2xNbins->SetGuidance("Number of x-bins");
 
  auto p2xValMin = new G4UIparameter("xvalMin", 'd', false);
  p2xValMin->SetGuidance("Minimum x-value, expressed in unit");
 
  auto p2xValMax = new G4UIparameter("xvalMax", 'd', false);
  p2xValMax->SetGuidance("Maximum x-value, expressed in unit");
 
  auto p2xValUnit = new G4UIparameter("xvalUnit", 's', true);
  p2xValUnit->SetGuidance("The unit applied to filled x-values and xvalMin0, xvalMax0");
  p2xValUnit->SetDefaultValue("none");
 
  auto p2xValFcn = new G4UIparameter("xvalFcn", 's', true);
  p2xValFcn->SetParameterCandidates("log log10 exp none");
  G4String fcnxGuidance = "The function applied to filled x-values (log, log10, exp, none).";
  p2xValFcn->SetGuidance(fcnxGuidance);
  p2xValFcn->SetDefaultValue("none");
 
  auto p2xValBinScheme = new G4UIparameter("xvalBinScheme", 's', true);
  G4String binSchemeGuidance = "The binning scheme (linear, log).";
  p2xValBinScheme->SetParameterCandidates("linear log");
  p2xValBinScheme->SetGuidance(binSchemeGuidance);
  p2xValBinScheme->SetDefaultValue("linear");
 
  auto p2yNbins = new G4UIparameter("nybins", 'i', true);
  p2yNbins->SetGuidance("Number of y-bins");
 
  auto p2yValMin = new G4UIparameter("yvalMin", 'd', true);
  p2yValMin->SetGuidance("Minimum y-value, expressed in unit");
 
  auto p2yValMax = new G4UIparameter("yvalMax", 'd', true);
  p2yValMax->SetGuidance("Maximum y-value, expressed in unit");
 
  auto p2yValUnit = new G4UIparameter("yvalUnit", 's', true);
  p2yValUnit->SetGuidance("The unit applied to filled y-values and yvalMin0, yvalMax0");
  p2yValUnit->SetDefaultValue("none");
 
  auto p2yValFcn = new G4UIparameter("yvalFcn", 's', true);
  p2yValFcn->SetParameterCandidates("log log10 exp none");
  G4String fcnyGuidance = "The function applied to filled y-values (log, log10, exp, none).";
  p2yValFcn->SetGuidance(fcnyGuidance);
  p2yValFcn->SetDefaultValue("none");
 
  auto p2yValBinScheme = new G4UIparameter("yvalBinScheme", 's', true);
  p2yValBinScheme->SetParameterCandidates("linear log");
  p2yValBinScheme->SetGuidance(binSchemeGuidance);
  p2yValBinScheme->SetDefaultValue("linear");
 
  auto p2zValMin = new G4UIparameter("zvalMin", 'd', true);
  p2zValMin->SetGuidance("Minimum z-value, expressed in unit");
 
  auto p2zValMax = new G4UIparameter("zvalMax", 'd', true);
  p2zValMax->SetGuidance("Maximum z-value, expressed in unit");
 
  auto p2zValUnit = new G4UIparameter("zvalUnit", 's', true);
  p2zValUnit->SetGuidance("The unit applied to filled z-values and zvalMin0, zvalMax0");
  p2zValUnit->SetDefaultValue("none");
 
  auto p2zValFcn = new G4UIparameter("zvalFcn", 's', true);
  p2zValFcn->SetParameterCandidates("log log10 exp none");
  G4String fcnzGuidance = "The function applied to filled z-values (log, log10, exp, none).";
  p2zValFcn->SetGuidance(fcnzGuidance);
  p2zValFcn->SetDefaultValue("none");
 
  fSetP2Cmd = std::make_unique<G4UIcommand>("/analysis/p2/set", this);
  fSetP2Cmd->SetGuidance("Set parameters for the 2D profile of given id:");
  fSetP2Cmd->SetGuidance("  nxbins; xvalMin; xvalMax; xunit; xbinScheme");
  fSetP2Cmd->SetGuidance("  nybins; yvalMin; yvalMax; yunit; ybinScheme");
  fSetP2Cmd->SetGuidance("  zvalMin; zvalMax; zunit; zfunction");
  fSetP2Cmd->SetParameter(p2Id);
  fSetP2Cmd->SetParameter(p2xNbins);
  fSetP2Cmd->SetParameter(p2xValMin);
  fSetP2Cmd->SetParameter(p2xValMax);
  fSetP2Cmd->SetParameter(p2xValUnit);
  fSetP2Cmd->SetParameter(p2xValFcn);
  fSetP2Cmd->SetParameter(p2xValBinScheme);
  fSetP2Cmd->SetParameter(p2yNbins);
  fSetP2Cmd->SetParameter(p2yValMin);
  fSetP2Cmd->SetParameter(p2yValMax);
  fSetP2Cmd->SetParameter(p2yValUnit);
  fSetP2Cmd->SetParameter(p2yValFcn);
  fSetP2Cmd->SetParameter(p2yValBinScheme);
  fSetP2Cmd->SetParameter(p2zValMin);
  fSetP2Cmd->SetParameter(p2zValMax);
  fSetP2Cmd->SetParameter(p2zValUnit);
  fSetP2Cmd->SetParameter(p2zValFcn);
  fSetP2Cmd->AvailableForStates(G4State_PreInit, G4State_Idle);
}

References fSetP2Cmd, G4State_Idle, and G4State_PreInit.

Referenced by G4P2Messenger().

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().

fCreateP2Cmd

std::unique_ptr<G4UIcommand> G4P2Messenger::fCreateP2Cmd

private

Definition at line 64 of file G4P2Messenger.hh.

Referenced by CreateP2Cmd(), and SetNewValue().

fDirectory

std::unique_ptr<G4UIdirectory> G4P2Messenger::fDirectory

private

Definition at line 62 of file G4P2Messenger.hh.

Referenced by G4P2Messenger().

fHelper

std::unique_ptr<G4AnalysisMessengerHelper> G4P2Messenger::fHelper

private

Definition at line 61 of file G4P2Messenger.hh.

Referenced by G4P2Messenger(), and SetNewValue().

fManager

G4VAnalysisManager* G4P2Messenger::fManager { nullptr }

private

Associated class.

Definition at line 60 of file G4P2Messenger.hh.

Referenced by SetNewValue().

fSetP2Cmd

std::unique_ptr<G4UIcommand> G4P2Messenger::fSetP2Cmd

private

Definition at line 65 of file G4P2Messenger.hh.

Referenced by SetNewValue(), and SetP2Cmd().

fSetP2TitleCmd

std::unique_ptr<G4UIcommand> G4P2Messenger::fSetP2TitleCmd

private

Definition at line 69 of file G4P2Messenger.hh.

Referenced by G4P2Messenger(), and SetNewValue().

fSetP2XAxisCmd

std::unique_ptr<G4UIcommand> G4P2Messenger::fSetP2XAxisCmd

private

Definition at line 70 of file G4P2Messenger.hh.

Referenced by G4P2Messenger(), and SetNewValue().

fSetP2XAxisLogCmd

std::unique_ptr<G4UIcommand> G4P2Messenger::fSetP2XAxisLogCmd

private

Definition at line 73 of file G4P2Messenger.hh.

Referenced by G4P2Messenger(), and SetNewValue().

fSetP2XCmd

std::unique_ptr<G4UIcommand> G4P2Messenger::fSetP2XCmd

private

Definition at line 66 of file G4P2Messenger.hh.

Referenced by G4P2Messenger(), and SetNewValue().

fSetP2YAxisCmd

std::unique_ptr<G4UIcommand> G4P2Messenger::fSetP2YAxisCmd

private

Definition at line 71 of file G4P2Messenger.hh.

Referenced by G4P2Messenger(), and SetNewValue().

fSetP2YAxisLogCmd

std::unique_ptr<G4UIcommand> G4P2Messenger::fSetP2YAxisLogCmd

private

Definition at line 74 of file G4P2Messenger.hh.

Referenced by G4P2Messenger(), and SetNewValue().

fSetP2YCmd

std::unique_ptr<G4UIcommand> G4P2Messenger::fSetP2YCmd

private

Definition at line 67 of file G4P2Messenger.hh.

Referenced by G4P2Messenger(), and SetNewValue().

fSetP2ZAxisCmd

std::unique_ptr<G4UIcommand> G4P2Messenger::fSetP2ZAxisCmd

private

Definition at line 72 of file G4P2Messenger.hh.

Referenced by G4P2Messenger(), and SetNewValue().

fSetP2ZAxisLogCmd

std::unique_ptr<G4UIcommand> G4P2Messenger::fSetP2ZAxisLogCmd

private

Definition at line 75 of file G4P2Messenger.hh.

Referenced by G4P2Messenger(), and SetNewValue().

fSetP2ZCmd

std::unique_ptr<G4UIcommand> G4P2Messenger::fSetP2ZCmd

private

Definition at line 68 of file G4P2Messenger.hh.

Referenced by G4P2Messenger(), and SetNewValue().

fXData

G4AnalysisMessengerHelper::BinData G4P2Messenger::fXData

private

Definition at line 79 of file G4P2Messenger.hh.

Referenced by SetNewValue().

fXId

G4int G4P2Messenger::fXId { G4Analysis::kInvalidId }

private

Definition at line 77 of file G4P2Messenger.hh.

Referenced by SetNewValue().

fYData

G4AnalysisMessengerHelper::BinData G4P2Messenger::fYData

private

Definition at line 80 of file G4P2Messenger.hh.

Referenced by SetNewValue().

fYId

G4int G4P2Messenger::fYId { G4Analysis::kInvalidId }

private

Definition at line 78 of file G4P2Messenger.hh.

Referenced by SetNewValue().

---

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

• source/analysis/management/include/G4P2Messenger.hh
• source/analysis/management/src/G4P2Messenger.cc