Import Geant4 10.7.0 source tree
This commit is contained in:
@@ -23,43 +23,47 @@
|
||||
// * acceptance of all terms of the Geant4 Software license. *
|
||||
// ********************************************************************
|
||||
//
|
||||
// G4UIcmdWithADouble
|
||||
//
|
||||
// Class description:
|
||||
//
|
||||
//
|
||||
// A concrete class of G4UIcommand. The command defined by this class
|
||||
// takes a double value.
|
||||
// General information of G4UIcommand is given in G4UIcommand.hh
|
||||
|
||||
#ifndef G4UIcmdWithADouble_H
|
||||
#define G4UIcmdWithADouble_H 1
|
||||
// Author: M.Asai, 1998
|
||||
// --------------------------------------------------------------------
|
||||
#ifndef G4UIcmdWithADouble_hh
|
||||
#define G4UIcmdWithADouble_hh 1
|
||||
|
||||
#include "G4UIcommand.hh"
|
||||
|
||||
// class description:
|
||||
// A concrete class of G4UIcommand. The command defined by this class
|
||||
// takes a double value.
|
||||
// General information of G4UIcommand is given in G4UIcommand.hh.
|
||||
|
||||
class G4UIcmdWithADouble : public G4UIcommand
|
||||
{
|
||||
public: // with description
|
||||
G4UIcmdWithADouble
|
||||
(const char * theCommandPath,G4UImessenger * theMessenger);
|
||||
// Constructor. The command string with full path directory
|
||||
// and the pointer to the messenger must be given.
|
||||
public:
|
||||
|
||||
G4UIcmdWithADouble(const char* theCommandPath, G4UImessenger* theMessenger);
|
||||
// Constructor. The command string with full path directory
|
||||
// and the pointer to the messenger must be given
|
||||
|
||||
static G4double GetNewDoubleValue(const char* paramString);
|
||||
// Convert string which represents a double value to a double.
|
||||
void SetParameterName(const char * theName,G4bool omittable,
|
||||
G4bool currentAsDefault=false);
|
||||
// Set the parameter name. The name is used by the range checking.
|
||||
// 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 a double value.
|
||||
// "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.
|
||||
// Convert string which represents a double value to a double
|
||||
|
||||
void SetParameterName(const char* theName, G4bool omittable,
|
||||
G4bool currentAsDefault = false);
|
||||
// Set the parameter name. The name is used by the range checking.
|
||||
// If "omittable" is set as true, the user of this command can omit
|
||||
// the value when the command is applied. If "omittable" is false,
|
||||
// the user must supply a double value.
|
||||
// "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 omits the parameter. If this flag is false, the value given by
|
||||
// the next SetDefaultValue() method is used
|
||||
|
||||
void SetDefaultValue(G4double 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 "currentAsDefault" is false.
|
||||
// Set the default value of the parameter. This default value is used
|
||||
// when the user of this command omits the parameter value, and
|
||||
// "omittable" is true and "currentAsDefault" is false
|
||||
};
|
||||
|
||||
#endif
|
||||
|
||||
Reference in New Issue
Block a user