ECCE @ EIC Software
Reference for
ECCE @ EIC
simulation and reconstruction software on GitHub
Home page
Related Pages
Modules
Namespaces
Classes
Files
External Links
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Macros
Groups
Pages
G4UImessenger.hh
Go to the documentation of this file.
Or view
the newest version in sPHENIX GitHub for file G4UImessenger.hh
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
//
28
29
#ifndef G4UImessenger_h
30
#define G4UImessenger_h 1
31
32
#include "
globals.hh
"
33
#include "
G4ios.hh
"
34
#include "
G4UIdirectory.hh
"
35
36
// class description:
37
//
38
// This class is the base class which represents a messenger which maintains
39
// the commands. The user who wants to define some commands must create his/her
40
// own concrete class derived from this class. The user's concrete messenger
41
// must have a responsibility of creating and deleting commands. Also, it must
42
// take care the delivering of the command to the destination class and replying
43
// the current value(s) of the parameter(s).
44
//
45
46
class
G4UImessenger
47
{
48
public
:
// with description
49
G4UImessenger
();
50
G4UImessenger
(
const
G4String
& path,
const
G4String
& dsc,
51
G4bool
commandsToBeBroadcasted =
true
);
52
// Constructor. In the implementation of the concrete messenger, all commands
53
// related to the messenger must be constructed.
54
virtual
~G4UImessenger
();
55
// Destructor. In the implementation of the concrete messenger, all commands
56
// defined in the constructor must be deleted.
57
virtual
G4String
GetCurrentValue
(
G4UIcommand
* command);
58
// The concrete implementation of this method gets the current value(s) of the
59
// parameter(s) of the given command from the destination class, converts the
60
// value(s) to a string, and returns the string. Conversion could be done by
61
// the ConvertToString() method of corresponding G4UIcmdXXX classes if the
62
// the command is an object of these G4UIcmdXXX classes.
63
virtual
void
SetNewValue
(
G4UIcommand
* command,
G4String
newValue);
64
// The concrete implementation of this method converts the string "newValue"
65
// to value(s) of type(s) of the parameter(s). Convert methods corresponding
66
// to the type of the command can be used if the command is an object of
67
// G4UIcmdXXX classes.
68
69
public
:
70
G4bool
operator ==
(
const
G4UImessenger
& messenger)
const
;
71
72
protected
:
73
G4String
ItoS
(
G4int
i);
74
G4String
DtoS
(
G4double
a
);
75
G4String
BtoS
(
G4bool
b
);
76
G4int
StoI
(
G4String
s
);
77
G4long
StoL
(
G4String
s);
78
G4double
StoD
(
G4String
s);
79
G4bool
StoB
(
G4String
s);
80
81
protected
:
82
void
AddUIcommand
(
G4UIcommand
* newCommand);
83
84
// shortcut way for creating directory and commands
85
G4UIdirectory
*
baseDir
;
// used if new object is created
86
G4String
baseDirName
;
// used if dir already exists
87
void
CreateDirectory
(
const
G4String
& path,
const
G4String
& dsc,
88
G4bool
commandsToBeBroadcasted=
true
);
89
template
<
typename
T>
T
*
CreateCommand
(
const
G4String
& cname,
90
const
G4String
& dsc);
91
92
protected
:
93
G4bool
commandsShouldBeInMaster
;
94
public
:
95
G4bool
CommandsShouldBeInMaster
()
const
96
{
return
commandsShouldBeInMaster
; }
97
};
98
99
template
<
typename
T>
100
T
*
G4UImessenger::CreateCommand
(
const
G4String
& cname,
const
G4String
& dsc)
101
{
102
G4String
path;
103
if
( cname(0) !=
'/'
) {
104
path =
baseDirName
+ cname;
105
if
(path(0) !=
'/'
) path =
"/"
+ path;
106
}
107
108
T
* command =
new
T
(path.c_str(),
this
);
109
command-> SetGuidance(dsc.c_str());
110
111
return
command;
112
}
113
114
#endif
geant4
tree
geant4-10.6-release
source
intercoms
include
G4UImessenger.hh
Built by
Jin Huang
. updated:
Wed Jun 29 2022 17:25:21
using
1.8.2 with
ECCE GitHub integration