G4UIparameter Class Reference

#include <G4UIparameter.hh>

Public Member Functions
	G4UIparameter ()=default
	G4UIparameter (char theType)
	G4UIparameter (const char *theName, char theType, G4bool theOmittable)
	~G4UIparameter ()
G4int	CheckNewValue (const char *newValue)
void	List ()
void	SetDefaultValue (const char *theDefaultValue)
void	SetDefaultValue (G4int theDefaultValue)
void	SetDefaultValue (G4long theDefaultValue)
void	SetDefaultValue (G4double theDefaultValue)
void	SetDefaultUnit (const char *theDefaultUnit)
const G4String &	GetDefaultValue () const
char	GetParameterType () const
void	SetParameterRange (const char *theRange)
const G4String &	GetParameterRange () const
void	SetParameterName (const char *pName)
const G4String &	GetParameterName () const
void	SetParameterCandidates (const char *theString)
const G4String &	GetParameterCandidates () const
void	SetOmittable (G4bool om)
G4bool	IsOmittable () const
void	SetCurrentAsDefault (G4bool val)
G4bool	GetCurrentAsDefault () const
const G4String &	GetParameterGuidance () const
void	SetGuidance (const char *theGuidance)

Protected Types
using	yystype = G4UItokenNum::yystype
using	tokenNum = G4UItokenNum::tokenNum

Detailed Description

Definition at line 45 of file G4UIparameter.hh.

Member Typedef Documentation

tokenNum

using G4UIparameter::tokenNum = G4UItokenNum::tokenNum

protected

Definition at line 113 of file G4UIparameter.hh.

yystype

using G4UIparameter::yystype = G4UItokenNum::yystype

protected

Definition at line 112 of file G4UIparameter.hh.

Constructor & Destructor Documentation

G4UIparameter() [1/3]

G4UIparameter::G4UIparameter ( )

default

G4UIparameter() [2/3]

G4UIparameter::G4UIparameter

(

char

theType

)

Definition at line 45 of file G4UIparameter.cc.

{
  parameterType = theType;
}

G4UIparameter() [3/3]

G4UIparameter::G4UIparameter	(	const char *	theName,
		char	theType,
		G4bool	theOmittable )

Definition at line 51 of file G4UIparameter.cc.

{
  parameterName = theName;
  parameterType = theType;
  omittable = theOmittable;
}

~G4UIparameter()

G4UIparameter::~G4UIparameter ( )

default

Member Function Documentation

CheckNewValue()

G4int G4UIparameter::CheckNewValue

(

const char *

newValue

)

Definition at line 140 of file G4UIparameter.cc.

{
  if (!TypeCheck(newValue)) {
    return fParameterUnreadable;
  }
  if (!RangeCheck(newValue)) {
    return fParameterOutOfRange;
  }
  if (!CandidateCheck(newValue)) {
    return fParameterOutOfCandidates;
  }
  return 0;  // succeeded
}

GetCurrentAsDefault()

G4bool G4UIparameter::GetCurrentAsDefault ( ) const

inline

Definition at line 104 of file G4UIparameter.hh.

{ return currentAsDefaultFlag; }

Referenced by G4UIcommandTree::CreateHTML().

GetDefaultValue()

const G4String & G4UIparameter::GetDefaultValue ( ) const

inline

Definition at line 79 of file G4UIparameter.hh.

{ return defaultValue; }

Referenced by G4UIcmdWith3VectorAndUnit::ConvertToStringWithDefaultUnit(), G4UIcmdWithADoubleAndUnit::ConvertToStringWithDefaultUnit(), G4UIcommandTree::CreateHTML(), G4UIcmdWith3VectorAndUnit::DoIt(), G4UIcmdWithADoubleAndUnit::DoIt(), and G4OpenGLQtViewer::updateViewerPropertiesTableWidget().

GetParameterCandidates()

const G4String & G4UIparameter::GetParameterCandidates ( ) const

inline

Definition at line 98 of file G4UIparameter.hh.

{ return parameterCandidate; }

Referenced by G4UIcmdWith3VectorAndUnit::ConvertToStringWithBestUnit(), G4UIcmdWithADoubleAndUnit::ConvertToStringWithBestUnit(), and G4UIcommandTree::CreateHTML().

GetParameterGuidance()

const G4String & G4UIparameter::GetParameterGuidance ( ) const

inline

Definition at line 108 of file G4UIparameter.hh.

{ return parameterGuidance; }

GetParameterName()

const G4String & G4UIparameter::GetParameterName ( ) const

inline

Definition at line 92 of file G4UIparameter.hh.

{ return parameterName; }

Referenced by G4UIcommandTree::CreateHTML(), G4UImanager::GetCurrentStringValue(), and G4GenericMessenger::Command::SetUnit().

