Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/analysis/management/src/G4AnalysisMessenger.cc

Version: [ ReleaseNotes ] [ 1.0 ] [ 1.1 ] [ 2.0 ] [ 3.0 ] [ 3.1 ] [ 3.2 ] [ 4.0 ] [ 4.0.p1 ] [ 4.0.p2 ] [ 4.1 ] [ 4.1.p1 ] [ 5.0 ] [ 5.0.p1 ] [ 5.1 ] [ 5.1.p1 ] [ 5.2 ] [ 5.2.p1 ] [ 5.2.p2 ] [ 6.0 ] [ 6.0.p1 ] [ 6.1 ] [ 6.2 ] [ 6.2.p1 ] [ 6.2.p2 ] [ 7.0 ] [ 7.0.p1 ] [ 7.1 ] [ 7.1.p1 ] [ 8.0 ] [ 8.0.p1 ] [ 8.1 ] [ 8.1.p1 ] [ 8.1.p2 ] [ 8.2 ] [ 8.2.p1 ] [ 8.3 ] [ 8.3.p1 ] [ 8.3.p2 ] [ 9.0 ] [ 9.0.p1 ] [ 9.0.p2 ] [ 9.1 ] [ 9.1.p1 ] [ 9.1.p2 ] [ 9.1.p3 ] [ 9.2 ] [ 9.2.p1 ] [ 9.2.p2 ] [ 9.2.p3 ] [ 9.2.p4 ] [ 9.3 ] [ 9.3.p1 ] [ 9.3.p2 ] [ 9.4 ] [ 9.4.p1 ] [ 9.4.p2 ] [ 9.4.p3 ] [ 9.4.p4 ] [ 9.5 ] [ 9.5.p1 ] [ 9.5.p2 ] [ 9.6 ] [ 9.6.p1 ] [ 9.6.p2 ] [ 9.6.p3 ] [ 9.6.p4 ] [ 10.0 ] [ 10.0.p1 ] [ 10.0.p2 ] [ 10.0.p3 ] [ 10.0.p4 ] [ 10.1 ] [ 10.1.p1 ] [ 10.1.p2 ] [ 10.1.p3 ] [ 10.2 ] [ 10.2.p1 ] [ 10.2.p2 ] [ 10.2.p3 ] [ 10.3 ] [ 10.3.p1 ] [ 10.3.p2 ] [ 10.3.p3 ] [ 10.4 ] [ 10.4.p1 ] [ 10.4.p2 ] [ 10.4.p3 ] [ 10.5 ] [ 10.5.p1 ] [ 10.6 ] [ 10.6.p1 ] [ 10.6.p2 ] [ 10.6.p3 ] [ 10.7 ] [ 10.7.p1 ] [ 10.7.p2 ] [ 10.7.p3 ] [ 10.7.p4 ] [ 11.0 ] [ 11.0.p1 ] [ 11.0.p2 ] [ 11.0.p3, ] [ 11.0.p4 ] [ 11.1 ] [ 11.1.1 ] [ 11.1.2 ] [ 11.1.3 ] [ 11.2 ] [ 11.2.1 ] [ 11.2.2 ] [ 11.3.0 ]

Diff markup

