G4UIparameter Class Reference

#include <G4UIparameter.hh>

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

Detailed Description

Definition at line 47 of file G4UIparameter.hh.

Constructor & Destructor Documentation

G4UIparameter() [1/3]

G4UIparameter::G4UIparameter

(

)

Definition at line 37 of file G4UIparameter.cc.

                            :paramERR(0)
{
  G4String nullString;
  parameterName = nullString;
  parameterType = '\0';
  omittable = false;
  parameterGuidance = nullString;
  defaultValue = nullString;
  parameterRange = nullString;
  currentAsDefaultFlag = false;
  parameterCandidate = nullString;
  widget = 0;
  bp = 0;
  token = NONE;
}

G4UIparameter() [2/3]

G4UIparameter::G4UIparameter

(

char

theType

)

Definition at line 53 of file G4UIparameter.cc.

                                        :paramERR(0)
{
  G4String nullString;
  parameterName = nullString;
  parameterType = theType;
  omittable = false;
  parameterGuidance = nullString;
  defaultValue = nullString;
  parameterRange = nullString;
  currentAsDefaultFlag = false;
  parameterCandidate = nullString;
  widget = 0;
  bp = 0;
  token = NONE;
}

G4UIparameter() [3/3]

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

Definition at line 69 of file G4UIparameter.cc.

                                                                                   :paramERR(0)
{
  parameterName = theName;
  parameterType = theType;
  omittable = theOmittable;
  G4String nullString;
  parameterGuidance = nullString;
  defaultValue = nullString;
  parameterRange = nullString;
  currentAsDefaultFlag = false;
  parameterCandidate = nullString;
  widget = 0;
  bp = 0;
  token = NONE;
}

~G4UIparameter()

G4UIparameter::~G4UIparameter

(

)

Definition at line 85 of file G4UIparameter.cc.

{ }

Member Function Documentation

CheckNewValue()

G4int G4UIparameter::CheckNewValue

(

const char *

newValue

)

Definition at line 140 of file G4UIparameter.cc.

                                     {
    if( TypeCheck(newValue) == 0) return fParameterUnreadable;
    if( ! parameterRange.isNull() )
    { if( RangeCheck(newValue) == 0 ) return fParameterOutOfRange; }
    if( ! parameterCandidate.isNull() )
    { if( CandidateCheck(newValue) == 0 ) return fParameterOutOfCandidates; }
    return 0;   // succeeded
}

GetCurrentAsDefault()

G4bool G4UIparameter::GetCurrentAsDefault ( ) const

inline

Definition at line 130 of file G4UIparameter.hh.

      { return currentAsDefaultFlag; }

Referenced by G4UIcommandTree::CreateHTML().

GetDefaultValue()

G4String G4UIparameter::GetDefaultValue ( ) const

inline

Definition at line 89 of file G4UIparameter.hh.

      { return defaultValue; }

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

GetParameterCandidates()

G4String G4UIparameter::GetParameterCandidates ( ) const

inline

Definition at line 118 of file G4UIparameter.hh.

      { return parameterCandidate; }

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

GetParameterGuidance()

const G4String G4UIparameter::GetParameterGuidance ( ) const

inline

Definition at line 136 of file G4UIparameter.hh.

      { return parameterGuidance; }

GetParameterName()

G4String G4UIparameter::GetParameterName ( ) const

inline

Definition at line 109 of file G4UIparameter.hh.

      { return parameterName; }

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

GetParameterRange()

G4String G4UIparameter::GetParameterRange ( ) const

inline

Definition at line 103 of file G4UIparameter.hh.

      { return parameterRange; }

Referenced by G4UIcommandTree::CreateHTML().

GetParameterType()

char G4UIparameter::GetParameterType ( ) const

inline

Definition at line 91 of file G4UIparameter.hh.

      { return parameterType; }

Referenced by G4UIcommandTree::CreateHTML().

IsOmittable()

G4bool G4UIparameter::IsOmittable ( ) const

inline

Definition at line 124 of file G4UIparameter.hh.

      { return omittable; }

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

List()

void G4UIparameter::List

(

)

Definition at line 98 of file G4UIparameter.cc.

{
  G4cout << G4endl << "Parameter : " << parameterName << G4endl;
  if( ! parameterGuidance.isNull() )
  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.isNull() )
  { G4cout << " Default value   : " << defaultValue << G4endl; }
  if( ! parameterRange.isNull() )
  G4cout << " Parameter range : " << parameterRange << G4endl;
  if( ! parameterCandidate.isNull() )
  G4cout << " Candidates      : " << parameterCandidate << G4endl;
}

operator!=()

G4int G4UIparameter::operator!=

(

const G4UIparameter &

right

)

const

Definition at line 93 of file G4UIparameter.cc.

{
  return ( this != &right );
}

operator==()

G4int G4UIparameter::operator==

(

const G4UIparameter &

right

)

const

Definition at line 88 of file G4UIparameter.cc.

{
  return ( this == &right );
}

SetCurrentAsDefault()

void G4UIparameter::SetCurrentAsDefault ( G4bool  val )

inline

Definition at line 128 of file G4UIparameter.hh.

      { currentAsDefaultFlag = val; }

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

SetDefaultValue() [1/3]

void G4UIparameter::SetDefaultValue ( const char *  theDefaultValue )

inline

Definition at line 83 of file G4UIparameter.hh.

      { defaultValue = theDefaultValue; }

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

