| 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 batch plotting.
28 // It implements commands in /analysis/plot directory.
29 //
30 // Author: Ivana Hrivnacova, 21/10/2015 (ivana@ipno.in2p3.fr)
31
32 #ifndef G4PlotMessenger_h
33 #define G4PlotMessenger_h 1
34
35 #include "G4UImessenger.hh"
36 #include "globals.hh"
37
38 #include <memory>
39 #include <string_view>
40
41 class G4PlotParameters;
42 class G4UIdirectory;
43 class G4UIcommand;
44 class G4UIcmdWithAString;
45 class G4UIparameter;
46
47 class G4PlotMessenger : public G4UImessenger
48 {
49 public:
50 explicit G4PlotMessenger(G4PlotParameters* plotParameters);
51 G4PlotMessenger() = delete;
52 ~G4PlotMessenger() override;
53
54 // Methods
55 void SetNewValue(G4UIcommand* command, G4String value) final;
56
57 private:
58 // Helper functions
59 template <typename CMD>
60 std::unique_ptr<CMD> CreateCommand(G4String name, G4String guidance);
61 void AddIntParameter(
62 G4UIcommand& command, G4String name, G4String guidance, G4String range = "");
63
64 // Functions to create commands
65 void SetStyleCmd();
66 void SetLayoutCmd();
67 void SetDimensionsCmd();
68
69 // constants
70 static constexpr std::string_view fkClass { "G4PlotMessenger" };
71
72 // Data members
73 G4PlotParameters* fPlotParameters { nullptr }; ///< Associated class
74 std::unique_ptr<G4UIdirectory> fDirectory;
75
76 std::unique_ptr<G4UIcommand> fSetLayoutCmd;
77 std::unique_ptr<G4UIcommand> fSetDimensionsCmd;
78 std::unique_ptr<G4UIcmdWithAString> fSetStyleCmd;
79 };
80
81 //_____________________________________________________________________________
82 template <typename CMD>
83 std::unique_ptr<CMD> G4PlotMessenger::CreateCommand(
84 G4String name, G4String guidance)
85 {
86 G4String fullName = "/analysis/plot/" + name;
87
88 auto command = std::make_unique<CMD>(fullName, this);
89 command->SetGuidance(guidance.c_str());
90 command->AvailableForStates(G4State_PreInit, G4State_Idle);
91
92 return command;
93 }
94
95 #endif
96
97