00001 // 00002 // ******************************************************************** 00003 // * License and Disclaimer * 00004 // * * 00005 // * The Geant4 software is copyright of the Copyright Holders of * 00006 // * the Geant4 Collaboration. It is provided under the terms and * 00007 // * conditions of the Geant4 Software License, included in the file * 00008 // * LICENSE and available at http://cern.ch/geant4/license . These * 00009 // * include a list of copyright holders. * 00010 // * * 00011 // * Neither the authors of this software system, nor their employing * 00012 // * institutes,nor the agencies providing financial support for this * 00013 // * work make any representation or warranty, express or implied, * 00014 // * regarding this software system or assume any liability for its * 00015 // * use. Please see the license in the file LICENSE and URL above * 00016 // * for the full disclaimer and the limitation of liability. * 00017 // * * 00018 // * This code implementation is the result of the scientific and * 00019 // * technical work of the GEANT4 collaboration. * 00020 // * By using, copying, modifying or distributing the software (or * 00021 // * any work based on the software) you agree to acknowledge its * 00022 // * use in resulting scientific publications, and indicate your * 00023 // * acceptance of all terms of the Geant4 Software license. * 00024 // ******************************************************************** 00025 // 00026 // 00027 // $Id$ 00028 // 00029 // 00030 00031 #ifndef G4UIcmdWithABool_H 00032 #define G4UIcmdWithABool_H 1 00033 00034 #include "G4UIcommand.hh" 00035 00036 // class description: 00037 // A concrete class of G4UIcommand. The command defined by this class 00038 // takes a boolean value. Boolean value can be the following notations. 00039 // TRUE : 00040 // 1 t T true TRUE 00041 // FALSE : 00042 // 0 f F false FALSE 00043 // General information of G4UIcommand is given in G4UIcommand.hh. 00044 00045 class G4UIcmdWithABool : public G4UIcommand 00046 { 00047 public: // with description 00048 G4UIcmdWithABool 00049 (const char * theCommandPath,G4UImessenger * theMessenger); 00050 // Constructor. The command string with full path directory 00051 // and the pointer to the messenger must be given. 00052 static G4bool GetNewBoolValue(const char* paramString); 00053 // Convert string which represents a boolean value to G4bool. 00054 void SetParameterName(const char * theName,G4bool omittable, 00055 G4bool currentAsDefault=false); 00056 // Set the parameter name for a boolean parameter. 00057 // If "omittable" is set as true, the user of this command can ommit 00058 // the value when he/she applies the command. If "omittable" is false, 00059 // the user must supply a boolean value. 00060 // "currentAsDefault" flag is valid only if "omittable" is true. If this 00061 // flag is true, the current value is used as the default value when the 00062 // user ommit the parameter. If this flag is false, the value given by the 00063 // next SetDefaultValue() method is used. 00064 void SetDefaultValue(G4bool defVal); 00065 // Set the default value of the parameter. This default value is used 00066 // when the user of this command ommits the parameter value, and 00067 // "ommitable" is true and "currentAsDefault" is false. 00068 }; 00069 00070 #endif