| Geant4 Cross Reference |
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 // G4UIcmdWith3VectorAndUnit 26 // G4UIcmdWith3VectorAndUnit
27 // 27 //
28 // Class description: 28 // Class description:
29 // 29 //
30 // A concrete class of G4UIcommand. The comman 30 // A concrete class of G4UIcommand. The command defined by this class
31 // takes three double values and a unit. 31 // takes three double values and a unit.
32 // General information of G4UIcommand is given 32 // General information of G4UIcommand is given in G4UIcommand.hh
33 33
34 // Author: M.Asai, 1998 34 // Author: M.Asai, 1998
35 // ------------------------------------------- 35 // --------------------------------------------------------------------
36 #ifndef G4UIcmdWith3VectorAndUnit_hh 36 #ifndef G4UIcmdWith3VectorAndUnit_hh
37 #define G4UIcmdWith3VectorAndUnit_hh 1 37 #define G4UIcmdWith3VectorAndUnit_hh 1
38 38
39 #include "G4ThreeVector.hh" <<
40 #include "G4UIcommand.hh" 39 #include "G4UIcommand.hh"
>> 40 #include "G4ThreeVector.hh"
41 41
42 class G4UIcmdWith3VectorAndUnit : public G4UIc 42 class G4UIcmdWith3VectorAndUnit : public G4UIcommand
43 { 43 {
44 public: 44 public:
45 // Constructor. The command string with fu <<
46 // and the pointer to the messenger must b <<
47 G4UIcmdWith3VectorAndUnit(const char* theC <<
48 <<
49 G4int DoIt(const G4String& parameterList) <<
50 <<
51 // Convert a 3 vector value to a string of <<
52 // chosen from the unit category of defaul <<
53 // is defined) or category defined by SetU <<
54 G4String ConvertToStringWithBestUnit(const <<
55 <<
56 // Convert a 3 vector value to a string of <<
57 // chosen from the category defined by Set <<
58 // unit is not defined <<
59 G4String ConvertToStringWithDefaultUnit(co <<
60 <<
61 // Set the parameter names for three param <<
62 // the range checking routine. <<
63 // If "omittable" is set as true, the user <<
64 // the value(s) when the command is applie <<
65 // the user must supply all three values. <<
66 // "currentAsDefault" flag is valid only i <<
67 // flag is true, the current values are us <<
68 // the user omit some of the parameters. I <<
69 // given by the next SetDefaultValue() met <<
70 void SetParameterName(const char* theNameX <<
71 G4bool omittable, G4 <<
72 <<
73 // Set the default values of the parameter <<
74 // when the user of this command omits som <<
75 // "omittable" is true and "currentAsDefau <<
76 void SetDefaultValue(const G4ThreeVector& <<
77 <<
78 // These three methods must be used altern <<
79 // The user cannot omit the unit as the fo <<
80 // if SetUnitCategory() or SetUnitCandidat <<
81 // defined by SetDefaultUnit() method is u <<
82 // the user can omit the fourth parameter. <<
83 // SetUnitCategory() defines the category <<
84 // accepted. <<
85 // The available categories can be found i <<
86 // category. Only the units categorized in <<
87 // as the fourth parameter of the command. <<
88 // SetUnitCandidates() defines the candida <<
89 // the argument of this method must be sep <<
90 // units listed in the candidate list are <<
91 // of the command. <<
92 // SetDefaultUnit() defines the default un <<
93 // of the allowed units. Thus only the uni <<
94 // default unit will be accepted. <<
95 void SetUnitCategory(const char* unitCateg <<
96 void SetUnitCandidates(const char* candida <<
97 void SetDefaultUnit(const char* defUnit); <<
98 45
99 // Convert string which represents three d << 46 G4UIcmdWith3VectorAndUnit(const char* theCommandPath,
100 // G4ThreeVector. Values are converted to << 47 G4UImessenger* theMessenger);
>> 48 // Constructor. The command string with full path directory
>> 49 // and the pointer to the messenger must be given
>> 50
>> 51 virtual G4int DoIt(G4String parameterList);
>> 52
101 static G4ThreeVector GetNew3VectorValue(co 53 static G4ThreeVector GetNew3VectorValue(const char* paramString);
>> 54 // Convert string which represents three double values and a unit to
>> 55 // G4ThreeVector. Values are converted to the Geant4 internal unit
102 56
103 // Convert string which represents three d <<
104 // G4ThreeVector. Values are NOT converted <<
105 // but just as the given string <<
106 static G4ThreeVector GetNew3VectorRawValue 57 static G4ThreeVector GetNew3VectorRawValue(const char* paramString);
>> 58 // Convert string which represents three double values and a unit to
>> 59 // G4ThreeVector. Values are NOT converted to the Geant4 internal unit
>> 60 // but just as the given string
107 61
108 // Convert the unit string to the value of <<
109 // must contain three double values AND a <<
110 static G4double GetNewUnitValue(const char 62 static G4double GetNewUnitValue(const char* paramString);
>> 63 // Convert the unit string to the value of the unit. "paramString"
>> 64 // must contain three double values AND a unit string
>> 65
>> 66 G4String ConvertToStringWithBestUnit(G4ThreeVector vec);
>> 67 // Convert a 3 vector value to a string of digits and unit. Best unit is
>> 68 // chosen from the unit category of default unit (in case SetDefaultUnit()
>> 69 // is defined) or category defined by SetUnitCategory()
>> 70
>> 71 G4String ConvertToStringWithDefaultUnit(G4ThreeVector vec);
>> 72 // Convert a 3 vector value to a string of digits and unit. Best unit is
>> 73 // chosen from the category defined by SetUnitCategory() in case default
>> 74 // unit is not defined
>> 75
>> 76 void SetParameterName(const char* theNameX, const char* theNameY,
>> 77 const char* theNameZ, G4bool omittable,
>> 78 G4bool currentAsDefault = false);
>> 79 // Set the parameter names for three parameters. Names are used by
>> 80 // the range checking routine.
>> 81 // If "omittable" is set as true, the user of this command can omit
>> 82 // the value(s) when the command is applied. If "omittable" is false,
>> 83 // the user must supply all three values.
>> 84 // "currentAsDefault" flag is valid only if "omittable" is true. If this
>> 85 // flag is true, the current values are used as the default values when
>> 86 // the user omit some of the parameters. If this flag is false, the values
>> 87 // given by the next SetDefaultValue() method are used
>> 88
>> 89 void SetDefaultValue(G4ThreeVector defVal);
>> 90 // Set the default values of the parameters. These default values are used
>> 91 // when the user of this command omits some of the parameter values, and
>> 92 // "omittable" is true and "currentAsDefault" is false
>> 93
>> 94 void SetUnitCategory(const char* unitCategory);
>> 95 void SetUnitCandidates(const char* candidateList);
>> 96 void SetDefaultUnit(const char* defUnit);
>> 97 // These three methods must be used alternatively.
>> 98 // The user cannot omit the unit as the fourth parameter of the command
>> 99 // if SetUnitCategory() or SetUnitCandidates() is used, while the unit
>> 100 // defined by SetDefaultUnit() method is used as the default unit so that
>> 101 // the user can omit the fourth parameter.
>> 102 // SetUnitCategory() defines the category of the units which will be
>> 103 // accepted.
>> 104 // The available categories can be found in G4SystemOfUnits.hh in 'global'
>> 105 // category. Only the units categorized in the given category are accepted
>> 106 // as the fourth parameter of the command.
>> 107 // SetUnitCandidates() defines the candidates of units. Units listed in
>> 108 // the argument of this method must be separated by space(s). Only the
>> 109 // units listed in the candidate list are accepted as the fourth parameter
>> 110 // of the command.
>> 111 // SetDefaultUnit() defines the default unit and also defines the category
>> 112 // of the allowed units. Thus only the units categorized as the given
>> 113 // default unit will be accepted.
111 }; 114 };
112 115
113 #endif 116 #endif
114 117