SetDefaultValue() [2/3]

void G4UIparameter::SetDefaultValue

(

G4double

theDefaultValue

)

Definition at line 125 of file G4UIparameter.cc.

{
  std::ostringstream os;
  os << theDefaultValue;
  defaultValue = os.str();
}

SetDefaultValue() [3/3]

void G4UIparameter::SetDefaultValue

(

G4int

theDefaultValue

)

Definition at line 118 of file G4UIparameter.cc.

{
  std::ostringstream os;
  os << theDefaultValue;
  defaultValue = os.str();
}

SetGuidance()

void G4UIparameter::SetGuidance ( const char *  theGuidance )

inline

Definition at line 138 of file G4UIparameter.hh.

      { parameterGuidance = theGuidance; }

Referenced by G4EnergyLossMessenger::G4EnergyLossMessenger(), G4RadioactiveDecaymessenger::G4RadioactiveDecaymessenger(), G4VisCommandGeometrySetColour::G4VisCommandGeometrySetColour(), G4VisCommandGeometrySetDaughtersInvisible::G4VisCommandGeometrySetDaughtersInvisible(), G4VisCommandGeometrySetForceAuxEdgeVisible::G4VisCommandGeometrySetForceAuxEdgeVisible(), G4VisCommandGeometrySetForceLineSegmentsPerCircle::G4VisCommandGeometrySetForceLineSegmentsPerCircle(), G4VisCommandGeometrySetForceSolid::G4VisCommandGeometrySetForceSolid(), G4VisCommandGeometrySetForceWireframe::G4VisCommandGeometrySetForceWireframe(), G4VisCommandGeometrySetLineStyle::G4VisCommandGeometrySetLineStyle(), G4VisCommandGeometrySetLineWidth::G4VisCommandGeometrySetLineWidth(), G4VisCommandGeometrySetVisibility::G4VisCommandGeometrySetVisibility(), G4VisCommandOpen::G4VisCommandOpen(), G4VisCommandSceneAddAxes::G4VisCommandSceneAddAxes(), G4VisCommandSceneAddLogo::G4VisCommandSceneAddLogo(), G4VisCommandSceneAddScale::G4VisCommandSceneAddScale(), G4VisCommandSceneAddText::G4VisCommandSceneAddText(), G4VisCommandSceneAddText2D::G4VisCommandSceneAddText2D(), G4VisCommandSetColour::G4VisCommandSetColour(), G4VisCommandSetTextColour::G4VisCommandSetTextColour(), G4VisCommandSetTouchable::G4VisCommandSetTouchable(), G4VisCommandsTouchableSet::G4VisCommandsTouchableSet(), G4VisCommandsViewerSet::G4VisCommandsViewerSet(), and G4VisCommandViewerCreate::G4VisCommandViewerCreate().

SetOmittable()

void G4UIparameter::SetOmittable ( G4bool  om )

inline

Definition at line 122 of file G4UIparameter.hh.

      { omittable = om; }

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

SetParameterCandidates()

void G4UIparameter::SetParameterCandidates ( const char *  theString )

inline

Definition at line 113 of file G4UIparameter.hh.

      { parameterCandidate = theString; }

Referenced by G4EnergyLossMessenger::G4EnergyLossMessenger(), G4InteractorMessenger::G4InteractorMessenger(), G4MatScanMessenger::G4MatScanMessenger(), G4UIcontrolMessenger::G4UIcontrolMessenger(), G4UserPhysicsListMessenger::G4UserPhysicsListMessenger(), G4VisCommandGeometrySetLineStyle::G4VisCommandGeometrySetLineStyle(), G4VisCommandOpen::G4VisCommandOpen(), G4VisCommandsViewerSet::G4VisCommandsViewerSet(), G4ProcessTableMessenger::GetCurrentValue(), G4UIcmdWithAString::SetCandidates(), G4GenericMessenger::Command::SetCandidates(), G4UIcmdWith3VectorAndUnit::SetUnitCandidates(), and G4UIcmdWithADoubleAndUnit::SetUnitCandidates().

SetParameterName()

void G4UIparameter::SetParameterName ( const char *  theName )

inline

Definition at line 107 of file G4UIparameter.hh.

      { parameterName = theName; }

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

SetParameterRange()

void G4UIparameter::SetParameterRange ( const char *  theRange )

inline

Definition at line 95 of file G4UIparameter.hh.

      { parameterRange = theRange; }

Referenced by G4AdjointSimMessenger::G4AdjointSimMessenger(), G4EnergyLossMessenger::G4EnergyLossMessenger(), G4GMocrenMessenger::G4GMocrenMessenger(), G4MatScanMessenger::G4MatScanMessenger(), G4RadioactiveDecaymessenger::G4RadioactiveDecaymessenger(), G4RunMessenger::G4RunMessenger(), G4ScoringMessenger::G4ScoringMessenger(), G4UIcontrolMessenger::G4UIcontrolMessenger(), G4UserPhysicsListMessenger::G4UserPhysicsListMessenger(), and G4VisCommandsViewerSet::G4VisCommandsViewerSet().

SetWidget()

void G4UIparameter::SetWidget ( G4int  theWidget )

inline

Definition at line 134 of file G4UIparameter.hh.

      { widget = theWidget; }

---

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

• G4UIparameter.hh
• G4UIparameter.cc