G4MatScanMessenger Class Reference

#include <G4MatScanMessenger.hh>

Inheritance diagram for G4MatScanMessenger:

Collaboration diagram for G4MatScanMessenger:

Public Member Functions
	G4MatScanMessenger (G4MaterialScanner *p1)
virtual	~G4MatScanMessenger ()
virtual G4String	GetCurrentValue (G4UIcommand *command)
virtual void	SetNewValue (G4UIcommand *command, G4String newValue)
Public Member Functions inherited from G4UImessenger
	G4UImessenger ()
	G4UImessenger (const G4String &path, const G4String &dsc, G4bool commandsToBeBroadcasted=true)
virtual	~G4UImessenger ()
G4bool	operator== (const G4UImessenger &messenger) const
G4bool	CommandsShouldBeInMaster () const

Private Attributes
G4MaterialScanner *	theScanner
G4UIdirectory *	msDirectory
G4UIcmdWithoutParameter *	scanCmd
G4UIcommand *	thetaCmd
G4UIcommand *	phiCmd
G4UIcommand *	singleCmd
G4UIcmdWith3Vector *	single2Cmd
G4UIcmdWithABool *	regSenseCmd
G4UIcmdWithAString *	regionCmd
G4UIcmdWith3VectorAndUnit *	eyePosCmd

Additional Inherited Members
Protected Member Functions inherited from G4UImessenger
G4String	ItoS (G4int i)
G4String	DtoS (G4double a)
G4String	BtoS (G4bool b)
G4int	StoI (G4String s)
G4double	StoD (G4String s)
G4bool	StoB (G4String s)
void	AddUIcommand (G4UIcommand *newCommand)
void	CreateDirectory (const G4String &path, const G4String &dsc, G4bool commandsToBeBroadcasted=true)
template<typename T >
T *	CreateCommand (const G4String &cname, const G4String &dsc)
Protected Attributes inherited from G4UImessenger
G4UIdirectory *	baseDir
G4String	baseDirName
G4bool	commandsShouldBeInMaster

Detailed Description

Definition at line 48 of file G4MatScanMessenger.hh.

Constructor & Destructor Documentation

G4MatScanMessenger()

G4MatScanMessenger::G4MatScanMessenger

(

G4MaterialScanner *

p1

)

Definition at line 47 of file G4MatScanMessenger.cc.

