Geant4  10.03.p02
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
G4UIcmdWithAString.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 //
27 // $Id: G4UIcmdWithAString.hh 67965 2013-03-13 09:35:29Z gcosmo $
28 //
29 //
30 
31 #ifndef G4UIcmdWithAString_H
32 #define G4UIcmdWithAString_H 1
33 
34 #include "G4UIcommand.hh"
35 
36 // class description:
37 // A concrete class of G4UIcommand. The command defined by this class
38 // takes a string. Incase the parameter string contains space(s), it
39 // must be enclosed by double-quotations (").
40 // General information of G4UIcommand is given in G4UIcommand.hh.
41 
43 {
44  public: // with description
46  (const char * theCommandPath,G4UImessenger * theMessenger);
47  // Constructor. The command string with full path directory
48  // and the pointer to the messenger must be given.
49  void SetParameterName(const char * theName,G4bool omittable,
50  G4bool currentAsDefault=false);
51  // Set the parameter name.
52  // If "omittable" is set as true, the user of this command can ommit
53  // the value when he/she applies the command. If "omittable" is false,
54  // the user must supply the parameter string.
55  // "currentAsDefault" flag is valid only if "omittable" is true. If this
56  // flag is true, the current value is used as the default value when the
57  // user ommit the parameter. If this flag is false, the value given by the
58  // next SetDefaultValue() method is used.
59  void SetCandidates(const char * candidateList);
60  // Defines the candidates of the parameter string. Candidates listed in
61  // the argument must be separated by space(s).
62  void SetDefaultValue(const char * defVal);
63  // Set the default value of the parameter. This default value is used
64  // when the user of this command ommits the parameter value, and
65  // "ommitable" is true and "curreutAsDefault" is false.
66 };
67 
68 #endif
void SetParameterName(const char *theName, G4bool omittable, G4bool currentAsDefault=false)
G4UIcmdWithAString(const char *theCommandPath, G4UImessenger *theMessenger)
bool G4bool
Definition: G4Types.hh:79
void SetDefaultValue(const char *defVal)
void SetCandidates(const char *candidateList)