Differences between /analysis/management/src/G4AnalysisMessenger.cc (Version 11.3.0) and /analysis/management/src/G4AnalysisMessenger.cc (Version 11.2.1)


  1 //                                                  1 //
  2 // *******************************************      2 // ********************************************************************
  3 // * License and Disclaimer                         3 // * License and Disclaimer                                           *
  4 // *                                                4 // *                                                                  *
  5 // * The  Geant4 software  is  copyright of th      5 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
  6 // * the Geant4 Collaboration.  It is provided      6 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
  7 // * conditions of the Geant4 Software License      7 // * conditions of the Geant4 Software License,  included in the file *
  8 // * LICENSE and available at  http://cern.ch/      8 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
  9 // * include a list of copyright holders.           9 // * include a list of copyright holders.                             *
 10 // *                                               10 // *                                                                  *
 11 // * Neither the authors of this software syst     11 // * Neither the authors of this software system, nor their employing *
 12 // * institutes,nor the agencies providing fin     12 // * institutes,nor the agencies providing financial support for this *
 13 // * work  make  any representation or  warran     13 // * work  make  any representation or  warranty, express or implied, *
 14 // * regarding  this  software system or assum     14 // * regarding  this  software system or assume any liability for its *
 15 // * use.  Please see the license in the file      15 // * use.  Please see the license in the file  LICENSE  and URL above *
 16 // * for the full disclaimer and the limitatio     16 // * for the full disclaimer and the limitation of liability.         *
 17 // *                                               17 // *                                                                  *
 18 // * This  code  implementation is the result      18 // * This  code  implementation is the result of  the  scientific and *
 19 // * technical work of the GEANT4 collaboratio     19 // * technical work of the GEANT4 collaboration.                      *
 20 // * By using,  copying,  modifying or  distri     20 // * By using,  copying,  modifying or  distributing the software (or *
 21 // * any work based  on the software)  you  ag     21 // * any work based  on the software)  you  agree  to acknowledge its *
 22 // * use  in  resulting  scientific  publicati     22 // * use  in  resulting  scientific  publications,  and indicate your *
 23 // * acceptance of all terms of the Geant4 Sof     23 // * acceptance of all terms of the Geant4 Software license.          *
 24 // *******************************************     24 // ********************************************************************
 25 //                                                 25 //
 26                                                    26 
 27 // Author: Ivana Hrivnacova, 24/06/2013  (ivan     27 // Author: Ivana Hrivnacova, 24/06/2013  (ivana@ipno.in2p3.fr)
 28                                                    28 
 29 #include "G4AnalysisMessenger.hh"                  29 #include "G4AnalysisMessenger.hh"
 30 #include "G4VAnalysisManager.hh"                   30 #include "G4VAnalysisManager.hh"
 31 #include "G4NtupleMessenger.hh"                    31 #include "G4NtupleMessenger.hh"
 32                                                    32 
 33 #include "G4UIcmdWithABool.hh"                     33 #include "G4UIcmdWithABool.hh"
 34 #include "G4UIcmdWithAnInteger.hh"                 34 #include "G4UIcmdWithAnInteger.hh"
 35 #include "G4UIcmdWithAString.hh"                   35 #include "G4UIcmdWithAString.hh"
 36 #include "G4UIcmdWithoutParameter.hh"              36 #include "G4UIcmdWithoutParameter.hh"
 37 #include "G4Threading.hh"                          37 #include "G4Threading.hh"
 38                                                    38 
 39 using namespace G4Analysis;                        39 using namespace G4Analysis;
 40                                                    40 
 41 //____________________________________________     41 //_____________________________________________________________________________
 42 G4AnalysisMessenger::G4AnalysisMessenger(G4VAn     42 G4AnalysisMessenger::G4AnalysisMessenger(G4VAnalysisManager* manager)
 43   : fManager(manager)                              43   : fManager(manager)
 44 {                                                  44 {
 45   fAnalysisDir = std::make_unique<G4UIdirector     45   fAnalysisDir = std::make_unique<G4UIdirectory>("/analysis/");
 46   fAnalysisDir->SetGuidance("analysis control"     46   fAnalysisDir->SetGuidance("analysis control");
 47                                                    47 
 48   fOpenFileCmd = CreateCommand<G4UIcmdWithAStr     48   fOpenFileCmd = CreateCommand<G4UIcmdWithAString>(
 49     "openFile", "Open analysis file", "FileNam     49     "openFile", "Open analysis file", "FileName", true);
 50   fOpenFileCmd->SetDefaultValue("");               50   fOpenFileCmd->SetDefaultValue("");
 51   fOpenFileCmd->SetToBeBroadcasted(true);          51   fOpenFileCmd->SetToBeBroadcasted(true);
 52                                                    52 
 53   fWriteCmd = CreateCommandWithoutParameter(       53   fWriteCmd = CreateCommandWithoutParameter(
 54     "write", "Write analysis data.");              54     "write", "Write analysis data.");
 55   fWriteCmd->SetToBeBroadcasted(false);            55   fWriteCmd->SetToBeBroadcasted(false);
 56                                                    56 
 57   fResetCmd = CreateCommandWithoutParameter(       57   fResetCmd = CreateCommandWithoutParameter(
 58     "reset", "Reset analysis data.");              58     "reset", "Reset analysis data.");
 59   fResetCmd->SetToBeBroadcasted(false);            59   fResetCmd->SetToBeBroadcasted(false);
 60                                                    60 
 61   fCloseFileCmd = CreateCommand<G4UIcmdWithABo     61   fCloseFileCmd = CreateCommand<G4UIcmdWithABool>(
 62     "closeFile", "Close analysis file and (opt     62     "closeFile", "Close analysis file and (optionally) reset data.", "IsReset", true);
 63   fCloseFileCmd->SetDefaultValue(true);            63   fCloseFileCmd->SetDefaultValue(true);
 64   fCloseFileCmd->SetToBeBroadcasted(false);        64   fCloseFileCmd->SetToBeBroadcasted(false);
 65                                                    65 
 66   fListCmd = CreateCommand<G4UIcmdWithABool>(      66   fListCmd = CreateCommand<G4UIcmdWithABool>(
 67     "list", "List all/activate analysis object     67     "list", "List all/activate analysis objects.", "OnlyIfActive", true);
 68   fListCmd->SetDefaultValue(true);                 68   fListCmd->SetDefaultValue(true);
 69                                                    69 
 70   fSetDefaultFileTypeCmd = CreateCommand<G4UIc     70   fSetDefaultFileTypeCmd = CreateCommand<G4UIcmdWithAString>(
 71     "setDefaultFileType", "Set default output      71     "setDefaultFileType", "Set default output file type", "DefaultFileType", false);
 72 #ifdef TOOLS_USE_HDF5                              72 #ifdef TOOLS_USE_HDF5
 73   fSetDefaultFileTypeCmd->SetCandidates("csv h     73   fSetDefaultFileTypeCmd->SetCandidates("csv hdf5 root xml");
 74 #else                                              74 #else
 75   fSetDefaultFileTypeCmd->SetCandidates("csv r     75   fSetDefaultFileTypeCmd->SetCandidates("csv root xml");
 76 #endif                                             76 #endif
 77                                                    77 
 78   fSetActivationCmd = CreateCommand<G4UIcmdWit     78   fSetActivationCmd = CreateCommand<G4UIcmdWithABool>(
 79     "setActivation",                               79     "setActivation",
 80     "Set activation. \n"                           80     "Set activation. \n"
 81     "When this option is enabled, only the his     81     "When this option is enabled, only the histograms marked as activated\n"
 82     "are returned, filled or saved on file.\n"     82     "are returned, filled or saved on file.\n"
 83     "No warning is issued when Get or Fill is      83     "No warning is issued when Get or Fill is called on inactive histogram.",
 84     "Activation");                                 84     "Activation");
 85                                                    85 
 86   fVerboseCmd = CreateCommand<G4UIcmdWithAnInt     86   fVerboseCmd = CreateCommand<G4UIcmdWithAnInteger>(
 87     "verbose", "Set verbose level", "VerboseLe     87     "verbose", "Set verbose level", "VerboseLevel");
 88   fVerboseCmd->SetRange("VerboseLevel>=0 && Ve     88   fVerboseCmd->SetRange("VerboseLevel>=0 && VerboseLevel<=4");
 89                                                    89 
 90   fCompressionCmd = CreateCommand<G4UIcmdWithA     90   fCompressionCmd = CreateCommand<G4UIcmdWithAnInteger>(
 91     "compression", "Set compression level", "C     91     "compression", "Set compression level", "CompressionLevel");
 92   fCompressionCmd->SetRange("CompressionLevel>     92   fCompressionCmd->SetRange("CompressionLevel>=0 && CompressionLevel<=4");
 93                                                    93 
 94   fSetFileNameCmd = CreateCommand<G4UIcmdWithA     94   fSetFileNameCmd = CreateCommand<G4UIcmdWithAString>(
 95     "setFileName", "Set name for the histogram     95     "setFileName", "Set name for the histograms & ntuple file", "Filename");
 96                                                    96 
 97   fSetHistoDirNameCmd = CreateCommand<G4UIcmdW     97   fSetHistoDirNameCmd = CreateCommand<G4UIcmdWithAString>(
 98     "setHistoDirName", "Set name for the histo     98     "setHistoDirName", "Set name for the histograms directory", "HistoDirName");
 99                                                    99 
100   fSetNtupleDirNameCmd = CreateCommand<G4UIcmd    100   fSetNtupleDirNameCmd = CreateCommand<G4UIcmdWithAString>(
101     "setNtupleDirName", "Set name for the ntup    101     "setNtupleDirName", "Set name for the ntuple directory", "NtupleDirName");
102                                                   102 
103   fNtupleMessenger = std::make_unique<G4Ntuple    103   fNtupleMessenger = std::make_unique<G4NtupleMessenger>(manager);
104 }                                                 104 }
105                                                   105 
106 //____________________________________________    106 //_____________________________________________________________________________
107 G4AnalysisMessenger::~G4AnalysisMessenger() =     107 G4AnalysisMessenger::~G4AnalysisMessenger() = default;
108                                                   108 
109 //                                                109 //
110 // private functions                              110 // private functions
111 //                                                111 //
112                                                   112 
113                                                   113 
114 //____________________________________________    114 //_____________________________________________________________________________
115 std::unique_ptr<G4UIcmdWithoutParameter>          115 std::unique_ptr<G4UIcmdWithoutParameter>
116 G4AnalysisMessenger::CreateCommandWithoutParam    116 G4AnalysisMessenger::CreateCommandWithoutParameter(
117   G4String name, G4String guidance)               117   G4String name, G4String guidance)
118 {                                                 118 {
119   G4String fullName = "/analysis/" + name;        119   G4String fullName = "/analysis/" + name;
120                                                   120 
121   auto command = std::make_unique<G4UIcmdWitho    121   auto command = std::make_unique<G4UIcmdWithoutParameter>(fullName, this);
122   command->SetGuidance(guidance.c_str());         122   command->SetGuidance(guidance.c_str());
123   command->AvailableForStates(G4State_PreInit,    123   command->AvailableForStates(G4State_PreInit, G4State_Idle);
124                                                   124 
125   return command;                                 125   return command;
126 }                                                 126 }
127                                                   127 
128 //                                                128 //
129 // public functions                               129 // public functions
130 //                                                130 //
131                                                   131 
132 //____________________________________________    132 //_____________________________________________________________________________
133 void G4AnalysisMessenger::SetNewValue(G4UIcomm    133 void G4AnalysisMessenger::SetNewValue(G4UIcommand* command, G4String newValues)
134 {                                                 134 {
135   if ( command == fOpenFileCmd.get() ) {          135   if ( command == fOpenFileCmd.get() ) {
136     // G4cout << "Calling OpenFile from comman    136     // G4cout << "Calling OpenFile from command for " << fManager << G4endl;
137     fManager->OpenFile(newValues);                137     fManager->OpenFile(newValues);
138     return;                                       138     return;
139   }                                               139   }
140                                                   140 
141   if ( command == fWriteCmd.get() ) {             141   if ( command == fWriteCmd.get() ) {
142     fManager->WriteFromUI();                      142     fManager->WriteFromUI();
143     return;                                       143     return;
144   }                                               144   }
145                                                   145 
146   if ( command == fResetCmd.get() ) {             146   if ( command == fResetCmd.get() ) {
147     fManager->ResetFromUI();                      147     fManager->ResetFromUI();
148     return;                                       148     return;
149   }                                               149   }
150                                                   150 
151   if ( command == fCloseFileCmd.get() ) {         151   if ( command == fCloseFileCmd.get() ) {
152     fManager->CloseFileFromUI(fCloseFileCmd->G    152     fManager->CloseFileFromUI(fCloseFileCmd->GetNewBoolValue(newValues));
153     return;                                       153     return;
154   }                                               154   }
155                                                   155 
156   if ( command == fListCmd.get() ) {              156   if ( command == fListCmd.get() ) {
157     fManager->List(fListCmd->GetNewBoolValue(n    157     fManager->List(fListCmd->GetNewBoolValue(newValues));
158     return;                                       158     return;
159   }                                               159   }
160                                                   160 
161   if ( command == fSetDefaultFileTypeCmd.get()    161   if ( command == fSetDefaultFileTypeCmd.get() ) {
162     fManager->SetDefaultFileType(newValues);      162     fManager->SetDefaultFileType(newValues);
163     return;                                       163     return;
164   }                                               164   }
165                                                   165 
166   if ( command == fSetActivationCmd.get() ) {     166   if ( command == fSetActivationCmd.get() ) {
167     fManager->SetActivation(fSetActivationCmd-    167     fManager->SetActivation(fSetActivationCmd->GetNewBoolValue(newValues));
168     return;                                       168     return;
169   }                                               169   }
170                                                   170 
171   if ( command == fVerboseCmd.get() ) {           171   if ( command == fVerboseCmd.get() ) {
172     fManager->SetVerboseLevel(fVerboseCmd->Get    172     fManager->SetVerboseLevel(fVerboseCmd->GetNewIntValue(newValues));
173     return;                                       173     return;
174   }                                               174   }
175                                                   175 
176   if ( command == fCompressionCmd.get() ) {       176   if ( command == fCompressionCmd.get() ) {
177     fManager->SetCompressionLevel(fCompression    177     fManager->SetCompressionLevel(fCompressionCmd->GetNewIntValue(newValues));
178     return;                                       178     return;
179   }                                               179   }
180                                                   180 
181   if ( command == fSetFileNameCmd.get() ) {       181   if ( command == fSetFileNameCmd.get() ) {
182     fManager->SetFileName(newValues);             182     fManager->SetFileName(newValues);
183     return;                                       183     return;
184   }                                               184   }
185                                                   185 
186   if ( command == fSetHistoDirNameCmd.get() )     186   if ( command == fSetHistoDirNameCmd.get() ) {
187     fManager->SetHistoDirectoryName(newValues)    187     fManager->SetHistoDirectoryName(newValues);
188     return;                                       188     return;
189   }                                               189   }
190                                                   190 
191   if ( command == fSetNtupleDirNameCmd.get() )    191   if ( command == fSetNtupleDirNameCmd.get() ) {
192     fManager->SetNtupleDirectoryName(newValues    192     fManager->SetNtupleDirectoryName(newValues);
193     return;                                       193     return;
194   }                                               194   }
195 }                                                 195 }
196                                                   196