Gabriele Cosmo
115 lines
5.7 KiB
C++
115 lines
5.7 KiB
C++
//
|
|
// ********************************************************************
|
|
// * License and Disclaimer *
|
|
// * *
|
|
// * The Geant4 software is copyright of the Copyright Holders of *
|
|
// * the Geant4 Collaboration. It is provided under the terms and *
|
|
// * conditions of the Geant4 Software License, included in the file *
|
|
// * LICENSE and available at http://cern.ch/geant4/license . These *
|
|
// * include a list of copyright holders. *
|
|
// * *
|
|
// * Neither the authors of this software system, nor their employing *
|
|
// * institutes,nor the agencies providing financial support for this *
|
|
// * work make any representation or warranty, express or implied, *
|
|
// * regarding this software system or assume any liability for its *
|
|
// * use. Please see the license in the file LICENSE and URL above *
|
|
// * for the full disclaimer and the limitation of liability. *
|
|
// * *
|
|
// * This code implementation is the result of the scientific and *
|
|
// * technical work of the GEANT4 collaboration. *
|
|
// * By using, copying, modifying or distributing the software (or *
|
|
// * any work based on the software) you agree to acknowledge its *
|
|
// * use in resulting scientific publications, and indicate your *
|
|
// * acceptance of all terms of the Geant4 Software license. *
|
|
// ********************************************************************
|
|
//
|
|
// G4UIcmdWithADoubleAndUnit
|
|
//
|
|
// Class description:
|
|
//
|
|
// A concrete class of G4UIcommand. The command defined by this class
|
|
// takes a double value and a unit string.
|
|
// General information of G4UIcommand is given in G4UIcommand.hh
|
|
|
|
// Author: M.Asai, 1998
|
|
// --------------------------------------------------------------------
|
|
#ifndef G4UIcmdWithADoubleAndUnit_hh
|
|
#define G4UIcmdWithADoubleAndUnit_hh 1
|
|
|
|
#include "G4UIcommand.hh"
|
|
|
|
class G4UIcmdWithADoubleAndUnit : public G4UIcommand
|
|
{
|
|
public:
|
|
|
|
G4UIcmdWithADoubleAndUnit(const char* theCommandPath,
|
|
G4UImessenger* theMessenger);
|
|
// Constructor. The command string with full path directory
|
|
// and the pointer to the messenger must be given
|
|
|
|
G4int DoIt(G4String parameterList) override;
|
|
|
|
static G4double GetNewDoubleValue(const char* paramString);
|
|
// Convert string which represents a double value and a unit to
|
|
// double. Value is converted to the Geant4 internal unit
|
|
|
|
static G4double GetNewDoubleRawValue(const char* paramString);
|
|
// Convert string which represents a double value and a unit to
|
|
// double. Value is NOT converted to the Geant4 internal unit
|
|
// but just as the given string
|
|
|
|
static G4double GetNewUnitValue(const char* paramString);
|
|
// Convert the unit string to the value of the unit. "paramString"
|
|
// must contain a double value AND a unit string
|
|
|
|
G4String ConvertToStringWithBestUnit(G4double val);
|
|
// Convert a double value to a string of digits and unit. Best unit is
|
|
// chosen from the unit category of default unit (in case SetDefaultUnit()
|
|
// is defined) or category defined by SetUnitCategory()
|
|
|
|
G4String ConvertToStringWithDefaultUnit(G4double val);
|
|
// Convert a double value to a string of digits and unit. Best unit is
|
|
// chosen from the category defined by SetUnitCategory() in case default
|
|
// unit is not defined
|
|
|
|
void SetParameterName(const char* theName, G4bool omittable,
|
|
G4bool currentAsDefault = false);
|
|
// Set the parameter name for double parameters. Name is used by
|
|
// the range checking function.
|
|
// 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 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 double 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 omits the parameter value, and
|
|
// "omittable" is true and "currentAsDefault" is false
|
|
|
|
void SetUnitCategory(const char* unitCategory);
|
|
void SetUnitCandidates(const char* candidateList);
|
|
void SetDefaultUnit(const char* defUnit);
|
|
// These three methods must be used alternatively.
|
|
// The user cannot omit the unit as the second parameter of the command
|
|
// if SetUnitCategory() or SetUnitCandidates() is used, while the unit
|
|
// defined by SetDefaultUnit() method is used as the default unit so that
|
|
// the user can omit the second parameter.
|
|
// SetUnitCategory() defines the category of the units which will be
|
|
// accepted.
|
|
// The available categories can be found in G4SystemOfUnits.hh in 'global'
|
|
// category. Only the units categorized in the given category are accepted
|
|
// as the second parameter of the command.
|
|
// SetUnitCandidates() defines the candidates of units. Units listed in
|
|
// the argument of this method must be separated by space(s). Only the
|
|
// units listed in the candidate list are accepted as the second parameter
|
|
// of the command.
|
|
// SetDefaultUnit() defines the default unit and also defines the category
|
|
// of the allowed units. Thus only the units categorized as the given
|
|
// default unit will be accepted
|
|
};
|
|
|
|
#endif
|