G4UIcmdWithADoubleAndUnit Class Reference

#include <G4UIcmdWithADoubleAndUnit.hh>

Inheritance diagram for G4UIcmdWithADoubleAndUnit:

Public Member Functions
	G4UIcmdWithADoubleAndUnit (const char *theCommandPath, G4UImessenger *theMessenger)
G4int	DoIt (const G4String &parameterList) override
G4String	ConvertToStringWithBestUnit (G4double val)
G4String	ConvertToStringWithDefaultUnit (G4double val)
void	SetParameterName (const char *theName, G4bool omittable, G4bool currentAsDefault=false)
void	SetDefaultValue (G4double defVal)
void	SetUnitCategory (const char *unitCategory)
void	SetUnitCandidates (const char *candidateList)
void	SetDefaultUnit (const char *defUnit)
Public Member Functions inherited from G4UIcommand
	G4UIcommand ()=default
	G4UIcommand (const char *theCommandPath, G4UImessenger *theMessenger, G4bool tBB=true)
virtual	~G4UIcommand ()
G4bool	operator== (const G4UIcommand &right) const
G4bool	operator!= (const G4UIcommand &right) const
G4String	GetCurrentValue ()
void	AvailableForStates (G4ApplicationState s1)
void	AvailableForStates (G4ApplicationState s1, G4ApplicationState s2)
void	AvailableForStates (G4ApplicationState s1, G4ApplicationState s2, G4ApplicationState s3)
void	AvailableForStates (G4ApplicationState s1, G4ApplicationState s2, G4ApplicationState s3, G4ApplicationState s4)
void	AvailableForStates (G4ApplicationState s1, G4ApplicationState s2, G4ApplicationState s3, G4ApplicationState s4, G4ApplicationState s5)
G4bool	IsAvailable ()
virtual void	List ()
void	SetRange (const char *rs)
const G4String &	GetRange () const
std::size_t	GetGuidanceEntries () const
const G4String &	GetGuidanceLine (G4int i) const
const G4String &	GetCommandPath () const
const G4String &	GetCommandName () const
std::size_t	GetParameterEntries () const
G4UIparameter *	GetParameter (G4int i) const
std::vector< G4ApplicationState > *	GetStateList ()
G4UImessenger *	GetMessenger () const
void	SetParameter (G4UIparameter *const newParameter)
void	SetGuidance (const char *aGuidance)
const G4String	GetTitle () const
void	SetToBeBroadcasted (G4bool val)
G4bool	ToBeBroadcasted () const
void	SetToBeFlushed (G4bool val)
G4bool	ToBeFlushed () const
void	SetWorkerThreadOnly (G4bool val=true)
G4bool	IsWorkerThreadOnly () const
void	CommandFailed (G4int errCode, G4ExceptionDescription &ed)
void	CommandFailed (G4ExceptionDescription &ed)
G4int	IfCommandFailed ()
const G4String &	GetFailureDescription ()
void	ResetFailure ()
CommandType	GetCommandType () const
void	SetCommandType (CommandType)
void	SetDefaultSortFlag (G4bool val)

Static Public Member Functions
static G4double	GetNewDoubleValue (const char *paramString)
static G4double	GetNewDoubleRawValue (const char *paramString)
static G4double	GetNewUnitValue (const char *paramString)
Static Public Member Functions inherited from G4UIcommand
static G4String	ConvertToString (G4bool boolVal)
static G4String	ConvertToString (G4int intValue)
static G4String	ConvertToString (G4long longValue)
static G4String	ConvertToString (G4double doubleValue)
static G4String	ConvertToString (G4double doubleValue, const char *unitName)
static G4String	ConvertToString (const G4ThreeVector &vec)
static G4String	ConvertToString (const G4ThreeVector &vec, const char *unitName)
static G4bool	ConvertToBool (const char *st)
static G4int	ConvertToInt (const char *st)
static G4long	ConvertToLongInt (const char *st)
static G4double	ConvertToDouble (const char *st)
static G4double	ConvertToDimensionedDouble (const char *st)
static G4ThreeVector	ConvertTo3Vector (const char *st)
static G4ThreeVector	ConvertToDimensioned3Vector (const char *st)
static G4double	ValueOf (const char *unitName)
static G4String	CategoryOf (const char *unitName)
static G4String	UnitsList (const char *unitCategory)

Additional Inherited Members
Public Types inherited from G4UIcommand
enum	CommandType {   BaseClassCmd , WithoutParameterCmd , WithABoolCmd , WithAnIntegerCmd ,   WithALongIntCmd , WithADoubleCmd , WithADoubleAndUnitCmd , With3VectorCmd ,   With3VectorAndUnitCmd , WithAStringCmd , CmdDirectory = -1 }
Protected Member Functions inherited from G4UIcommand
G4int	CheckNewValue (const char *newValue)
Protected Attributes inherited from G4UIcommand
G4bool	toBeBroadcasted = false
G4bool	toBeFlushed = false
G4bool	workerThreadOnly = false
G4int	commandFailureCode = 0
G4String	failureDescription = ""
G4bool	ifSort = false

Detailed Description

Definition at line 41 of file G4UIcmdWithADoubleAndUnit.hh.

Constructor & Destructor Documentation

G4UIcmdWithADoubleAndUnit()

G4UIcmdWithADoubleAndUnit::G4UIcmdWithADoubleAndUnit	(	const char *	theCommandPath,
		G4UImessenger *	theMessenger )

Definition at line 41 of file G4UIcmdWithADoubleAndUnit.cc.

  : G4UIcommand(theCommandPath, theMessenger)
{
  auto* dblParam = new G4UIparameter('d');
  SetParameter(dblParam);
  auto* untParam = new G4UIparameter('s');
  untParam->SetParameterName("Unit");
  SetParameter(untParam);
  SetCommandType(WithADoubleAndUnitCmd);
}

Member Function Documentation

ConvertToStringWithBestUnit()

G4String G4UIcmdWithADoubleAndUnit::ConvertToStringWithBestUnit

(

G4double

val

)

Definition at line 121 of file G4UIcmdWithADoubleAndUnit.cc.

{
  G4UIparameter* unitParam = GetParameter(1);
  G4String canList = unitParam->GetParameterCandidates();
  G4Tokenizer candidateTokenizer(canList);
  G4String aToken = candidateTokenizer();
  std::ostringstream os;
  os << G4BestUnit(val, CategoryOf(aToken));
 
  G4String st = os.str();
  return st;
}

Referenced by ConvertToStringWithDefaultUnit().

ConvertToStringWithDefaultUnit()

G4String G4UIcmdWithADoubleAndUnit::ConvertToStringWithDefaultUnit

(

G4double

val

)

Definition at line 135 of file G4UIcmdWithADoubleAndUnit.cc.

{
  G4UIparameter* unitParam = GetParameter(1);
  G4String st;
  if (unitParam->IsOmittable()) {
    st = ConvertToString(val, unitParam->GetDefaultValue());
  }
  else {
    st = ConvertToStringWithBestUnit(val);
  }
  return st;
}

DoIt()

G4int G4UIcmdWithADoubleAndUnit::DoIt ( const G4String & parameterList )

overridevirtual

Reimplemented from G4UIcommand.

Definition at line 54 of file G4UIcmdWithADoubleAndUnit.cc.

{
  std::vector<G4String> token_vector;
  G4Tokenizer tkn(parameterList);
  G4String str;
  while (!(str = tkn()).empty()) {
    token_vector.push_back(str);
  }
 
  // convert a value in default unit
  G4String converted_parameter;
  G4String default_unit = GetParameter(1)->GetDefaultValue();
  if (!default_unit.empty() && token_vector.size() >= 2) {
    if (CategoryOf(token_vector[1]) != CategoryOf(default_unit)) {
      return fParameterOutOfCandidates + 1;
    }
    G4double value_given = ValueOf(token_vector[1]);
    G4double value_default = ValueOf(default_unit);
    G4double value = ConvertToDouble(token_vector[0]) * value_given / value_default;
    // reconstruct parameter list
    converted_parameter += ConvertToString(value);
    converted_parameter += " ";
    converted_parameter += default_unit;
    for (std::size_t i = 2; i < token_vector.size(); ++i) {
      converted_parameter += " ";
      converted_parameter += token_vector[i];
    }
  }
  else {
    converted_parameter = parameterList;
  }
 
  return G4UIcommand::DoIt(converted_parameter);
}