GetParameterRange()

const G4String & G4UIparameter::GetParameterRange ( ) const

inline

Definition at line 89 of file G4UIparameter.hh.

{ return rangeExpression; }

Referenced by G4UIcommandTree::CreateHTML().

GetParameterType()

char G4UIparameter::GetParameterType ( ) const

inline

Definition at line 80 of file G4UIparameter.hh.

{ return parameterType; }

Referenced by G4UIcommandTree::CreateHTML().

IsOmittable()

G4bool G4UIparameter::IsOmittable ( ) const

inline

Definition at line 101 of file G4UIparameter.hh.

{ return omittable; }

Referenced by G4UIcmdWith3VectorAndUnit::ConvertToStringWithDefaultUnit(), G4UIcmdWithADoubleAndUnit::ConvertToStringWithDefaultUnit(), G4UIcommandTree::CreateHTML(), and G4GenericMessenger::Command::SetUnit().

List()

void G4UIparameter::List

(

)

Definition at line 62 of file G4UIparameter.cc.

{
  G4cout << G4endl << "Parameter : " << parameterName << G4endl;
  if (!parameterGuidance.empty()) {
    G4cout << parameterGuidance << G4endl;
  }
  G4cout << " Parameter type  : " << parameterType << G4endl;
  if (omittable) {
    G4cout << " Omittable       : True" << G4endl;
  }
  else {
    G4cout << " Omittable       : False" << G4endl;
  }
  if (currentAsDefaultFlag) {
    G4cout << " Default value   : taken from the current value" << G4endl;
  }
  else if (!defaultValue.empty()) {
    G4cout << " Default value   : " << defaultValue << G4endl;
  }
  if (!rangeExpression.empty()) {
    G4cout << " Parameter range : " << rangeExpression << G4endl;
  }
  if (!parameterCandidate.empty()) {
    G4cout << " Candidates      : " << parameterCandidate << G4endl;
  }
}

SetCurrentAsDefault()

void G4UIparameter::SetCurrentAsDefault ( G4bool val )

inline

Definition at line 103 of file G4UIparameter.hh.

{ currentAsDefaultFlag = val; }

Referenced by G4VisCommandOpen::G4VisCommandOpen(), G4GenericMessenger::Command::SetParameterName(), G4GenericMessenger::Command::SetParameterName(), G4UIcmdWith3Vector::SetParameterName(), G4UIcmdWith3VectorAndUnit::SetParameterName(), G4UIcmdWithABool::SetParameterName(), G4UIcmdWithADouble::SetParameterName(), G4UIcmdWithADoubleAndUnit::SetParameterName(), G4UIcmdWithALongInt::SetParameterName(), G4UIcmdWithAnInteger::SetParameterName(), G4UIcmdWithAString::SetParameterName(), and G4UIcmdWithNucleusLimits::SetParameterName().

SetDefaultUnit()

void G4UIparameter::SetDefaultUnit

(

const char *

theDefaultUnit

)

Definition at line 108 of file G4UIparameter.cc.

{
  char type = (char)std::toupper(parameterType);
  if (type != 'S') {
    G4ExceptionDescription ed;
    ed << "This method can be used only for a string-type parameter that is "
          "used to specify a unit.\n"
       << "This parameter <" << parameterName << "> is defined as ";
    switch (type) {
      case 'D':
        ed << "double.";
        break;
      case 'I':
        ed << "integer.";
        break;
      case 'L':
        ed << "long int.";
        break;
      case 'B':
        ed << "bool.";
        break;
      default:
        ed << "undefined.";
    }
    G4Exception("G4UIparameter::SetDefaultUnit", "INTERCOM2010", FatalException, ed);
  }
  SetDefaultValue(theDefaultUnit);
  SetParameterCandidates(G4UIcommand::UnitsList(G4UIcommand::CategoryOf(theDefaultUnit)));
}

Referenced by G4ScoringMessenger::G4ScoringMessenger(), and G4UserPhysicsListMessenger::G4UserPhysicsListMessenger().

SetDefaultValue() [1/4]

void G4UIparameter::SetDefaultValue ( const char * theDefaultValue )

inline

Definition at line 69 of file G4UIparameter.hh.

{ defaultValue = theDefaultValue; }

