[821] | 1 | // |
---|
| 2 | // ******************************************************************** |
---|
| 3 | // * License and Disclaimer * |
---|
| 4 | // * * |
---|
| 5 | // * The Geant4 software is copyright of the Copyright Holders of * |
---|
| 6 | // * the Geant4 Collaboration. It is provided under the terms and * |
---|
| 7 | // * conditions of the Geant4 Software License, included in the file * |
---|
| 8 | // * LICENSE and available at http://cern.ch/geant4/license . These * |
---|
| 9 | // * include a list of copyright holders. * |
---|
| 10 | // * * |
---|
| 11 | // * Neither the authors of this software system, nor their employing * |
---|
| 12 | // * institutes,nor the agencies providing financial support for this * |
---|
| 13 | // * work make any representation or warranty, express or implied, * |
---|
| 14 | // * regarding this software system or assume any liability for its * |
---|
| 15 | // * use. Please see the license in the file LICENSE and URL above * |
---|
| 16 | // * for the full disclaimer and the limitation of liability. * |
---|
| 17 | // * * |
---|
| 18 | // * This code implementation is the result of the scientific and * |
---|
| 19 | // * technical work of the GEANT4 collaboration. * |
---|
| 20 | // * By using, copying, modifying or distributing the software (or * |
---|
| 21 | // * any work based on the software) you agree to acknowledge its * |
---|
| 22 | // * use in resulting scientific publications, and indicate your * |
---|
| 23 | // * acceptance of all terms of the Geant4 Software license. * |
---|
| 24 | // ******************************************************************** |
---|
| 25 | // |
---|
| 26 | // |
---|
| 27 | // $Id: G4UIcmdWithABool.hh,v 1.7 2006/06/29 19:07:51 gunter Exp $ |
---|
[1337] | 28 | // GEANT4 tag $Name: geant4-09-04-beta-01 $ |
---|
[821] | 29 | // |
---|
| 30 | // |
---|
| 31 | |
---|
| 32 | #ifndef G4UIcmdWithABool_H |
---|
| 33 | #define G4UIcmdWithABool_H 1 |
---|
| 34 | |
---|
| 35 | #include "G4UIcommand.hh" |
---|
| 36 | |
---|
| 37 | // class description: |
---|
| 38 | // A concrete class of G4UIcommand. The command defined by this class |
---|
| 39 | // takes a boolean value. Boolean value can be the following notations. |
---|
| 40 | // TRUE : |
---|
| 41 | // 1 t T true TRUE |
---|
| 42 | // FALSE : |
---|
| 43 | // 0 f F false FALSE |
---|
| 44 | // General information of G4UIcommand is given in G4UIcommand.hh. |
---|
| 45 | |
---|
| 46 | class G4UIcmdWithABool : public G4UIcommand |
---|
| 47 | { |
---|
| 48 | public: // with description |
---|
| 49 | G4UIcmdWithABool |
---|
| 50 | (const char * theCommandPath,G4UImessenger * theMessenger); |
---|
| 51 | // Constructor. The command string with full path directory |
---|
| 52 | // and the pointer to the messenger must be given. |
---|
| 53 | static G4bool GetNewBoolValue(const char* paramString); |
---|
| 54 | // Convert string which represents a boolean value to G4bool. |
---|
| 55 | void SetParameterName(const char * theName,G4bool omittable, |
---|
| 56 | G4bool currentAsDefault=false); |
---|
| 57 | // Set the parameter name for a boolean parameter. |
---|
| 58 | // If "omittable" is set as true, the user of this command can ommit |
---|
| 59 | // the value when he/she applies the command. If "omittable" is false, |
---|
| 60 | // the user must supply a boolean value. |
---|
| 61 | // "currentAsDefault" flag is valid only if "omittable" is true. If this |
---|
| 62 | // flag is true, the current value is used as the default value when the |
---|
| 63 | // user ommit the parameter. If this flag is false, the value given by the |
---|
| 64 | // next SetDefaultValue() method is used. |
---|
| 65 | void SetDefaultValue(G4bool defVal); |
---|
| 66 | // Set the default value of the parameter. This default value is used |
---|
| 67 | // when the user of this command ommits the parameter value, and |
---|
| 68 | // "ommitable" is true and "currentAsDefault" is false. |
---|
| 69 | }; |
---|
| 70 | |
---|
| 71 | #endif |
---|