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