#include <G4UIcmdWith3VectorAndUnit.hh>

Inheritance diagram for G4UIcmdWith3VectorAndUnit:

Public Member Functions
	G4UIcmdWith3VectorAndUnit (const char theCommandPath, G4UImessenger theMessenger)

virtual G4int	DoIt (G4String parameterList)

G4String	ConvertToStringWithBestUnit (G4ThreeVector vec)

G4String	ConvertToStringWithDefaultUnit (G4ThreeVector vec)

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

void	SetDefaultValue (G4ThreeVector defVal)

void	SetUnitCategory (const char *unitCategory)

void	SetUnitCandidates (const char *candidateList)

void	SetDefaultUnit (const char *defUnit)

Public Member Functions inherited from G4UIcommand
	G4UIcommand ()

	G4UIcommand (const char theCommandPath, G4UImessenger theMessenger, G4bool tBB=true)

virtual	~G4UIcommand ()

G4int	operator== (const G4UIcommand &right) const

G4int	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

G4int	GetGuidanceEntries () const

const G4String &	GetGuidanceLine (G4int i) const

const G4String &	GetCommandPath () const

const G4String &	GetCommandName () const

G4int	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

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 (G4double doubleValue)

static G4String	ConvertToString (G4double doubleValue, const char *unitName)

static G4String	ConvertToString (G4ThreeVector vec)

static G4String	ConvertToString (G4ThreeVector vec, const char *unitName)

static G4bool	ConvertToBool (const char *st)

