#include <G4PolarizationMessenger.hh>

Inheritance diagram for G4PolarizationMessenger:

Public Member Functions
G4bool	CommandsShouldBeInMaster () const

	G4PolarizationMessenger (const G4PolarizationMessenger &)=delete

	G4PolarizationMessenger (G4PolarizationManager *runMgr)

G4String	GetCurrentValue (G4UIcommand *command) override

G4bool	operator!= (const G4UImessenger &messenger) const

G4PolarizationMessenger &	operator= (const G4PolarizationMessenger &right)=delete

G4bool	operator== (const G4UImessenger &messenger) const

void	SetNewValue (G4UIcommand *command, G4String newValues) override

	~G4PolarizationMessenger () override

Data Fields
G4PolarizationManager *	polarizationManager

Protected Member Functions
void	AddUIcommand (G4UIcommand *newCommand)

G4String	BtoS (G4bool b)

template<typename T >
T *	CreateCommand (const G4String &cname, const G4String &dsc)

void	CreateDirectory (const G4String &path, const G4String &dsc, G4bool commandsToBeBroadcasted=true)

G4String	DtoS (G4double a)

G4String	ItoS (G4int i)

G4bool	StoB (G4String s)

G4double	StoD (G4String s)

G4int	StoI (G4String s)

G4long	StoL (G4String s)

Protected Attributes
G4UIdirectory *	baseDir = nullptr

G4String	baseDirName = ""

G4bool	commandsShouldBeInMaster = false

Detailed Description

Definition at line 52 of file G4PolarizationMessenger.hh.

Constructor & Destructor Documentation

◆ G4PolarizationMessenger() [1/2]

G4PolarizationMessenger::G4PolarizationMessenger ( G4PolarizationManager * runMgr )

explicit

Definition at line 48 of file G4PolarizationMessenger.cc.

  : polarizationManager(polMgr)
{
  polarizationDirectory = new G4UIdirectory("/polarization/");
  polarizationDirectory->SetGuidance("polarization control commands.");
 
  managerDirectory = new G4UIdirectory("/polarization/manager/");
  managerDirectory->SetGuidance("general polarization information.");
 
  verboseCmd = new G4UIcmdWithAnInteger("/polarization/manager/verbose", this);
  verboseCmd->SetGuidance("Set the Verbose level of G4PolarizationManager.");
  verboseCmd->SetGuidance(" 0 : Silent (default)");
  verboseCmd->SetGuidance(" 1 : Verbose");
  verboseCmd->SetParameterName("level", true);
  verboseCmd->SetDefaultValue(0);
  verboseCmd->SetRange("level >=0 && level <=1");
 
  optActivateCmd = new G4UIcmdWithABool("/polarization/manager/activate", this);
  optActivateCmd->SetGuidance("activate/deactivate polarization treatment");
  optActivateCmd->SetParameterName("flag", true);
  optActivateCmd->SetDefaultValue(true);
 
  volumeDirectory = new G4UIdirectory("/polarization/volume/");
  volumeDirectory->SetGuidance(
    "Status control commands of registered polarized logical volumes.");
 
  printVolumeListCmd =
    new G4UIcmdWithoutParameter("/polarization/volume/list", this);
  printVolumeListCmd->SetGuidance(
    "print list of registered polarized logical volumes");
  printVolumeListCmd->AvailableForStates(G4State_PreInit, G4State_Idle,
                                         G4State_GeomClosed);
 
  setPolarizationCmd = new G4UIcommand("/polarization/volume/set", this);
  setPolarizationCmd->SetGuidance(
    "set or change polarization of a logical volume");
  setPolarizationCmd->AvailableForStates(G4State_PreInit, G4State_Idle,
                                         G4State_GeomClosed);
 
  G4UIparameter* param;
  param = new G4UIparameter("logicalVolumeName", 's', false);
  param->SetDefaultValue("worldVolume");
  setPolarizationCmd->SetParameter(param);
  param = new G4UIparameter("px", 'd', true);
  param->SetDefaultValue("0.0");
  setPolarizationCmd->SetParameter(param);
  param = new G4UIparameter("py", 'd', true);
  param->SetDefaultValue("0.0");
  setPolarizationCmd->SetParameter(param);
  param = new G4UIparameter("pz", 'd', true);
  param->SetDefaultValue("0.0");
  setPolarizationCmd->SetParameter(param);
 
  testDirectory = new G4UIdirectory("/polarization/test/");
  testDirectory->SetGuidance("provides access to some internal test routines.");
 
  testPolarizationTransformationCmd = new G4UIcmdWithoutParameter(
    "/polarization/test/polarizationTransformation", this);
  testPolarizationTransformationCmd->SetGuidance(
    "checks definition of particle reference frame and corresponding "
    "translation routines");
  testPolarizationTransformationCmd->AvailableForStates(
    G4State_PreInit, G4State_Idle, G4State_GeomClosed);
 
  testInteractionFrameCmd =
    new G4UIcmdWithoutParameter("/polarization/test/interactionFrame", this);
  testInteractionFrameCmd->SetGuidance(
    "checks definition of interaction frame");
  testInteractionFrameCmd->AvailableForStates(G4State_PreInit, G4State_Idle,
                                              G4State_GeomClosed);
}