Referenced by G4GMocrenMessenger::G4GMocrenMessenger(), G4InteractorMessenger::G4InteractorMessenger(), G4MatScanMessenger::G4MatScanMessenger(), G4ParticleGunMessenger::G4ParticleGunMessenger(), G4PolarizationMessenger::G4PolarizationMessenger(), G4ProcessManagerMessenger::G4ProcessManagerMessenger(), G4ProcessTableMessenger::G4ProcessTableMessenger(), G4ScoringMessenger::G4ScoringMessenger(), G4UserPhysicsListMessenger::G4UserPhysicsListMessenger(), G4VisCommandGeometrySetColour::G4VisCommandGeometrySetColour(), G4VisCommandGeometrySetDaughtersInvisible::G4VisCommandGeometrySetDaughtersInvisible(), G4VisCommandGeometrySetForceAuxEdgeVisible::G4VisCommandGeometrySetForceAuxEdgeVisible(), G4VisCommandGeometrySetForceCloud::G4VisCommandGeometrySetForceCloud(), G4VisCommandGeometrySetForceLineSegmentsPerCircle::G4VisCommandGeometrySetForceLineSegmentsPerCircle(), G4VisCommandGeometrySetForceSolid::G4VisCommandGeometrySetForceSolid(), G4VisCommandGeometrySetForceWireframe::G4VisCommandGeometrySetForceWireframe(), G4VisCommandGeometrySetLineStyle::G4VisCommandGeometrySetLineStyle(), G4VisCommandGeometrySetLineWidth::G4VisCommandGeometrySetLineWidth(), G4VisCommandGeometrySetVisibility::G4VisCommandGeometrySetVisibility(), G4VisCommandSceneAddArrow::G4VisCommandSceneAddArrow(), G4VisCommandSceneAddAxes::G4VisCommandSceneAddAxes(), G4VisCommandSceneAddLine::G4VisCommandSceneAddLine(), G4VisCommandSceneAddLogicalVolume::G4VisCommandSceneAddLogicalVolume(), G4VisCommandSceneAddLogo::G4VisCommandSceneAddLogo(), G4VisCommandSceneAddScale::G4VisCommandSceneAddScale(), G4VisCommandSceneAddText::G4VisCommandSceneAddText(), G4VisCommandSceneAddText2D::G4VisCommandSceneAddText2D(), G4VisCommandSetColour::G4VisCommandSetColour(), G4VisCommandSetTextColour::G4VisCommandSetTextColour(), G4VisCommandSpecify::G4VisCommandSpecify(), G4VisCommandsTouchableSet::G4VisCommandsTouchableSet(), G4VisCommandsViewerSet::G4VisCommandsViewerSet(), G4VisCommandViewerCentreOn::G4VisCommandViewerCentreOn(), G4UIcmdWith3VectorAndUnit::SetDefaultUnit(), G4UIcmdWithADoubleAndUnit::SetDefaultUnit(), SetDefaultUnit(), G4GenericMessenger::Command::SetDefaultValue(), G4UIcmdWith3Vector::SetDefaultValue(), G4UIcmdWith3VectorAndUnit::SetDefaultValue(), G4UIcmdWithABool::SetDefaultValue(), G4UIcmdWithADouble::SetDefaultValue(), G4UIcmdWithADoubleAndUnit::SetDefaultValue(), G4UIcmdWithALongInt::SetDefaultValue(), G4UIcmdWithAnInteger::SetDefaultValue(), G4UIcmdWithAString::SetDefaultValue(), and G4UIcmdWithNucleusLimits::SetDefaultValue().

SetDefaultValue() [2/4]

void G4UIparameter::SetDefaultValue

(

G4double

theDefaultValue

)

Definition at line 102 of file G4UIparameter.cc.

{
  defaultValue = G4UIparsing::TtoS(theDefaultValue);
}

SetDefaultValue() [3/4]

void G4UIparameter::SetDefaultValue

(

G4int

theDefaultValue

)

Definition at line 90 of file G4UIparameter.cc.

{
  defaultValue = G4UIparsing::TtoS(theDefaultValue);
}

SetDefaultValue() [4/4]

void G4UIparameter::SetDefaultValue

(

G4long

theDefaultValue

)

Definition at line 96 of file G4UIparameter.cc.

{
  defaultValue = G4UIparsing::TtoS(theDefaultValue);
}

SetGuidance()

void G4UIparameter::SetGuidance ( const char * theGuidance )

inline

Definition at line 109 of file G4UIparameter.hh.

{ parameterGuidance = theGuidance; }

