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