References G4UIcommand::AvailableForStates(), G4State_GeomClosed, G4State_Idle, G4State_PreInit, managerDirectory, optActivateCmd, polarizationDirectory, printVolumeListCmd, G4UIparameter::SetDefaultValue(), G4UIcmdWithABool::SetDefaultValue(), G4UIcmdWithAnInteger::SetDefaultValue(), G4UIcommand::SetGuidance(), G4UIcommand::SetParameter(), G4UIcmdWithABool::SetParameterName(), G4UIcmdWithAnInteger::SetParameterName(), setPolarizationCmd, G4UIcommand::SetRange(), testDirectory, testInteractionFrameCmd, testPolarizationTransformationCmd, verboseCmd, and volumeDirectory.

◆ ~G4PolarizationMessenger()

G4PolarizationMessenger::~G4PolarizationMessenger ( )

override

Definition at line 120 of file G4PolarizationMessenger.cc.

{
  delete verboseCmd;
  delete testInteractionFrameCmd;
  delete testPolarizationTransformationCmd;
  delete testDirectory;
  delete setPolarizationCmd;
  delete printVolumeListCmd;
  delete volumeDirectory;
  delete optActivateCmd;
  delete managerDirectory;
  delete polarizationDirectory;
}

References managerDirectory, optActivateCmd, polarizationDirectory, printVolumeListCmd, setPolarizationCmd, testDirectory, testInteractionFrameCmd, testPolarizationTransformationCmd, verboseCmd, and volumeDirectory.

◆ G4PolarizationMessenger() [2/2]

G4PolarizationMessenger::G4PolarizationMessenger ( const G4PolarizationMessenger & )

delete

Member Function Documentation

◆ AddUIcommand()

void G4UImessenger::AddUIcommand ( G4UIcommand * newCommand )

protectedinherited

Definition at line 149 of file G4UImessenger.cc.

{
  G4cerr << "Warning : Old style definition of G4UIcommand <"
         << newCommand->GetCommandPath() << ">." << G4endl;
}

References G4cerr, G4endl, and G4UIcommand::GetCommandPath().

◆ BtoS()

G4String G4UImessenger::BtoS ( G4bool b )

protectedinherited

Definition at line 98 of file G4UImessenger.cc.

{
  G4String vl = "0";
  if(b)
    vl = "true";
  return vl;
}

◆ CommandsShouldBeInMaster()

G4bool G4UImessenger::CommandsShouldBeInMaster ( ) const

inlineinherited

Definition at line 77 of file G4UImessenger.hh.

    {
      return commandsShouldBeInMaster;
    }

References G4UImessenger::commandsShouldBeInMaster.

Referenced by G4UIcommand::G4UIcommandCommonConstructorCode().

◆ CreateCommand()

template<typename T >

T * G4UImessenger::CreateCommand	(	const G4String &	cname,
		const G4String &	dsc
	)

protectedinherited

Definition at line 110 of file G4UImessenger.hh.

{
  G4String path;
  if(cname[0] != '/')
  {
    path = baseDirName + cname;
    if(path[0] != '/')
      path = "/" + path;
  }
 
  T* command = new T(path.c_str(), this);
  command->SetGuidance(dsc.c_str());
 
  return command;
}

References G4UImessenger::baseDirName.

◆ CreateDirectory()

void G4UImessenger::CreateDirectory	(	const G4String &	path,
		const G4String &	dsc,
		G4bool	commandsToBeBroadcasted = `true`
	)

protectedinherited

Definition at line 156 of file G4UImessenger.cc.

