Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/intercoms/include/G4UIcmdWithADoubleAndUnit.hh

Version: [ ReleaseNotes ] [ 1.0 ] [ 1.1 ] [ 2.0 ] [ 3.0 ] [ 3.1 ] [ 3.2 ] [ 4.0 ] [ 4.0.p1 ] [ 4.0.p2 ] [ 4.1 ] [ 4.1.p1 ] [ 5.0 ] [ 5.0.p1 ] [ 5.1 ] [ 5.1.p1 ] [ 5.2 ] [ 5.2.p1 ] [ 5.2.p2 ] [ 6.0 ] [ 6.0.p1 ] [ 6.1 ] [ 6.2 ] [ 6.2.p1 ] [ 6.2.p2 ] [ 7.0 ] [ 7.0.p1 ] [ 7.1 ] [ 7.1.p1 ] [ 8.0 ] [ 8.0.p1 ] [ 8.1 ] [ 8.1.p1 ] [ 8.1.p2 ] [ 8.2 ] [ 8.2.p1 ] [ 8.3 ] [ 8.3.p1 ] [ 8.3.p2 ] [ 9.0 ] [ 9.0.p1 ] [ 9.0.p2 ] [ 9.1 ] [ 9.1.p1 ] [ 9.1.p2 ] [ 9.1.p3 ] [ 9.2 ] [ 9.2.p1 ] [ 9.2.p2 ] [ 9.2.p3 ] [ 9.2.p4 ] [ 9.3 ] [ 9.3.p1 ] [ 9.3.p2 ] [ 9.4 ] [ 9.4.p1 ] [ 9.4.p2 ] [ 9.4.p3 ] [ 9.4.p4 ] [ 9.5 ] [ 9.5.p1 ] [ 9.5.p2 ] [ 9.6 ] [ 9.6.p1 ] [ 9.6.p2 ] [ 9.6.p3 ] [ 9.6.p4 ] [ 10.0 ] [ 10.0.p1 ] [ 10.0.p2 ] [ 10.0.p3 ] [ 10.0.p4 ] [ 10.1 ] [ 10.1.p1 ] [ 10.1.p2 ] [ 10.1.p3 ] [ 10.2 ] [ 10.2.p1 ] [ 10.2.p2 ] [ 10.2.p3 ] [ 10.3 ] [ 10.3.p1 ] [ 10.3.p2 ] [ 10.3.p3 ] [ 10.4 ] [ 10.4.p1 ] [ 10.4.p2 ] [ 10.4.p3 ] [ 10.5 ] [ 10.5.p1 ] [ 10.6 ] [ 10.6.p1 ] [ 10.6.p2 ] [ 10.6.p3 ] [ 10.7 ] [ 10.7.p1 ] [ 10.7.p2 ] [ 10.7.p3 ] [ 10.7.p4 ] [ 11.0 ] [ 11.0.p1 ] [ 11.0.p2 ] [ 11.0.p3, ] [ 11.0.p4 ] [ 11.1 ] [ 11.1.1 ] [ 11.1.2 ] [ 11.1.3 ] [ 11.2 ] [ 11.2.1 ] [ 11.2.2 ] [ 11.3.0 ]

  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 // G4UIcmdWithADoubleAndUnit
 27 //
 28 // Class description:
 29 //
 30 // A concrete class of G4UIcommand. The command defined by this class
 31 // takes a double value and a unit string.
 32 // General information of G4UIcommand is given in G4UIcommand.hh
 33 
 34 // Author: M.Asai, 1998
 35 // --------------------------------------------------------------------
 36 #ifndef G4UIcmdWithADoubleAndUnit_hh
 37 #define G4UIcmdWithADoubleAndUnit_hh 1
 38 
 39 #include "G4UIcommand.hh"
 40 
 41 class G4UIcmdWithADoubleAndUnit : public G4UIcommand
 42 {
 43   public:
 44     // Constructor. The command string with full path directory
 45     // and the pointer to the messenger must be given
 46     G4UIcmdWithADoubleAndUnit(const char* theCommandPath, G4UImessenger* theMessenger);
 47 
 48     G4int DoIt(const G4String& parameterList) override;
 49 
 50     // Convert a double value to a string of digits and unit. Best unit is
 51     // chosen from the unit category of default unit (in case SetDefaultUnit()
 52     // is defined) or category defined by SetUnitCategory()
 53     G4String ConvertToStringWithBestUnit(G4double val);
 54 
 55     // Convert a double value to a string of digits and unit. Best unit is
 56     // chosen from the category defined by SetUnitCategory() in case default
 57     // unit is not defined
 58     G4String ConvertToStringWithDefaultUnit(G4double val);
 59 
 60     // Set the parameter name for double parameters. Name is used by
 61     // the range checking function.
 62     // If "omittable" is set as true, the user of this command can omit
 63     // the value when the command is applied. If "omittable" is false,
 64     // the user must supply a value.
 65     // "currentAsDefault" flag is valid only if "omittable" is true. If this
 66     // flag is true, the current value is used as the default value when the
 67     // user omits the double parameter. If this flag is false, the value
 68     // given by the next SetDefaultValue() method is used
 69     void SetParameterName(const char* theName, G4bool omittable, G4bool currentAsDefault = false);
 70 
 71     // Set the default value of the parameter. This default value is used
 72     // when the user of this command omits the parameter value, and
 73     // "omittable" is true and "currentAsDefault" is false
 74     void SetDefaultValue(G4double defVal);
 75 
 76     // These three methods must be used alternatively.
 77     // The user cannot omit the unit as the second parameter of the command
 78     // if SetUnitCategory() or SetUnitCandidates() is used, while the unit
 79     // defined by SetDefaultUnit() method is used as the default unit so that
 80     // the user can omit the second parameter.
 81     // SetUnitCategory() defines the category of the units which will be
 82     // accepted.
 83     // The available categories can be found in G4SystemOfUnits.hh in 'global'
 84     // category. Only the units categorized in the given category are accepted
 85     // as the second parameter of the command.
 86     // SetUnitCandidates() defines the candidates of units. Units listed in
 87     // the argument of this method must be separated by space(s). Only the
 88     // units listed in the candidate list are accepted as the second parameter
 89     // of the command.
 90     // SetDefaultUnit() defines the default unit and also defines the category
 91     // of the allowed units. Thus only the units categorized as the given
 92     // default unit will be accepted
 93     void SetUnitCategory(const char* unitCategory);
 94     void SetUnitCandidates(const char* candidateList);
 95     void SetDefaultUnit(const char* defUnit);
 96 
 97     // Convert string which represents a double value and a unit to
 98     // double. Value is converted to the Geant4 internal unit
 99     static G4double GetNewDoubleValue(const char* paramString);
100 
101     // Convert string which represents a double value and a unit to
102     // double. Value is NOT converted to the Geant4 internal unit
103     // but just as the given string
104     static G4double GetNewDoubleRawValue(const char* paramString);
105 
106     // Convert the unit string to the value of the unit. "paramString"
107     // must contain a double value AND a unit string
108     static G4double GetNewUnitValue(const char* paramString);
109 };
110 
111 #endif
112