{
  theScanner = p1;
  G4UIparameter* par;
  msDirectory = new G4UIdirectory("/control/matScan/");
  msDirectory->SetGuidance("Material scanner commands.");

  scanCmd = new G4UIcmdWithoutParameter("/control/matScan/scan",this);
  scanCmd->SetGuidance("Start material scanning.");
  scanCmd->SetGuidance("Scanning range should be defined with");
  scanCmd->SetGuidance("/control/matScan/theta and /control/matSca/phi commands.");
  scanCmd->AvailableForStates(G4State_Idle);

  thetaCmd = new G4UIcommand("/control/matScan/theta",this);
  thetaCmd->SetGuidance("Define theta range.");
  thetaCmd->SetGuidance("Usage : /control/matScan/theta [nbin] [thetaMin] [thetaSpan] [unit]");
  thetaCmd->SetGuidance("Notation of angles :");
  thetaCmd->SetGuidance(" theta --- +Z axis : +90 deg. / X-Y plane : 0 deg. / -Z axis : -90 deg.");
  par = new G4UIparameter("nbin",'i',false);
  par->SetParameterRange("nbin>0");
  thetaCmd->SetParameter(par);
  par = new G4UIparameter("thetaMin",'d',false);
  thetaCmd->SetParameter(par);
  par = new G4UIparameter("thetaSpan",'d',true);
  par->SetParameterRange("thetaSpan>=0.");
  par->SetDefaultValue(0.);
  thetaCmd->SetParameter(par);
  par = new G4UIparameter("unit",'c',true);
  par->SetDefaultValue("deg");
  par->SetParameterCandidates(thetaCmd->UnitsList(thetaCmd->CategoryOf("deg")));
  thetaCmd->SetParameter(par);

  phiCmd = new G4UIcommand("/control/matScan/phi",this);
  phiCmd->SetGuidance("Define phi range.");
  phiCmd->SetGuidance("Usage : /control/matScan/phi [nbin] [phiMin] [phiSpan] [unit]");
  phiCmd->SetGuidance("Notation of angles :");
  phiCmd->SetGuidance(" phi   --- +X axis : 0 deg. / +Y axis : 90 deg. / -X axis : 180 deg. / -Y axis : 270 deg.");
  par = new G4UIparameter("nbin",'i',false);
  par->SetParameterRange("nbin>0");
  phiCmd->SetParameter(par);
  par = new G4UIparameter("phiMin",'d',false);
  phiCmd->SetParameter(par);
  par = new G4UIparameter("phiSpan",'d',true);
  par->SetParameterRange("phiSpan>=0.");
  par->SetDefaultValue(0.);
  phiCmd->SetParameter(par);
  par = new G4UIparameter("unit",'c',true);
  par->SetDefaultValue("deg");
  par->SetParameterCandidates(phiCmd->UnitsList(phiCmd->CategoryOf("deg")));
  phiCmd->SetParameter(par);

  singleCmd = new G4UIcommand("/control/matScan/singleMeasure",this);
  singleCmd->SetGuidance("Measure thickness for one particular direction.");
  singleCmd->SetGuidance("Notation of angles :");
  singleCmd->SetGuidance(" theta --- +Z axis : +90 deg. / X-Y plane : 0 deg. / -Z axis : -90 deg.");
  singleCmd->SetGuidance(" phi   --- +X axis : 0 deg. / +Y axis : 90 deg. / -X axis : 180 deg. / -Y axis : 270 deg.");
  singleCmd->AvailableForStates(G4State_Idle);
  par = new G4UIparameter("theta",'d',false);
  singleCmd->SetParameter(par);
  par = new G4UIparameter("phi",'d',false);
  singleCmd->SetParameter(par);
  par = new G4UIparameter("unit",'c',true);
  par->SetDefaultValue("deg");
  par->SetParameterCandidates(singleCmd->UnitsList(singleCmd->CategoryOf("deg")));
  singleCmd->SetParameter(par);

  single2Cmd = new G4UIcmdWith3Vector("/control/matScan/singleTo",this);
  single2Cmd->SetGuidance("Measure thicknesss for one direction defined by a unit vector.");
  single2Cmd->SetParameterName("X","Y","Z",false);

  eyePosCmd = new G4UIcmdWith3VectorAndUnit("/control/matScan/eyePosition",this);
  eyePosCmd->SetGuidance("Define the eye position.");
  eyePosCmd->SetParameterName("X","Y","Z",true);
  eyePosCmd->SetDefaultValue(G4ThreeVector(0.,0.,0.));
  eyePosCmd->SetDefaultUnit("m");

  regSenseCmd = new G4UIcmdWithABool("/control/matScan/regionSensitive",this);
  regSenseCmd->SetGuidance("Set region sensitivity.");
  regSenseCmd->SetGuidance("This command is automatically set to TRUE");
  regSenseCmd->SetGuidance(" if /control/matScan/region command is issued.");
  regSenseCmd->SetParameterName("senseFlag",true);
  regSenseCmd->SetDefaultValue(false);

  regionCmd = new G4UIcmdWithAString("/control/matScan/region",this);
  regionCmd->SetGuidance("Define region name to be scanned.");
  regionCmd->SetGuidance("/control/matScan/regionSensitive command is automatically");
  regionCmd->SetGuidance("set to TRUE with this command.");
  regionCmd->SetParameterName("region",true);
  regionCmd->SetDefaultValue("DefaultRegionForTheWorld");
}

Here is the call graph for this function:

~G4MatScanMessenger()

G4MatScanMessenger::~G4MatScanMessenger ( )

virtual

Definition at line 138 of file G4MatScanMessenger.cc.

{
  delete scanCmd;
  delete thetaCmd;
  delete phiCmd;
  delete singleCmd;
  delete single2Cmd;
  delete eyePosCmd;
  delete regSenseCmd;
  delete regionCmd;
  delete msDirectory;
}

Member Function Documentation

GetCurrentValue()

G4String G4MatScanMessenger::GetCurrentValue ( G4UIcommand *  command )

virtual

Reimplemented from G4UImessenger.

Definition at line 151 of file G4MatScanMessenger.cc.

{
  G4String currentValue;
  if(command==thetaCmd)
  {
   currentValue = thetaCmd->ConvertToString(theScanner->GetNTheta());
   currentValue += " ";
   currentValue += thetaCmd->ConvertToString((theScanner->GetThetaMin())/deg);
   currentValue += " ";
   currentValue += thetaCmd->ConvertToString((theScanner->GetThetaSpan())/deg);
  }
  else if(command==phiCmd)
  {
   currentValue = phiCmd->ConvertToString(theScanner->GetNPhi());
   currentValue += " ";
   currentValue += phiCmd->ConvertToString((theScanner->GetPhiMin())/deg);
   currentValue += " ";
   currentValue += phiCmd->ConvertToString((theScanner->GetPhiSpan())/deg);
  }
  else if(command==eyePosCmd)
  { currentValue = eyePosCmd->ConvertToString(theScanner->GetEyePosition(),"m"); }
  else if(command==regSenseCmd)
  { currentValue = regSenseCmd->ConvertToString(theScanner->GetRegionSensitive()); }
  else if(command==regionCmd)
  { currentValue = theScanner->GetRegionName(); }
  return currentValue;
}

Here is the call graph for this function:

SetNewValue()

void G4MatScanMessenger::SetNewValue ( G4UIcommand *  command, G4String  newValue  )

