include/Geant4/G4UIcmdWithADouble.hh

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 // G4UIcmdWithADouble
0027 //
0028 // Class description:
0029 //
0030 // A concrete class of G4UIcommand. The command defined by this class
0031 // takes a double value.
0032 // General information of G4UIcommand is given in G4UIcommand.hh
0033
0034 // Author: M.Asai, 1998
0035 // --------------------------------------------------------------------
0036 #ifndef G4UIcmdWithADouble_hh
0037 #define G4UIcmdWithADouble_hh 1
0038
0039 #include "G4UIcommand.hh"
0040
0041 class G4UIcmdWithADouble : public G4UIcommand
0042 {
0043   public:
0044     // Constructor. The command string with full path directory
0045     // and the pointer to the messenger must be given
0046     G4UIcmdWithADouble(const char* theCommandPath, G4UImessenger* theMessenger);
0047
0048     // Set the parameter name. The name is used by the range checking.
0049     // If "omittable" is set as true, the user of this command can omit
0050     // the value when the command is applied. If "omittable" is false,
0051     // the user must supply a double value.
0052     // "currentAsDefault" flag is valid only if "omittable" is true. If this
0053     // flag is true, the current value is used as the default value when the
0054     // user omits the parameter. If this flag is false, the value given by
0055     // the next SetDefaultValue() method is used
0056     void SetParameterName(const char* theName, G4bool omittable, G4bool currentAsDefault = false);
0057
0058     // Set the default value of the parameter. This default value is used
0059     // when the user of this command omits the parameter value, and
0060     // "omittable" is true and "currentAsDefault" is false
0061     void SetDefaultValue(G4double defVal);
0062
0063     // Convert string which represents a double value to a double
0064     static G4double GetNewDoubleValue(const char* paramString);
0065 };
0066
0067 #endif