| Geant4 Cross Reference |
>> 1 // This code implementation is the intellectual property of
>> 2 // the GEANT4 collaboration.
1 // 3 //
2 // ******************************************* << 4 // By copying, distributing or modifying the Program (or any work
3 // * License and Disclaimer << 5 // based on the Program) you indicate your acceptance of this statement,
4 // * << 6 // and all its terms.
5 // * The Geant4 software is copyright of th <<
6 // * the Geant4 Collaboration. It is provided <<
7 // * conditions of the Geant4 Software License <<
8 // * LICENSE and available at http://cern.ch/ <<
9 // * include a list of copyright holders. <<
10 // * <<
11 // * Neither the authors of this software syst <<
12 // * institutes,nor the agencies providing fin <<
13 // * work make any representation or warran <<
14 // * regarding this software system or assum <<
15 // * use. Please see the license in the file <<
16 // * for the full disclaimer and the limitatio <<
17 // * <<
18 // * This code implementation is the result <<
19 // * technical work of the GEANT4 collaboratio <<
20 // * By using, copying, modifying or distri <<
21 // * any work based on the software) you ag <<
22 // * use in resulting scientific publicati <<
23 // * acceptance of all terms of the Geant4 Sof <<
24 // ******************************************* <<
25 // 7 //
26 // G4UIcmdWith3VectorAndUnit << 8 // $Id: G4UIcmdWith3VectorAndUnit.hh,v 1.3 1999/12/15 14:50:38 gunter Exp $
>> 9 // GEANT4 tag $Name: geant4-03-01 $
27 // 10 //
28 // Class description: <<
29 // 11 //
30 // A concrete class of G4UIcommand. The comman <<
31 // takes three double values and a unit. <<
32 // General information of G4UIcommand is given <<
33 12
34 // Author: M.Asai, 1998 << 13 #ifndef G4UIcmdWith3VectorAndUnit_H
35 // ------------------------------------------- << 14 #define G4UIcmdWith3VectorAndUnit_H 1
36 #ifndef G4UIcmdWith3VectorAndUnit_hh <<
37 #define G4UIcmdWith3VectorAndUnit_hh 1 <<
38 15
39 #include "G4ThreeVector.hh" <<
40 #include "G4UIcommand.hh" 16 #include "G4UIcommand.hh"
>> 17 #include "G4ThreeVector.hh"
>> 18
>> 19 // class description:
>> 20 // A concrete class of G4UIcommand. The command defined by this class
>> 21 // takes three double values and a unit.
>> 22 // General information of G4UIcommand is given in G4UIcommand.hh.
41 23
42 class G4UIcmdWith3VectorAndUnit : public G4UIc 24 class G4UIcmdWith3VectorAndUnit : public G4UIcommand
43 { 25 {
44 public: << 26 public: // with description
45 // Constructor. The command string with fu << 27 G4UIcmdWith3VectorAndUnit
46 // and the pointer to the messenger must b << 28 (const char * theCommandPath,G4UImessenger * theMessenger);
47 G4UIcmdWith3VectorAndUnit(const char* theC << 29 // Constructor. The command string with full path directory
48 << 30 // and the pointer to the messenger must be given.
49 G4int DoIt(const G4String& parameterList) << 31 G4ThreeVector GetNew3VectorValue(G4String paramString);
50 << 32 // Convert string which represents three double values and a unit to
51 // Convert a 3 vector value to a string of << 33 // G4ThreeVector. Values are converted to the Geant4 internal unit.
52 // chosen from the unit category of defaul << 34 G4ThreeVector GetNew3VectorRawValue(G4String paramString);
53 // is defined) or category defined by SetU << 35 // Convert string which represents three double values and a unit to
54 G4String ConvertToStringWithBestUnit(const << 36 // G4ThreeVector. Values are NOT converted to the Geant4 internal unit
55 << 37 // but just as the given string.
56 // Convert a 3 vector value to a string of << 38 G4double GetNewUnitValue(G4String paramString);
57 // chosen from the category defined by Set << 39 // Convert the unit string to the value of the unit. "paramString"
58 // unit is not defined << 40 // must contain three double values AND a unit string.
59 G4String ConvertToStringWithDefaultUnit(co << 41 G4String ConvertToString(G4ThreeVector vec,const char * unitName);
60 << 42 // Convert G4ThreeVector and the unit to a string which represents three
61 // Set the parameter names for three param << 43 // double values and the unit. This method must be used by the messenger
>> 44 // for its GetCurrentValues() method. Values of the three vector will be
>> 45 // devided by the value of the unit.
>> 46 void SetParameterName(const char * theNameX,const char * theNameY,
>> 47 const char * theNameZ,G4bool omittable,G4bool currentAsDefault=false);
>> 48 // Set the parameter names for three parameters. Names are used by
62 // the range checking routine. 49 // the range checking routine.
63 // If "omittable" is set as true, the user << 50 // If "omittable" is set as true, the user of this command can ommit
64 // the value(s) when the command is applie << 51 // the value(s) when he/she applies the command. If "omittable" is false,
65 // the user must supply all three values. 52 // the user must supply all three values.
66 // "currentAsDefault" flag is valid only i << 53 // "currentAsDefault" flag is valid only if "omittable" is true. If this
67 // flag is true, the current values are us << 54 // flag is true, the current values are used as the default values when the
68 // the user omit some of the parameters. I << 55 // user ommit some of the parameters. If this flag is false, the values
69 // given by the next SetDefaultValue() met << 56 // given by the next SetDefaultValue() method are used.
70 void SetParameterName(const char* theNameX << 57 void SetDefaultValue(G4ThreeVector defVal);
71 G4bool omittable, G4 << 58 // Set the default values of the parameters. These default values are used
72 << 59 // when the user of this command ommits some of the parameter values, and
73 // Set the default values of the parameter << 60 // "ommitable" is true and "currentAsDefault" is false.
74 // when the user of this command omits som << 61 void SetUnitCategory(const char * unitCategory);
75 // "omittable" is true and "currentAsDefau << 62 void SetUnitCandidates(const char * candidateList);
76 void SetDefaultValue(const G4ThreeVector& << 63 void SetDefaultUnit(const char * defUnit);
77 << 64 // These three methods must be used alternatively.
78 // These three methods must be used altern << 65 // The user cannot ommit the unit as the fourth parameter of the command if
79 // The user cannot omit the unit as the fo << 66 // SetUnitCategory() or SetUnitCandidates() is used, while the unit defined
80 // if SetUnitCategory() or SetUnitCandidat << 67 // by SetDefaultUnit() method is used as the default unit so that the user can
81 // defined by SetDefaultUnit() method is u << 68 // ommits the fourth parameter.
82 // the user can omit the fourth parameter. << 69 // SetUnitCategory() defines the category of the units which will be accepted.
83 // SetUnitCategory() defines the category << 70 // The available categories can be found in G4SystemOfUnits.hh in global category.
84 // accepted. << 71 // Only the units categorized in the given category are accepted as the fourth
85 // The available categories can be found i << 72 // parameter of the command.
86 // category. Only the units categorized in << 73 // SetUnitCandidates() defines the candidates of units. Units listed in the
87 // as the fourth parameter of the command. << 74 // argument of this method must be separated by space(s). Only the units listed
88 // SetUnitCandidates() defines the candida << 75 // in the candidate list are accepted as the fourth parameter of the command.
89 // the argument of this method must be sep << 76 // SetDefaultUnit() defines the default unit and also it defines the category
90 // units listed in the candidate list are << 77 // of the allowed units. Thus only the units categorized as the given default
91 // of the command. << 78 // 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 }; 79 };
112 80
113 #endif 81 #endif
114 82