{
  G4UImanager* ui = G4UImanager::GetUIpointer();
 
  G4String fullpath = path;
  if(fullpath.back() != '/')
    fullpath.append("/");
 
  G4UIcommandTree* tree = ui->GetTree()->FindCommandTree(fullpath.c_str());
  if(tree != nullptr)
  {
    baseDirName = tree->GetPathName();
  }
  else
  {
    baseDir     = new G4UIdirectory(fullpath.c_str(), commandsToBeBroadcasted);
    baseDirName = fullpath;
    baseDir->SetGuidance(dsc.c_str());
  }
}

References G4UImessenger::baseDir, G4UImessenger::baseDirName, G4UIcommandTree::FindCommandTree(), G4UIcommandTree::GetPathName(), G4UImanager::GetTree(), G4UImanager::GetUIpointer(), and G4UIcommand::SetGuidance().

Referenced by G4MoleculeShootMessenger::G4MoleculeShootMessenger(), and G4UImessenger::G4UImessenger().

◆ DtoS()

G4String G4UImessenger::DtoS ( G4double a )

protectedinherited

Definition at line 90 of file G4UImessenger.cc.

{
  std::ostringstream os;
  os << a;
  return G4String(os.str());
}

Referenced by G4ScoreQuantityMessenger::FilterCommands(), and G4UIcontrolMessenger::SetNewValue().

◆ GetCurrentValue()

G4String G4PolarizationMessenger::GetCurrentValue ( G4UIcommand * command )

overridevirtual

Reimplemented from G4UImessenger.

Definition at line 181 of file G4PolarizationMessenger.cc.

{
  G4String cv;
  if(command == verboseCmd)
  {
    cv = verboseCmd->ConvertToString(polarizationManager->GetVerbose());
  }
 
  return cv;
}

References G4UIcommand::ConvertToString(), G4PolarizationManager::GetVerbose(), polarizationManager, and verboseCmd.

◆ ItoS()

G4String G4UImessenger::ItoS ( G4int i )

protectedinherited

Definition at line 82 of file G4UImessenger.cc.

{
  std::ostringstream os;
  os << i;
  return G4String(os.str());
}

Referenced by G4GenericMessenger::DeclareMethod(), and G4ParticleGunMessenger::GetCurrentValue().

◆ operator!=()

G4bool G4UImessenger::operator!= ( const G4UImessenger & messenger ) const

inherited

Definition at line 76 of file G4UImessenger.cc.

{
  return this != &messenger;
}

◆ operator=()

G4PolarizationMessenger & G4PolarizationMessenger::operator= ( const G4PolarizationMessenger & right )

delete

◆ operator==()

G4bool G4UImessenger::operator== ( const G4UImessenger & messenger ) const

inherited

Definition at line 70 of file G4UImessenger.cc.

{
  return this == &messenger;
}

◆ SetNewValue()

void G4PolarizationMessenger::SetNewValue	(	G4UIcommand *	command,
		G4String	newValues
	)

overridevirtual

Reimplemented from G4UImessenger.

Definition at line 134 of file G4PolarizationMessenger.cc.

{
  if(command == verboseCmd)
  {
    polarizationManager->SetVerbose(verboseCmd->GetNewIntValue(newValue));
  }
  else if(command == optActivateCmd)
  {
    polarizationManager->SetActivated(
      optActivateCmd->GetNewBoolValue(newValue));
  }
  else if(command == printVolumeListCmd)
  {
    polarizationManager->ListVolumes();
  }
  else if(command == setPolarizationCmd)
  {
    G4Tokenizer next(newValue);
    G4String volumeName = next();
    G4double px = 0., py = 0., pz = 0.;
    G4String dvalue = next();
    if(!dvalue.empty())
    {
      px     = StoD(dvalue);
      dvalue = next();
      if(!dvalue.empty())
      {
        py     = StoD(dvalue);
        dvalue = next();
        if(!dvalue.empty())
          pz = StoD(dvalue);
      }
    }
    G4ThreeVector pol(px, py, pz);
    polarizationManager->SetVolumePolarization(volumeName, pol);
  }
  else if(command == testPolarizationTransformationCmd)
  {
    G4PolarizationHelper::TestPolarizationTransformations();
  }
  else if(command == testInteractionFrameCmd)
  {
    G4PolarizationHelper::TestInteractionFrame();
  }
}

