Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/intercoms/include/G4UIcmdWithADouble.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 ]

Diff markup

Differences between /intercoms/include/G4UIcmdWithADouble.hh (Version 11.3.0) and /intercoms/include/G4UIcmdWithADouble.hh (Version 11.1.1)


  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 // G4UIcmdWithADouble                              26 // G4UIcmdWithADouble
 27 //                                                 27 //
 28 // Class description:                              28 // Class description:
 29 //                                                 29 //
 30 // A concrete class of G4UIcommand. The comman     30 // A concrete class of G4UIcommand. The command defined by this class
 31 // takes a double value.                           31 // takes a double value.
 32 // General information of G4UIcommand is given     32 // General information of G4UIcommand is given in G4UIcommand.hh
 33                                                    33 
 34 // Author: M.Asai, 1998                            34 // Author: M.Asai, 1998
 35 // -------------------------------------------     35 // --------------------------------------------------------------------
 36 #ifndef G4UIcmdWithADouble_hh                      36 #ifndef G4UIcmdWithADouble_hh
 37 #define G4UIcmdWithADouble_hh 1                    37 #define G4UIcmdWithADouble_hh 1
 38                                                    38 
 39 #include "G4UIcommand.hh"                          39 #include "G4UIcommand.hh"
 40                                                    40 
 41 class G4UIcmdWithADouble : public G4UIcommand      41 class G4UIcmdWithADouble : public G4UIcommand
 42 {                                                  42 {
 43   public:                                          43   public:
 44     // Constructor. The command string with fu <<  44 
 45     // and the pointer to the messenger must b << 
 46     G4UIcmdWithADouble(const char* theCommandP     45     G4UIcmdWithADouble(const char* theCommandPath, G4UImessenger* theMessenger);
                                                   >>  46       // Constructor. The command string with full path directory
                                                   >>  47       // and the pointer to the messenger must be given
 47                                                    48 
 48     // Set the parameter name. The name is use <<  49     static G4double GetNewDoubleValue(const char* paramString);
 49     // If "omittable" is set as true, the user <<  50       // Convert string which represents a double value to a double
 50     // the value when the command is applied.  << 
 51     // the user must supply a double value.    << 
 52     // "currentAsDefault" flag is valid only i << 
 53     // flag is true, the current value is used << 
 54     // user omits the parameter. If this flag  << 
 55     // the next SetDefaultValue() method is us << 
 56     void SetParameterName(const char* theName, << 
 57                                                    51 
 58     // Set the default value of the parameter. <<  52     void SetParameterName(const char* theName, G4bool omittable,
 59     // when the user of this command omits the <<  53                           G4bool currentAsDefault = false);
 60     // "omittable" is true and "currentAsDefau <<  54       // Set the parameter name. The name is used by the range checking.
 61     void SetDefaultValue(G4double defVal);     <<  55       // If "omittable" is set as true, the user of this command can omit
                                                   >>  56       // the value when the command is applied. If "omittable" is false,
                                                   >>  57       // the user must supply a double value.
                                                   >>  58       // "currentAsDefault" flag is valid only if "omittable" is true. If this
                                                   >>  59       // flag is true, the current value is used as the default value when the
                                                   >>  60       // user omits the parameter. If this flag is false, the value given by
                                                   >>  61       // the next SetDefaultValue() method is used
 62                                                    62 
 63     // Convert string which represents a doubl <<  63     void SetDefaultValue(G4double defVal);
 64     static G4double GetNewDoubleValue(const ch <<  64       // Set the default value of the parameter. This default value is used
                                                   >>  65       // when the user of this command omits the parameter value, and
                                                   >>  66       // "omittable" is true and "currentAsDefault" is false
 65 };                                                 67 };
 66                                                    68 
 67 #endif                                             69 #endif
 68                                                    70