virtual

Reimplemented from G4UImessenger.

Definition at line 179 of file G4MatScanMessenger.cc.

{
  if(command==scanCmd)
  { theScanner->Scan(); }
  else if(command==thetaCmd)
  {
    G4Tokenizer next( newValue );
    G4int nbin = StoI(next());
    G4double thetaMin = StoD(next());
    G4double thetaSpan = StoD(next());
    G4String unit = next();
    thetaMin *= thetaCmd->ValueOf(unit);
    thetaSpan *= thetaCmd->ValueOf(unit);
    theScanner->SetNTheta(nbin);
    theScanner->SetThetaMin(thetaMin);
    theScanner->SetThetaSpan(thetaSpan);
  }
  else if(command==phiCmd)
  {
    G4Tokenizer next( newValue );
    G4int nbin = StoI(next());
    G4double phiMin = StoD(next());
    G4double phiSpan = StoD(next());
    G4String unit = next();
    phiMin *= phiCmd->ValueOf(unit);
    phiSpan *= phiCmd->ValueOf(unit);
    theScanner->SetNPhi(nbin);
    theScanner->SetPhiMin(phiMin);
    theScanner->SetPhiSpan(phiSpan);
  }
  else if(command==eyePosCmd)
  { theScanner->SetEyePosition(eyePosCmd->GetNew3VectorValue(newValue)); }
  else if(command==regSenseCmd)
  { theScanner->SetRegionSensitive(regSenseCmd->GetNewBoolValue(newValue)); }
  else if(command==regionCmd)
  { if(theScanner->SetRegionName(newValue)) theScanner->SetRegionSensitive(true); }
  else if(command==singleCmd || command==single2Cmd)
  {
    G4int ntheta = theScanner->GetNTheta();
    G4double thetaMin = theScanner->GetThetaMin();
    G4double thetaSpan = theScanner->GetThetaSpan();
    G4int nphi = theScanner->GetNPhi();
    G4double phiMin = theScanner->GetPhiMin();
    G4double phiSpan = theScanner->GetPhiSpan();

    G4double theta = 0.;
    G4double phi = 0.;
    if(command==singleCmd)
    {
      G4Tokenizer next( newValue );
      theta = StoD(next());
      phi = StoD(next());
      G4String unit = next();
      theta *= singleCmd->ValueOf(unit);
      phi *= singleCmd->ValueOf(unit);
    }
    else if(command==single2Cmd)
    {
      G4ThreeVector v = single2Cmd->GetNew3VectorValue(newValue);
      theta = 90.*deg - v.theta();
      phi = v.phi();
    }
    theScanner->SetNTheta(1);
    theScanner->SetThetaMin(theta);
    theScanner->SetThetaSpan(0.);
    theScanner->SetNPhi(1);
    theScanner->SetPhiMin(phi);
    theScanner->SetPhiSpan(0.);
    theScanner->Scan();

    theScanner->SetNTheta(ntheta);
    theScanner->SetThetaMin(thetaMin);
    theScanner->SetThetaSpan(thetaSpan);
    theScanner->SetNPhi(nphi);
    theScanner->SetPhiMin(phiMin);
    theScanner->SetPhiSpan(phiSpan);
  }

}

Here is the call graph for this function:

Member Data Documentation

eyePosCmd

G4UIcmdWith3VectorAndUnit* G4MatScanMessenger::eyePosCmd

private

Definition at line 68 of file G4MatScanMessenger.hh.

msDirectory

G4UIdirectory* G4MatScanMessenger::msDirectory

private

Definition at line 60 of file G4MatScanMessenger.hh.

phiCmd

G4UIcommand* G4MatScanMessenger::phiCmd

private

Definition at line 63 of file G4MatScanMessenger.hh.

regionCmd

G4UIcmdWithAString* G4MatScanMessenger::regionCmd

private

Definition at line 67 of file G4MatScanMessenger.hh.

regSenseCmd

G4UIcmdWithABool* G4MatScanMessenger::regSenseCmd

private

Definition at line 66 of file G4MatScanMessenger.hh.

scanCmd

G4UIcmdWithoutParameter* G4MatScanMessenger::scanCmd

private

Definition at line 61 of file G4MatScanMessenger.hh.

single2Cmd

G4UIcmdWith3Vector* G4MatScanMessenger::single2Cmd

private

Definition at line 65 of file G4MatScanMessenger.hh.

singleCmd

G4UIcommand* G4MatScanMessenger::singleCmd

private

Definition at line 64 of file G4MatScanMessenger.hh.

theScanner

G4MaterialScanner* G4MatScanMessenger::theScanner

private

Definition at line 58 of file G4MatScanMessenger.hh.

thetaCmd

G4UIcommand* G4MatScanMessenger::thetaCmd

private

Definition at line 62 of file G4MatScanMessenger.hh.

---

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

• G4MatScanMessenger.hh
• G4MatScanMessenger.cc