GetNewDoubleRawValue()

G4double G4UIcmdWithADoubleAndUnit::GetNewDoubleRawValue ( const char * paramString )

static

Definition at line 96 of file G4UIcmdWithADoubleAndUnit.cc.

{
  G4double vl;
  char unts[30];
 
  std::istringstream is(paramString);
  is >> vl >> unts;
 
  return vl;
}

GetNewDoubleValue()

G4double G4UIcmdWithADoubleAndUnit::GetNewDoubleValue ( const char * paramString )

static

Definition at line 90 of file G4UIcmdWithADoubleAndUnit.cc.

{
  return ConvertToDimensionedDouble(paramString);
}

Referenced by G4ModelCmdSetAuxPtsSize< M >::Apply(), and G4ModelCmdSetStepPtsSize< M >::Apply().

GetNewUnitValue()

G4double G4UIcmdWithADoubleAndUnit::GetNewUnitValue ( const char * paramString )

static

Definition at line 108 of file G4UIcmdWithADoubleAndUnit.cc.

{
  G4double vl;
  char unts[30];
 
  std::istringstream is(paramString);
  is >> vl >> unts;
  G4String unt = unts;
 
  return ValueOf(unt);
}

SetDefaultUnit()

void G4UIcmdWithADoubleAndUnit::SetDefaultUnit

(

const char *

defUnit

)

Definition at line 180 of file G4UIcmdWithADoubleAndUnit.cc.

{
  G4UIparameter* untParam = GetParameter(1);
  untParam->SetOmittable(true);
  untParam->SetDefaultValue(defUnit);
  SetUnitCategory(CategoryOf(defUnit));
}

SetDefaultValue()

void G4UIcmdWithADoubleAndUnit::SetDefaultValue

(

G4double

defVal

)

Definition at line 159 of file G4UIcmdWithADoubleAndUnit.cc.

{
  G4UIparameter* theParam = GetParameter(0);
  theParam->SetDefaultValue(defVal);
}

SetParameterName()

void G4UIcmdWithADoubleAndUnit::SetParameterName	(	const char *	theName,
		G4bool	omittable,
		G4bool	currentAsDefault = false )

Definition at line 149 of file G4UIcmdWithADoubleAndUnit.cc.

{
  G4UIparameter* theParam = GetParameter(0);
  theParam->SetParameterName(theName);
  theParam->SetOmittable(omittable);
  theParam->SetCurrentAsDefault(currentAsDefault);
}

SetUnitCandidates()

void G4UIcmdWithADoubleAndUnit::SetUnitCandidates

(

const char *

candidateList

)

Definition at line 172 of file G4UIcmdWithADoubleAndUnit.cc.

{
  G4UIparameter* untParam = GetParameter(1);
  G4String canList = candidateList;
  untParam->SetParameterCandidates(canList);
}

Referenced by SetUnitCategory().

SetUnitCategory()

void G4UIcmdWithADoubleAndUnit::SetUnitCategory

(

const char *

unitCategory

)

Definition at line 166 of file G4UIcmdWithADoubleAndUnit.cc.

{
  SetUnitCandidates(UnitsList(unitCategory));
}

Referenced by G4ModelCmdSetTimeSliceInterval< M >::G4ModelCmdSetTimeSliceInterval(), and SetDefaultUnit().

---

The documentation for this class was generated from the following files:

• G4UIcmdWithADoubleAndUnit.hh
• G4UIcmdWithADoubleAndUnit.cc