References G4UIcmdWithABool::GetNewBoolValue(), G4UIcmdWithAnInteger::GetNewIntValue(), G4PolarizationManager::ListVolumes(), optActivateCmd, polarizationManager, printVolumeListCmd, G4PolarizationManager::SetActivated(), setPolarizationCmd, G4PolarizationManager::SetVerbose(), G4PolarizationManager::SetVolumePolarization(), G4UImessenger::StoD(), G4PolarizationHelper::TestInteractionFrame(), testInteractionFrameCmd, testPolarizationTransformationCmd, G4PolarizationHelper::TestPolarizationTransformations(), and verboseCmd.

◆ StoB()

G4bool G4UImessenger::StoB ( G4String s )

protectedinherited

Definition at line 137 of file G4UImessenger.cc.

{
  G4String v = G4StrUtil::to_upper_copy(str);
  G4bool vl = false;
  if(v == "Y" || v == "YES" || v == "1" || v == "T" || v == "TRUE")
  {
    vl = true;
  }
  return vl;
}

References G4StrUtil::to_upper_copy().

Referenced by G4LocalThreadCoutMessenger::SetNewValue(), G4CascadeParamMessenger::SetNewValue(), G4ScoreQuantityMessenger::SetNewValue(), and G4ScoringMessenger::SetNewValue().

◆ StoD()

G4double G4UImessenger::StoD ( G4String s )

protectedinherited

Definition at line 127 of file G4UImessenger.cc.

{
  G4double vl;
  const char* t = str;
  std::istringstream is(t);
  is >> vl;
  return vl;
}

Referenced by G4ScoreQuantityMessenger::FParticleWithEnergyCommand(), G4ParticleGunMessenger::IonCommand(), G4GeneralParticleSourceMessenger::IonCommand(), G4UIcontrolMessenger::SetNewValue(), G4MatScanMessenger::SetNewValue(), G4VisCommandSceneAddText::SetNewValue(), G4VisCommandSceneAddText2D::SetNewValue(), G4ScoreQuantityMessenger::SetNewValue(), G4ScoringMessenger::SetNewValue(), and SetNewValue().

◆ StoI()

G4int G4UImessenger::StoI ( G4String s )

protectedinherited

Definition at line 107 of file G4UImessenger.cc.

{
  G4int vl;
  const char* t = str;
  std::istringstream is(t);
  is >> vl;
  return vl;
}

Referenced by G4ScoringMessenger::Fill1D(), G4ParticleGunMessenger::IonCommand(), G4GeneralParticleSourceMessenger::IonCommand(), G4ParticleGunMessenger::IonLevelCommand(), G4GeneralParticleSourceMessenger::IonLvlCommand(), G4ScoringMessenger::MeshBinCommand(), G4LocalThreadCoutMessenger::SetNewValue(), G4UIcontrolMessenger::SetNewValue(), G4MatScanMessenger::SetNewValue(), G4GMocrenMessenger::SetNewValue(), G4ScoreQuantityMessenger::SetNewValue(), and G4ScoringMessenger::SetNewValue().

◆ StoL()

G4long G4UImessenger::StoL ( G4String s )

protectedinherited

Definition at line 117 of file G4UImessenger.cc.

{
  G4long vl;
  const char* t = str;
  std::istringstream is(t);
  is >> vl;
  return vl;
}

Referenced by G4RunMessenger::SetNewValue().

Field Documentation

◆ baseDir

G4UIdirectory* G4UImessenger::baseDir = nullptr

protectedinherited

Definition at line 102 of file G4UImessenger.hh.

Referenced by G4UImessenger::CreateDirectory(), and G4UImessenger::~G4UImessenger().

◆ baseDirName

G4String G4UImessenger::baseDirName = ""

protectedinherited

Definition at line 103 of file G4UImessenger.hh.

Referenced by G4UImessenger::CreateCommand(), and G4UImessenger::CreateDirectory().

◆ commandsShouldBeInMaster

G4bool G4UImessenger::commandsShouldBeInMaster = false

protectedinherited

Definition at line 104 of file G4UImessenger.hh.

Referenced by G4UImessenger::CommandsShouldBeInMaster(), and G4GeneralParticleSourceMessenger::G4GeneralParticleSourceMessenger().

◆ managerDirectory

G4UIdirectory* G4PolarizationMessenger::managerDirectory

private

Definition at line 70 of file G4PolarizationMessenger.hh.

Referenced by G4PolarizationMessenger(), and ~G4PolarizationMessenger().

◆ optActivateCmd