Referenced by G4RadioactiveDecayMessenger::G4RadioactiveDecayMessenger(), G4VisCommandGeometrySetColour::G4VisCommandGeometrySetColour(), G4VisCommandGeometrySetDaughtersInvisible::G4VisCommandGeometrySetDaughtersInvisible(), G4VisCommandGeometrySetForceAuxEdgeVisible::G4VisCommandGeometrySetForceAuxEdgeVisible(), G4VisCommandGeometrySetForceCloud::G4VisCommandGeometrySetForceCloud(), G4VisCommandGeometrySetForceLineSegmentsPerCircle::G4VisCommandGeometrySetForceLineSegmentsPerCircle(), G4VisCommandGeometrySetForceSolid::G4VisCommandGeometrySetForceSolid(), G4VisCommandGeometrySetForceWireframe::G4VisCommandGeometrySetForceWireframe(), G4VisCommandGeometrySetLineStyle::G4VisCommandGeometrySetLineStyle(), G4VisCommandGeometrySetLineWidth::G4VisCommandGeometrySetLineWidth(), G4VisCommandGeometrySetVisibility::G4VisCommandGeometrySetVisibility(), G4VisCommandOpen::G4VisCommandOpen(), G4VisCommandSceneAddLogo::G4VisCommandSceneAddLogo(), G4VisCommandSceneAddScale::G4VisCommandSceneAddScale(), G4VisCommandSceneAddText::G4VisCommandSceneAddText(), G4VisCommandSceneAddText2D::G4VisCommandSceneAddText2D(), G4VisCommandSetColour::G4VisCommandSetColour(), G4VisCommandSetTextColour::G4VisCommandSetTextColour(), G4VisCommandSetTouchable::G4VisCommandSetTouchable(), G4VisCommandsViewerSet::G4VisCommandsViewerSet(), and G4VisCommandViewerCentreOn::G4VisCommandViewerCentreOn().

SetOmittable()

void G4UIparameter::SetOmittable ( G4bool om )

inline

Definition at line 100 of file G4UIparameter.hh.

{ omittable = om; }

Referenced by G4UIcmdWith3VectorAndUnit::SetDefaultUnit(), G4UIcmdWithADoubleAndUnit::SetDefaultUnit(), G4GenericMessenger::Command::SetParameterName(), G4GenericMessenger::Command::SetParameterName(), G4UIcmdWith3Vector::SetParameterName(), G4UIcmdWith3VectorAndUnit::SetParameterName(), G4UIcmdWithABool::SetParameterName(), G4UIcmdWithADouble::SetParameterName(), G4UIcmdWithADoubleAndUnit::SetParameterName(), G4UIcmdWithALongInt::SetParameterName(), G4UIcmdWithAnInteger::SetParameterName(), G4UIcmdWithAString::SetParameterName(), and G4UIcmdWithNucleusLimits::SetParameterName().

SetParameterCandidates()

void G4UIparameter::SetParameterCandidates ( const char * theString )

inline

Definition at line 96 of file G4UIparameter.hh.

{ parameterCandidate = theString; }

Referenced by G4InteractorMessenger::G4InteractorMessenger(), G4MatScanMessenger::G4MatScanMessenger(), G4ParticleGunMessenger::G4ParticleGunMessenger(), G4UserPhysicsListMessenger::G4UserPhysicsListMessenger(), G4VisCommandGeometrySetLineStyle::G4VisCommandGeometrySetLineStyle(), G4VisCommandsViewerSet::G4VisCommandsViewerSet(), G4GenericMessenger::Command::SetCandidates(), G4UIcmdWithAString::SetCandidates(), SetDefaultUnit(), G4UIcmdWith3VectorAndUnit::SetUnitCandidates(), and G4UIcmdWithADoubleAndUnit::SetUnitCandidates().

SetParameterName()

void G4UIparameter::SetParameterName ( const char * pName )

inline

Definition at line 91 of file G4UIparameter.hh.

{ parameterName = pName; }

Referenced by G4GenericMessenger::Command::SetParameterName(), G4GenericMessenger::Command::SetParameterName(), G4UIcmdWith3Vector::SetParameterName(), G4UIcmdWith3VectorAndUnit::SetParameterName(), G4UIcmdWithABool::SetParameterName(), G4UIcmdWithADouble::SetParameterName(), G4UIcmdWithADoubleAndUnit::SetParameterName(), G4UIcmdWithALongInt::SetParameterName(), G4UIcmdWithAnInteger::SetParameterName(), G4UIcmdWithAString::SetParameterName(), and G4UIcmdWithNucleusLimits::SetParameterName().

SetParameterRange()

void G4UIparameter::SetParameterRange ( const char * theRange )

inline

Definition at line 87 of file G4UIparameter.hh.

{ rangeExpression = theRange; }

Referenced by G4GMocrenMessenger::G4GMocrenMessenger(), G4MatScanMessenger::G4MatScanMessenger(), G4RadioactiveDecayMessenger::G4RadioactiveDecayMessenger(), G4ScoringMessenger::G4ScoringMessenger(), G4UserPhysicsListMessenger::G4UserPhysicsListMessenger(), and G4VisCommandsViewerSet::G4VisCommandsViewerSet().

---

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

• G4UIparameter.hh
• G4UIparameter.cc