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