G4UIcmdWithABool* G4PolarizationMessenger::optActivateCmd

private

Definition at line 72 of file G4PolarizationMessenger.hh.

Referenced by G4PolarizationMessenger(), SetNewValue(), and ~G4PolarizationMessenger().

◆ polarizationDirectory

G4UIdirectory* G4PolarizationMessenger::polarizationDirectory

private

Definition at line 68 of file G4PolarizationMessenger.hh.

Referenced by G4PolarizationMessenger(), and ~G4PolarizationMessenger().

◆ polarizationManager

G4PolarizationManager* G4PolarizationMessenger::polarizationManager

Definition at line 61 of file G4PolarizationMessenger.hh.

Referenced by GetCurrentValue(), and SetNewValue().

◆ printVolumeListCmd

G4UIcmdWithoutParameter* G4PolarizationMessenger::printVolumeListCmd

private

Definition at line 75 of file G4PolarizationMessenger.hh.

Referenced by G4PolarizationMessenger(), SetNewValue(), and ~G4PolarizationMessenger().

◆ setPolarizationCmd

G4UIcommand* G4PolarizationMessenger::setPolarizationCmd

private

Definition at line 76 of file G4PolarizationMessenger.hh.

Referenced by G4PolarizationMessenger(), SetNewValue(), and ~G4PolarizationMessenger().

◆ testDirectory

G4UIdirectory* G4PolarizationMessenger::testDirectory

private

Definition at line 78 of file G4PolarizationMessenger.hh.

Referenced by G4PolarizationMessenger(), and ~G4PolarizationMessenger().

◆ testInteractionFrameCmd

G4UIcmdWithoutParameter* G4PolarizationMessenger::testInteractionFrameCmd

private

Definition at line 80 of file G4PolarizationMessenger.hh.

Referenced by G4PolarizationMessenger(), SetNewValue(), and ~G4PolarizationMessenger().

◆ testPolarizationTransformationCmd

G4UIcmdWithoutParameter* G4PolarizationMessenger::testPolarizationTransformationCmd

private

Definition at line 79 of file G4PolarizationMessenger.hh.

Referenced by G4PolarizationMessenger(), SetNewValue(), and ~G4PolarizationMessenger().

◆ verboseCmd

G4UIcmdWithAnInteger* G4PolarizationMessenger::verboseCmd

private

Definition at line 71 of file G4PolarizationMessenger.hh.

Referenced by G4PolarizationMessenger(), GetCurrentValue(), SetNewValue(), and ~G4PolarizationMessenger().

◆ volumeDirectory

G4UIdirectory* G4PolarizationMessenger::volumeDirectory

private

Definition at line 74 of file G4PolarizationMessenger.hh.

Referenced by G4PolarizationMessenger(), and ~G4PolarizationMessenger().

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

source/processes/electromagnetic/polarisation/include/G4PolarizationMessenger.hh
source/processes/electromagnetic/polarisation/src/G4PolarizationMessenger.cc

Private Attributes
G4UIdirectory *	managerDirectory

G4UIcmdWithABool *	optActivateCmd

G4UIdirectory *	polarizationDirectory

G4UIcmdWithoutParameter *	printVolumeListCmd

G4UIcommand *	setPolarizationCmd

G4UIdirectory *	testDirectory

G4UIcmdWithoutParameter *	testInteractionFrameCmd

G4UIcmdWithoutParameter *	testPolarizationTransformationCmd

G4UIcmdWithAnInteger *	verboseCmd

G4UIdirectory *	volumeDirectory

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ G4PolarizationMessenger() [1/2]

◆ ~G4PolarizationMessenger()

◆ G4PolarizationMessenger() [2/2]

Member Function Documentation

◆ AddUIcommand()

◆ BtoS()

◆ CommandsShouldBeInMaster()

◆ CreateCommand()

◆ CreateDirectory()

◆ DtoS()

◆ GetCurrentValue()

◆ ItoS()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ SetNewValue()

◆ StoB()

◆ StoD()

◆ StoI()

◆ StoL()

Field Documentation

◆ baseDir

◆ baseDirName

◆ commandsShouldBeInMaster

◆ managerDirectory

◆ optActivateCmd

◆ polarizationDirectory

◆ polarizationManager

◆ printVolumeListCmd

◆ setPolarizationCmd

◆ testDirectory

◆ testInteractionFrameCmd

◆ testPolarizationTransformationCmd

◆ verboseCmd

◆ volumeDirectory