[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: G4UIcmdWithAString.hh,v 1.5 2006/06/29 19:07:59 gunter Exp $ |
---|
[1228] | 28 | // GEANT4 tag $Name: geant4-09-03 $ |
---|
[821] | 29 | // |
---|
| 30 | // |
---|
| 31 | |
---|
| 32 | #ifndef G4UIcmdWithAString_H |
---|
| 33 | #define G4UIcmdWithAString_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 string. Incase the parameter string contains space(s), it |
---|
| 40 | // must be enclosed by double-quotations ("). |
---|
| 41 | // General information of G4UIcommand is given in G4UIcommand.hh. |
---|
| 42 | |
---|
| 43 | class G4UIcmdWithAString : public G4UIcommand |
---|
| 44 | { |
---|
| 45 | public: // with description |
---|
| 46 | G4UIcmdWithAString |
---|
| 47 | (const char * theCommandPath,G4UImessenger * theMessenger); |
---|
| 48 | // Constructor. The command string with full path directory |
---|
| 49 | // and the pointer to the messenger must be given. |
---|
| 50 | void SetParameterName(const char * theName,G4bool omittable, |
---|
| 51 | G4bool currentAsDefault=false); |
---|
| 52 | // Set the parameter name. |
---|
| 53 | // If "omittable" is set as true, the user of this command can ommit |
---|
| 54 | // the value when he/she applies the command. If "omittable" is false, |
---|
| 55 | // the user must supply the parameter string. |
---|
| 56 | // "currentAsDefault" flag is valid only if "omittable" is true. If this |
---|
| 57 | // flag is true, the current value is used as the default value when the |
---|
| 58 | // user ommit the parameter. If this flag is false, the value given by the |
---|
| 59 | // next SetDefaultValue() method is used. |
---|
| 60 | void SetCandidates(const char * candidateList); |
---|
| 61 | // Defines the candidates of the parameter string. Candidates listed in |
---|
| 62 | // the argument must be separated by space(s). |
---|
| 63 | void SetDefaultValue(const char * defVal); |
---|
| 64 | // Set the default value of the parameter. This default value is used |
---|
| 65 | // when the user of this command ommits the parameter value, and |
---|
| 66 | // "ommitable" is true and "curreutAsDefault" is false. |
---|
| 67 | }; |
---|
| 68 | |
---|
| 69 | #endif |
---|