| Geant4 Cross Reference |
1 //
2 // ********************************************************************
3 // * License and Disclaimer *
4 // * *
5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. *
10 // * *
11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitation of liability. *
17 // * *
18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Software license. *
24 // ********************************************************************
25 //
26
27 // The messenger class for histogram information management.
28 // It implements commands in /analysis/h1 directory.
29 //
30 // Author: Ivana Hrivnacova, 18/06/2013 (ivana@ipno.in2p3.fr)
31
32 #ifndef G4HnMessenger_h
33 #define G4HnMessenger_h 1
34
35 #include "G4UImessenger.hh"
36 #include "globals.hh"
37
38 #include <memory>
39
40 class G4HnManager;
41 class G4UIcommand;
42 class G4UIcmdWithABool;
43 class G4UIcmdWithAString;
44
45 class G4HnMessenger : public G4UImessenger
46 {
47 public:
48 explicit G4HnMessenger(G4HnManager& manager);
49 G4HnMessenger() = delete;
50 ~G4HnMessenger() override;
51
52 // Methods
53 void SetNewValue(G4UIcommand* command, G4String value) final;
54
55 private:
56 // Helper functions
57 G4String GetObjectType() const;
58 template <typename CMD>
59 std::unique_ptr<CMD> CreateCommand(G4String name, G4String guidance);
60 void AddIdParameter(G4UIcommand& command);
61 void AddOptionParameter(G4UIcommand& command, G4String optionName);
62
63 void SetHnAsciiCmd();
64 void SetHnActivationCmd();
65 void SetHnActivationToAllCmd();
66 void SetHnPlottingCmd();
67 void SetHnPlottingToAllCmd();
68 void SetHnFileNameCmd();
69 void SetHnFileNameToAllCmd();
70 std::unique_ptr<G4UIcommand> CreateSetAxisLogCommand(unsigned int ibin);
71
72 // constants
73 static constexpr std::string_view fkClass { "G4HnMessenger" };
74
75 // Data members
76 G4HnManager& fManager; ///< Associated class
77 G4String fHnType;
78 unsigned int fHnDimension;
79 std::unique_ptr<G4UIcommand> fSetAsciiCmd;
80 std::unique_ptr<G4UIcommand> fSetActivationCmd;
81 std::unique_ptr<G4UIcmdWithABool> fSetActivationAllCmd;
82 std::unique_ptr<G4UIcommand> fSetPlottingCmd;
83 std::unique_ptr<G4UIcmdWithABool> fSetPlottingAllCmd;
84 std::unique_ptr<G4UIcommand> fSetFileNameCmd;
85 std::unique_ptr<G4UIcmdWithAString> fSetFileNameAllCmd;
86 std::vector<std::unique_ptr<G4UIcommand>> fSetAxisLogCmd;
87 };
88
89 //_____________________________________________________________________________
90 template <typename CMD>
91 std::unique_ptr<CMD> G4HnMessenger::CreateCommand(
92 G4String name, G4String guidance)
93 {
94 G4String fullName = "/analysis/" + fHnType + "/" + name;
95 G4String fullGuidance = guidance + GetObjectType();
96
97 auto command = std::make_unique<CMD>(fullName, this);
98 command->SetGuidance(fullGuidance);
99 command->AvailableForStates(G4State_PreInit, G4State_Idle);
100
101 return command;
102 }
103
104 #endif
105