static G4int	ConvertToInt (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
Protected Member Functions inherited from G4UIcommand
G4int	CheckNewValue (const char *newValue)

Protected Attributes inherited from G4UIcommand
G4bool	toBeBroadcasted

G4bool	toBeFlushed

G4bool	workerThreadOnly

Detailed Description

Definition at line 42 of file G4UIcmdWith3VectorAndUnit.hh.

Constructor & Destructor Documentation

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

Definition at line 38 of file G4UIcmdWith3VectorAndUnit.cc.

References G4UIparameter::SetParameterName().

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

Member Function Documentation

G4String G4UIcmdWith3VectorAndUnit::ConvertToStringWithBestUnit ( G4ThreeVector vec )

Definition at line 120 of file G4UIcmdWith3VectorAndUnit.cc.

References G4UIcommand::CategoryOf(), G4BestUnit, G4UIcommand::GetParameter(), and G4UIparameter::GetParameterCandidates().

Referenced by ConvertToStringWithDefaultUnit().

 {
   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;
 }

G4String G4UIcmdWith3VectorAndUnit::ConvertToStringWithDefaultUnit ( G4ThreeVector vec )

Definition at line 134 of file G4UIcmdWith3VectorAndUnit.cc.

References G4UIcommand::ConvertToString(), ConvertToStringWithBestUnit(), G4UIparameter::GetDefaultValue(), G4UIcommand::GetParameter(), and G4UIparameter::IsOmittable().

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

G4int G4UIcmdWith3VectorAndUnit::DoIt ( G4String parameterList )

virtual

Reimplemented from G4UIcommand.

Definition at line 52 of file G4UIcmdWith3VectorAndUnit.cc.

References G4UIcommand::CategoryOf(), G4UIcommand::ConvertToDouble(), G4UIcommand::ConvertToString(), G4UIcommand::DoIt(), fParameterOutOfCandidates, G4UIcommand::GetParameter(), G4UIcommand::ValueOf(), test::x, and z.

 {
   std::vector<G4String> token_vector;
   G4Tokenizer tkn(parameterList);
   G4String str;
   while( (str = tkn()) != "" ) {
     token_vector.push_back(str);
   }
 
   // convert a value in default unit
   G4String converted_parameter;
   G4String default_unit = GetParameter(3)-> GetDefaultValue();
   if (default_unit != "" && 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 ( 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);
 }

G4ThreeVector G4UIcmdWith3VectorAndUnit::GetNew3VectorRawValue ( const char * paramString )

static

Definition at line 97 of file G4UIcmdWith3VectorAndUnit.cc.

Referenced by CML2PhantomConstructionMessenger::SetNewValue(), and CML2MainMessenger::SetNewValue().

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

G4ThreeVector G4UIcmdWith3VectorAndUnit::GetNew3VectorValue ( const char * paramString )

static

Definition at line 92 of file G4UIcmdWith3VectorAndUnit.cc.

References G4UIcommand::ConvertToDimensioned3Vector().

Referenced by G4HepRepMessenger::SetNewValue(), LXeDetectorMessenger::SetNewValue(), G4MatScanMessenger::SetNewValue(), ExG4DetectorConstruction01Messenger::SetNewValue(), G4RTMessenger::SetNewValue(), ExG4DetectorConstruction02Messenger::SetNewValue(), G4ParticleGunMessenger::SetNewValue(), G4GlobalMagFieldMessenger::SetNewValue(), CexmcParticleGunMessenger::SetNewValue(), G4ScoringMessenger::SetNewValue(), and G4GeneralParticleSourceMessenger::SetNewValue().

 {
   return ConvertToDimensioned3Vector(paramString);
 }

G4double G4UIcmdWith3VectorAndUnit::GetNewUnitValue ( const char * paramString )

static

Definition at line 108 of file G4UIcmdWith3VectorAndUnit.cc.

References G4UIcommand::ValueOf().

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

void G4UIcmdWith3VectorAndUnit::SetDefaultUnit ( const char * defUnit )

Definition at line 185 of file G4UIcmdWith3VectorAndUnit.cc.

References G4UIcommand::CategoryOf(), G4UIcommand::GetParameter(), G4UIparameter::SetDefaultValue(), G4UIparameter::SetOmittable(), and SetUnitCategory().

Referenced by CexmcParticleGunMessenger::CexmcParticleGunMessenger(), CML2MainMessenger::CML2MainMessenger(), CML2PhantomConstructionMessenger::CML2PhantomConstructionMessenger(), G4MatScanMessenger::G4MatScanMessenger(), G4ParticleGunMessenger::G4ParticleGunMessenger(), G4ScoringMessenger::G4ScoringMessenger(), LXeDetectorMessenger::LXeDetectorMessenger(), and G4GenericMessenger::Command::SetUnit().

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

void G4UIcmdWith3VectorAndUnit::SetDefaultValue ( G4ThreeVector defVal )

Definition at line 163 of file G4UIcmdWith3VectorAndUnit.cc.

References G4UIcommand::GetParameter(), G4UIparameter::SetDefaultValue(), CLHEP::Hep3Vector::x(), CLHEP::Hep3Vector::y(), and CLHEP::Hep3Vector::z().

Referenced by CML2MainMessenger::CML2MainMessenger(), CML2PhantomConstructionMessenger::CML2PhantomConstructionMessenger(), and G4MatScanMessenger::G4MatScanMessenger().

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

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

Definition at line 146 of file G4UIcmdWith3VectorAndUnit.cc.

References G4UIparameter::SetCurrentAsDefault(), G4UIparameter::SetOmittable(), and G4UIparameter::SetParameterName().

Referenced by CexmcParticleGunMessenger::CexmcParticleGunMessenger(), G4GenericMessenger::DeclarePropertyWithUnit(), ExG4DetectorConstruction01Messenger::ExG4DetectorConstruction01Messenger(), ExG4DetectorConstruction02Messenger::ExG4DetectorConstruction02Messenger(), G4GlobalMagFieldMessenger::G4GlobalMagFieldMessenger(), G4MatScanMessenger::G4MatScanMessenger(), G4ParticleGunMessenger::G4ParticleGunMessenger(), G4ScoringMessenger::G4ScoringMessenger(), G4VisCommandsViewerSet::G4VisCommandsViewerSet(), and LXeDetectorMessenger::LXeDetectorMessenger().

 {
   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);
 }

void G4UIcmdWith3VectorAndUnit::SetUnitCandidates ( const char * candidateList )

Definition at line 178 of file G4UIcmdWith3VectorAndUnit.cc.

References G4UIcommand::GetParameter(), and G4UIparameter::SetParameterCandidates().

Referenced by CexmcParticleGunMessenger::CexmcParticleGunMessenger(), and SetUnitCategory().

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

void G4UIcmdWith3VectorAndUnit::SetUnitCategory ( const char * unitCategory )

Definition at line 173 of file G4UIcmdWith3VectorAndUnit.cc.

References SetUnitCandidates(), and G4UIcommand::UnitsList().

Referenced by G4GlobalMagFieldMessenger::G4GlobalMagFieldMessenger(), G4VisCommandsViewerSet::G4VisCommandsViewerSet(), SetDefaultUnit(), and G4GenericMessenger::Command::SetUnit().

 {
   SetUnitCandidates(UnitsList(unitCategory));
 }

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

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation