include/Geant4/G4UIcmdWithABool.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 // G4UIcmdWithABool
0027 //
0028 // Class description:
0029 //
0030 // A concrete class of G4UIcommand. The command defined by this class
0031 // takes a Boolean value. Boolean value can be in the following notations:
0032 //    TRUE :
0033 //       1 t T true TRUE
0034 //    FALSE :
0035 //       0 f F false FALSE
0036 // General information of G4UIcommand is given in G4UIcommand.hh
0037
0038 // Author: M.Asai, 1998
0039 // --------------------------------------------------------------------
0040 #ifndef G4UIcmdWithABool_hh
0041 #define G4UIcmdWithABool_hh 1
0042
0043 #include "G4UIcommand.hh"
0044
0045 class G4UIcmdWithABool : public G4UIcommand
0046 {
0047   public:
0048     // Constructor. The command string with full path directory
0049     // and the pointer to the messenger must be given
0050     G4UIcmdWithABool(const char* theCommandPath, G4UImessenger* theMessenger);
0051
0052     // Set the parameter name for a Boolean parameter.
0053     // If "omittable" is set as true, the user of this command can omit
0054     // the value when the command is applied. If "omittable" is false,
0055     // the user must supply a Boolean value.
0056     // "currentAsDefault" flag is valid only if "omittable" is true. If this
0057     // flag is true, the current value is used as the default value when the
0058     // user omits the parameter. If this flag is false, the value given by the
0059     // next SetDefaultValue() method is used
0060     void SetParameterName(const char* theName, G4bool omittable, G4bool currentAsDefault = false);
0061
0062     // Set the default value of the parameter. This default value is used
0063     // when the user of this command omits the parameter value, and
0064     // "omittable" is true and "currentAsDefault" is false
0065     void SetDefaultValue(G4bool defVal);
0066
0067     // Convert string which represents a boolean value to G4bool
0068     static G4bool GetNewBoolValue(const char* paramString);
0069 };
0070
0071 #endif