Geant4 Cross Reference |
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 // G4UIcmdWithABool << 27 // 26 // 28 // Class description: << 27 // $Id: G4UIcmdWithABool.hh 67965 2013-03-13 09:35:29Z gcosmo $ >> 28 // 29 // 29 // 30 // A concrete class of G4UIcommand. The comman << 31 // takes a Boolean value. Boolean value can be << 32 // TRUE : << 33 // 1 t T true TRUE << 34 // FALSE : << 35 // 0 f F false FALSE << 36 // General information of G4UIcommand is given << 37 30 38 // Author: M.Asai, 1998 << 31 #ifndef G4UIcmdWithABool_H 39 // ------------------------------------------- << 32 #define G4UIcmdWithABool_H 1 40 #ifndef G4UIcmdWithABool_hh << 41 #define G4UIcmdWithABool_hh 1 << 42 33 43 #include "G4UIcommand.hh" 34 #include "G4UIcommand.hh" 44 35 >> 36 // class description: >> 37 // A concrete class of G4UIcommand. The command defined by this class >> 38 // takes a boolean value. Boolean value can be the following notations. >> 39 // TRUE : >> 40 // 1 t T true TRUE >> 41 // FALSE : >> 42 // 0 f F false FALSE >> 43 // General information of G4UIcommand is given in G4UIcommand.hh. >> 44 45 class G4UIcmdWithABool : public G4UIcommand 45 class G4UIcmdWithABool : public G4UIcommand 46 { 46 { 47 public: << 47 public: // with description 48 // Constructor. The command string with fu << 48 G4UIcmdWithABool 49 // and the pointer to the messenger must b << 49 (const char * theCommandPath,G4UImessenger * theMessenger); 50 G4UIcmdWithABool(const char* theCommandPat << 50 // Constructor. The command string with full path directory 51 << 51 // and the pointer to the messenger must be given. 52 // Set the parameter name for a Boolean pa << 53 // If "omittable" is set as true, the user << 54 // the value when the command is applied. << 55 // the user must supply a Boolean value. << 56 // "currentAsDefault" flag is valid only i << 57 // flag is true, the current value is used << 58 // user omits the parameter. If this flag << 59 // next SetDefaultValue() method is used << 60 void SetParameterName(const char* theName, << 61 << 62 // Set the default value of the parameter. << 63 // when the user of this command omits the << 64 // "omittable" is true and "currentAsDefau << 65 void SetDefaultValue(G4bool defVal); << 66 << 67 // Convert string which represents a boole << 68 static G4bool GetNewBoolValue(const char* 52 static G4bool GetNewBoolValue(const char* paramString); >> 53 // Convert string which represents a boolean value to G4bool. >> 54 void SetParameterName(const char * theName,G4bool omittable, >> 55 G4bool currentAsDefault=false); >> 56 // Set the parameter name for a boolean parameter. >> 57 // If "omittable" is set as true, the user of this command can ommit >> 58 // the value when he/she applies the command. If "omittable" is false, >> 59 // the user must supply a boolean value. >> 60 // "currentAsDefault" flag is valid only if "omittable" is true. If this >> 61 // flag is true, the current value is used as the default value when the >> 62 // user ommit the parameter. If this flag is false, the value given by the >> 63 // next SetDefaultValue() method is used. >> 64 void SetDefaultValue(G4bool defVal); >> 65 // Set the default value of the parameter. This default value is used >> 66 // when the user of this command ommits the parameter value, and >> 67 // "ommitable" is true and "currentAsDefault" is false. 69 }; 68 }; 70 69 71 #endif 70 #endif 72 71