G4UIcmdWith3VectorAndUnit Class Reference

#include <G4UIcmdWith3VectorAndUnit.hh>

Inheritance diagram for G4UIcmdWith3VectorAndUnit:

Public Member Functions
	G4UIcmdWith3VectorAndUnit (const char *theCommandPath, G4UImessenger *theMessenger)
G4int	DoIt (G4String parameterList) override
G4String	ConvertToStringWithBestUnit (const G4ThreeVector &vec)
G4String	ConvertToStringWithDefaultUnit (const G4ThreeVector &vec)
void	SetParameterName (const char *theNameX, const char *theNameY, const char *theNameZ, G4bool omittable, G4bool currentAsDefault=false)
void	SetDefaultValue (const G4ThreeVector &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 G4ThreeVector	GetNew3VectorValue (const char *paramString)
static G4ThreeVector	GetNew3VectorRawValue (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 Types inherited from G4UIcommand
using	yystype = G4UItokenNum::yystype
using	tokenNum = G4UItokenNum::tokenNum
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 42 of file G4UIcmdWith3VectorAndUnit.hh.

Constructor & Destructor Documentation

G4UIcmdWith3VectorAndUnit()

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

Definition at line 40 of file G4UIcmdWith3VectorAndUnit.cc.

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

Member Function Documentation

ConvertToStringWithBestUnit()

G4String G4UIcmdWith3VectorAndUnit::ConvertToStringWithBestUnit

(

const G4ThreeVector &

vec

)

Definition at line 131 of file G4UIcmdWith3VectorAndUnit.cc.

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

Referenced by ConvertToStringWithDefaultUnit(), G4MoleculeShootMessenger::GetCurrentValue(), and G4VisCommandsViewerSet::SetNewValue().

ConvertToStringWithDefaultUnit()

G4String G4UIcmdWith3VectorAndUnit::ConvertToStringWithDefaultUnit

(

const G4ThreeVector &

vec

)

Definition at line 146 of file G4UIcmdWith3VectorAndUnit.cc.

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

DoIt()

G4int G4UIcmdWith3VectorAndUnit::DoIt ( G4String parameterList )

overridevirtual

Reimplemented from G4UIcommand.

Definition at line 57 of file G4UIcmdWith3VectorAndUnit.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(3)->GetDefaultValue();
  if (!default_unit.empty() && token_vector.size() >= 4) {
    if (CategoryOf(token_vector[3]) != CategoryOf(default_unit)) {
      return fParameterOutOfCandidates + 3;
    }
    G4double value_given = ValueOf(token_vector[3]);
    G4double value_default = ValueOf(default_unit);
    G4double x = ConvertToDouble(token_vector[0]) * value_given / value_default;
    G4double y = ConvertToDouble(token_vector[1]) * value_given / value_default;
    G4double z = ConvertToDouble(token_vector[2]) * value_given / value_default;
 
    // reconstruct parameter list
    converted_parameter += ConvertToString(x);
    converted_parameter += " ";
    converted_parameter += ConvertToString(y);
    converted_parameter += " ";
    converted_parameter += ConvertToString(z);
    converted_parameter += " ";
    converted_parameter += default_unit;
    for (std::size_t i = 4; i < token_vector.size(); ++i) {
      converted_parameter += " ";
      converted_parameter += token_vector[i];
    }
  }
  else {
    converted_parameter = parameterList;
  }
 
  return G4UIcommand::DoIt(converted_parameter);
}

GetNew3VectorRawValue()

G4ThreeVector G4UIcmdWith3VectorAndUnit::GetNew3VectorRawValue ( const char * paramString )

static

Definition at line 106 of file G4UIcmdWith3VectorAndUnit.cc.

{
  G4double vx;
  G4double vy;
  G4double vz;
  char unts[30];
  std::istringstream is(paramString);
  is >> vx >> vy >> vz >> unts;
  return G4ThreeVector(vx, vy, vz);
}

GetNew3VectorValue()

G4ThreeVector G4UIcmdWith3VectorAndUnit::GetNew3VectorValue ( const char * paramString )

static

Definition at line 100 of file G4UIcmdWith3VectorAndUnit.cc.

{
  return ConvertToDimensioned3Vector(paramString);
}

Referenced by G4EmExtraParametersMessenger::SetNewValue(), G4GeneralParticleSourceMessenger::SetNewValue(), G4GlobalMagFieldMessenger::SetNewValue(), G4HepRepMessenger::SetNewValue(), G4MatScanMessenger::SetNewValue(), G4MoleculeShootMessenger::SetNewValue(), G4ParticleGunMessenger::SetNewValue(), G4RTMessenger::SetNewValue(), G4ScoringMessenger::SetNewValue(), and G4VisCommandsViewerSet::SetNewValue().

GetNewUnitValue()

G4double G4UIcmdWith3VectorAndUnit::GetNewUnitValue ( const char * paramString )

static

Definition at line 118 of file G4UIcmdWith3VectorAndUnit.cc.

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

SetDefaultUnit()

void G4UIcmdWith3VectorAndUnit::SetDefaultUnit

(

const char *

defUnit

)

Definition at line 204 of file G4UIcmdWith3VectorAndUnit.cc.

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

Referenced by G4MatScanMessenger::G4MatScanMessenger(), G4ParticleGunMessenger::G4ParticleGunMessenger(), and G4ScoringMessenger::G4ScoringMessenger().

SetDefaultValue()

void G4UIcmdWith3VectorAndUnit::SetDefaultValue

(

const G4ThreeVector &

defVal

)

Definition at line 179 of file G4UIcmdWith3VectorAndUnit.cc.

{
  G4UIparameter* theParamX = GetParameter(0);
  theParamX->SetDefaultValue(vec.x());
  G4UIparameter* theParamY = GetParameter(1);
  theParamY->SetDefaultValue(vec.y());
  G4UIparameter* theParamZ = GetParameter(2);
  theParamZ->SetDefaultValue(vec.z());
}

Referenced by G4MatScanMessenger::G4MatScanMessenger().

SetParameterName()

void G4UIcmdWith3VectorAndUnit::SetParameterName	(	const char *	theNameX,
		const char *	theNameY,
		const char *	theNameZ,
		G4bool	omittable,
		G4bool	currentAsDefault = false )

Definition at line 160 of file G4UIcmdWith3VectorAndUnit.cc.

{
  G4UIparameter* theParamX = GetParameter(0);
  theParamX->SetParameterName(theNameX);
  theParamX->SetOmittable(omittable);
  theParamX->SetCurrentAsDefault(currentAsDefault);
  G4UIparameter* theParamY = GetParameter(1);
  theParamY->SetParameterName(theNameY);
  theParamY->SetOmittable(omittable);
  theParamY->SetCurrentAsDefault(currentAsDefault);
  G4UIparameter* theParamZ = GetParameter(2);
  theParamZ->SetParameterName(theNameZ);
  theParamZ->SetOmittable(omittable);
  theParamZ->SetCurrentAsDefault(currentAsDefault);
}

Referenced by G4GlobalMagFieldMessenger::G4GlobalMagFieldMessenger(), G4MatScanMessenger::G4MatScanMessenger(), G4ParticleGunMessenger::G4ParticleGunMessenger(), G4ScoringMessenger::G4ScoringMessenger(), and G4VisCommandsViewerSet::G4VisCommandsViewerSet().

SetUnitCandidates()

void G4UIcmdWith3VectorAndUnit::SetUnitCandidates

(

const char *

candidateList

)

Definition at line 196 of file G4UIcmdWith3VectorAndUnit.cc.

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

Referenced by SetUnitCategory().

SetUnitCategory()

void G4UIcmdWith3VectorAndUnit::SetUnitCategory

(

const char *

unitCategory

)

Definition at line 190 of file G4UIcmdWith3VectorAndUnit.cc.

{
  SetUnitCandidates(UnitsList(unitCategory));
}

Referenced by G4GlobalMagFieldMessenger::G4GlobalMagFieldMessenger(), G4VisCommandsViewerSet::G4VisCommandsViewerSet(), and SetDefaultUnit().

---

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

• G4UIcmdWith3VectorAndUnit.hh
• G4UIcmdWith3VectorAndUnit.cc