| 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 // class G4GlobalMagFieldMessenger
27 //
28 // Class description:
29 //
30 // Global uniform magnetic field messenger class.
31 //
32 // It defines UI commands:
33 // - /globalField/setValue vx vy vz unit
34 // - /globalField/verbose level
35 //
36 // It creates/deletes the global uniform magnetic field and
37 // activates/inactivates it according to the set field value.
38 // The field value can be changed either interactively via
39 // the UI command or via SetFieldValue() function.
40
41 // Author: Ivana Hrivnacova, 28/08/2013 (ivana@ipno.in2p3.fr)
42 // --------------------------------------------------------------------
43 #ifndef G4GlobalMagFieldMessenger_hh
44 #define G4GlobalMagFieldMessenger_hh 1
45
46 #include "globals.hh"
47 #include "G4UImessenger.hh"
48
49 class G4UniformMagField;
50 class G4UIdirectory;
51 class G4UIcmdWith3VectorAndUnit;
52 class G4UIcmdWithAnInteger;
53
54 class G4GlobalMagFieldMessenger : public G4UImessenger
55 {
56 public: // with description
57
58 G4GlobalMagFieldMessenger(const G4ThreeVector& value = G4ThreeVector());
59 ~G4GlobalMagFieldMessenger() override;
60
61 void SetNewValue(G4UIcommand*, G4String) override;
62
63 void SetFieldValue(const G4ThreeVector& value);
64 G4ThreeVector GetFieldValue() const;
65
66 inline void SetVerboseLevel(G4int verboseLevel);
67 inline G4int GetVerboseLevel() const;
68
69 private:
70
71 void SetField(const G4ThreeVector& value, const G4String& inFunction);
72
73 G4UniformMagField* fMagField = nullptr;
74 G4int fVerboseLevel = 0;
75
76 G4UIdirectory* fDirectory = nullptr;
77 G4UIcmdWith3VectorAndUnit* fSetValueCmd = nullptr;
78 G4UIcmdWithAnInteger* fSetVerboseCmd = nullptr;
79 };
80
81 // inline functions
82
83 inline void G4GlobalMagFieldMessenger::SetVerboseLevel(G4int verboseLevel)
84 { fVerboseLevel = verboseLevel; }
85
86 inline G4int G4GlobalMagFieldMessenger::GetVerboseLevel() const
87 { return fVerboseLevel; }
88
89 #endif
90