Gabriele Cosmo
51 lines
2.0 KiB
C++
51 lines
2.0 KiB
C++
// This code implementation is the intellectual property of
|
|
// the GEANT4 collaboration.
|
|
//
|
|
// By copying, distributing or modifying the Program (or any work
|
|
// based on the Program) you indicate your acceptance of this statement,
|
|
// and all its terms.
|
|
//
|
|
// $Id: G4UIcmdWithAString.hh,v 1.3 1999/12/15 14:50:38 gunter Exp $
|
|
// GEANT4 tag $Name: geant4-03-01 $
|
|
//
|
|
//
|
|
|
|
#ifndef G4UIcmdWithAString_H
|
|
#define G4UIcmdWithAString_H 1
|
|
|
|
#include "G4UIcommand.hh"
|
|
|
|
// class description:
|
|
// A concrete class of G4UIcommand. The command defined by this class
|
|
// takes a string. Incase the parameter string contains space(s), it
|
|
// must be enclosed by double-quotations (").
|
|
// General information of G4UIcommand is given in G4UIcommand.hh.
|
|
|
|
class G4UIcmdWithAString : public G4UIcommand
|
|
{
|
|
public: // with description
|
|
G4UIcmdWithAString
|
|
(const char * theCommandPath,G4UImessenger * theMessenger);
|
|
// Constructor. The command string with full path directory
|
|
// and the pointer to the messenger must be given.
|
|
void SetParameterName(const char * theName,G4bool omittable,
|
|
G4bool currentAsDefault=false);
|
|
// Set the parameter name.
|
|
// If "omittable" is set as true, the user of this command can ommit
|
|
// the value when he/she applies the command. If "omittable" is false,
|
|
// the user must supply the parameter string.
|
|
// "currentAsDefault" flag is valid only if "omittable" is true. If this
|
|
// flag is true, the current value is used as the default value when the
|
|
// user ommit the parameter. If this flag is false, the value given by the
|
|
// next SetDefaultValue() method is used.
|
|
void SetCandidates(const char * candidateList);
|
|
// Defines the candidates of the parameter string. Candidates listed in
|
|
// the argument must be separated by space(s).
|
|
void SetDefaultValue(const char * defVal);
|
|
// Set the default value of the parameter. This default value is used
|
|
// when the user of this command ommits the parameter value, and
|
|
// "ommitable" is true and "curreutAsDefault" is false.
|
|
};
|
|
|
|
#endif
|