ECCE @ EIC Software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
G4UIcmdWith3Vector.hh
Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file G4UIcmdWith3Vector.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 
30 #ifndef G4UIcmdWith3Vector_H
31 #define G4UIcmdWith3Vector_H 1
32 
33 #include "G4UIcommand.hh"
34 #include "G4ThreeVector.hh"
35 
36 // class description:
37 // A concrete class of G4UIcommand. The command defined by this class
38 // takes three double values.
39 // General information of G4UIcommand is given in G4UIcommand.hh.
40 
42 {
43  public: // with description
45  (const char * theCommandPath,G4UImessenger * theMessenger);
46  // Constructor. The command string with full path directory
47  // and the pointer to the messenger must be given.
48  static G4ThreeVector GetNew3VectorValue(const char* paramString);
49  // Convert string which represents three double values to
50  // G4ThreeVector.
51  void SetParameterName(const char * theNameX,const char * theNameY,
52  const char * theNameZ,G4bool omittable,G4bool currentAsDefault=false);
53  // Set the parameter names for three parameters. Names are used by
54  // the range checking routine.
55  // If "omittable" is set as true, the user of this command can ommit
56  // the value(s) when he/she applies the command. If "omittable" is false,
57  // the user must supply all three values.
58  // "currentAsDefault" flag is valid only if "omittable" is true. If this
59  // flag is true, the current values are used as the default values when the
60  // user ommit some of the parameters. If this flag is false, the values
61  // given by the next SetDefaultValue() method are used.
62  void SetDefaultValue(G4ThreeVector defVal);
63  // Set the default values of the parameters. These default values are used
64  // when the user of this command ommits some of the parameter values, and
65  // "ommitable" is true and "currentAsDefault" is false.
66 };
67 
68 #endif