HadrontherapyDetectorMessenger Class Reference

#include <HadrontherapyDetectorMessenger.hh>

Inheritance diagram for HadrontherapyDetectorMessenger:

Collaboration diagram for HadrontherapyDetectorMessenger:

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

Private Attributes
HadrontherapyDetectorConstruction *	hadrontherapyDetector
G4UIdirectory *	changeThePhantomDir
G4UIdirectory *	changeTheDetectorDir
G4UIcmdWithoutParameter *	updateCmd
G4UIcmdWithAString *	changeThePhantomMaterialCmd
G4UIcmdWith3VectorAndUnit *	changeThePhantomSizeCmd
G4UIcmdWith3VectorAndUnit *	changeThePhantomPositionCmd
G4UIcmdWith3VectorAndUnit *	changeTheDetectorSizeCmd
G4UIcmdWith3VectorAndUnit *	changeTheDetectorToPhantomPositionCmd
G4UIcmdWith3VectorAndUnit *	changeTheDetectorVoxelCmd

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 41 of file HadrontherapyDetectorMessenger.hh.

Constructor & Destructor Documentation

HadrontherapyDetectorMessenger()

HadrontherapyDetectorMessenger::HadrontherapyDetectorMessenger

(

HadrontherapyDetectorConstruction *

detector

)

Definition at line 39 of file HadrontherapyDetectorMessenger.cc.

  :hadrontherapyDetector(detector)
{
    // Change Phantom size
    changeThePhantomDir = new G4UIdirectory("/changePhantom/");
    changeThePhantomDir -> SetGuidance("Command to change the Phantom Size/position");
    changeThePhantomSizeCmd = new G4UIcmdWith3VectorAndUnit("/changePhantom/size", this);
    changeThePhantomSizeCmd -> SetGuidance("Insert sizes X Y and Z"
                                       "\n   0 or negative values mean <<Don't change it!>>");
    changeThePhantomSizeCmd -> SetParameterName("PhantomSizeAlongX", 
                        "PhantomSizeAlongY", 
                        "PhantomSizeAlongZ", false);
    changeThePhantomSizeCmd -> SetDefaultUnit("mm");
    changeThePhantomSizeCmd -> SetUnitCandidates("nm um mm cm"); 
    changeThePhantomSizeCmd -> AvailableForStates(G4State_Idle);


    // Change Phantom material 
    changeThePhantomMaterialCmd = new G4UIcmdWithAString("/changePhantom/material", this);
    changeThePhantomMaterialCmd -> SetGuidance("Change the Phantom and the detector material"); 
    changeThePhantomMaterialCmd -> SetParameterName("PhantomMaterial", false);
    changeThePhantomMaterialCmd -> SetDefaultValue("G4_WATER");
    changeThePhantomMaterialCmd -> AvailableForStates(G4State_Idle);

    // Change Phantom position
    changeThePhantomPositionCmd = new G4UIcmdWith3VectorAndUnit("/changePhantom/position", this);
    changeThePhantomPositionCmd -> SetGuidance("Insert X Y and Z dimensions for the position of the center of the Phantom"
                        " respect to that of the \"World\""); 
    changeThePhantomPositionCmd -> SetParameterName("PositionAlongX", 
                            "PositionAlongY", 
                            "PositionAlongZ", false);
    changeThePhantomPositionCmd -> SetDefaultUnit("mm");
    changeThePhantomPositionCmd -> SetUnitCandidates("um mm cm m"); 
    changeThePhantomPositionCmd -> AvailableForStates(G4State_Idle);


    updateCmd = new G4UIcmdWithoutParameter("/changePhantom/update",this);
    updateCmd->SetGuidance("Update Phantom/Detector geometry.");
    updateCmd->SetGuidance("This command MUST be applied before \"beamOn\" ");
    updateCmd->SetGuidance("if you changed geometrical value(s).");
    updateCmd->AvailableForStates(G4State_Idle);

    //  Change detector size
    changeTheDetectorDir = new G4UIdirectory("/changeDetector/");
    changeTheDetectorDir -> SetGuidance("Command to change the Detector's Size/position/Voxels");
    
    changeTheDetectorSizeCmd = new G4UIcmdWith3VectorAndUnit("/changeDetector/size",this);
    changeTheDetectorSizeCmd -> SetGuidance("Insert sizes for X Y and Z dimensions of the Detector"
                        "\n   0 or negative values mean <<Don't change it>>");
    changeTheDetectorSizeCmd -> SetParameterName("DetectorSizeAlongX", "DetectorSizeAlongY", "DetectorSizeAlongZ", false);
    changeTheDetectorSizeCmd -> SetDefaultUnit("mm");
    changeTheDetectorSizeCmd -> SetUnitCandidates("nm um mm cm"); 
    changeTheDetectorSizeCmd -> AvailableForStates(G4State_Idle);

    //  Change the detector to phantom displacement
    changeTheDetectorToPhantomPositionCmd = new G4UIcmdWith3VectorAndUnit("/changeDetector/displacement",this);
    changeTheDetectorToPhantomPositionCmd -> SetGuidance("Insert X Y and Z displacements between Detector and Phantom"
                                                     "\nNegative values mean <<Don't change it!>>"); 
    changeTheDetectorToPhantomPositionCmd -> SetParameterName("DisplacementAlongX",
                                  "DisplacementAlongY", 
                                  "DisplacementAlongZ", false);
    changeTheDetectorToPhantomPositionCmd -> SetDefaultUnit("mm");
    changeTheDetectorToPhantomPositionCmd -> SetUnitCandidates("nm um mm cm"); 
    changeTheDetectorToPhantomPositionCmd -> AvailableForStates(G4State_Idle);
    
    // Change voxels by its size
    changeTheDetectorVoxelCmd = new G4UIcmdWith3VectorAndUnit("/changeDetector/voxelSize",this);
    changeTheDetectorVoxelCmd -> SetGuidance("Insert Voxel sizes for X Y and Z dimensions"
                                     "\n   0 or negative values mean <<Don't change it!>>");
    changeTheDetectorVoxelCmd -> SetParameterName("VoxelSizeAlongX", "VoxelSizeAlongY", "VoxelSizeAlongZ", false);
    changeTheDetectorVoxelCmd -> SetDefaultUnit("mm");
    changeTheDetectorVoxelCmd -> SetUnitCandidates("nm um mm cm");
    changeTheDetectorVoxelCmd -> AvailableForStates(G4State_Idle);

}

Here is the call graph for this function:

~HadrontherapyDetectorMessenger()

HadrontherapyDetectorMessenger::~HadrontherapyDetectorMessenger

(

)

Definition at line 116 of file HadrontherapyDetectorMessenger.cc.

{
    delete changeThePhantomDir; 
    delete changeThePhantomSizeCmd; 
    delete changeThePhantomPositionCmd; 
    delete changeThePhantomMaterialCmd; 
    delete updateCmd;
    delete changeTheDetectorDir; 
    delete changeTheDetectorSizeCmd; 
    delete changeTheDetectorToPhantomPositionCmd; 
    delete changeTheDetectorVoxelCmd;
}

Member Function Documentation

SetNewValue()

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

virtual

Reimplemented from G4UImessenger.

Definition at line 130 of file HadrontherapyDetectorMessenger.cc.

{
    
  if( command == changeThePhantomSizeCmd)
    {
    G4ThreeVector size = changeThePhantomSizeCmd -> GetNew3VectorValue(newValue);
    hadrontherapyDetector -> SetPhantomSize(size.getX(),size.getY(),size.getZ());
    }
  else if (command == changeThePhantomPositionCmd )
  {
     G4ThreeVector size = changeThePhantomPositionCmd -> GetNew3VectorValue(newValue);
         hadrontherapyDetector -> SetPhantomPosition(size);
  }
  else if (command == changeThePhantomMaterialCmd)
  {
      hadrontherapyDetector -> SetPhantomMaterial(newValue);
  }
  else if (command == changeTheDetectorSizeCmd)
  {
    G4ThreeVector size = changeTheDetectorSizeCmd  -> GetNew3VectorValue(newValue);
        hadrontherapyDetector -> SetDetectorSize(size.getX(),size.getY(),size.getZ());
  }
  else if (command == changeTheDetectorToPhantomPositionCmd)
  {
    G4ThreeVector size = changeTheDetectorToPhantomPositionCmd-> GetNew3VectorValue(newValue);
        hadrontherapyDetector -> SetDetectorToPhantomPosition(size);
  }
  else if (command == changeTheDetectorVoxelCmd)
  {
    G4ThreeVector size = changeTheDetectorVoxelCmd  -> GetNew3VectorValue(newValue);
        hadrontherapyDetector -> SetVoxelSize(size.getX(),size.getY(),size.getZ());
  }
  else if (command == updateCmd)
  {
      hadrontherapyDetector -> UpdateGeometry();
  }
}

Here is the call graph for this function:

Member Data Documentation

changeTheDetectorDir

G4UIdirectory * HadrontherapyDetectorMessenger::changeTheDetectorDir

private

Definition at line 54 of file HadrontherapyDetectorMessenger.hh.

changeTheDetectorSizeCmd

G4UIcmdWith3VectorAndUnit * HadrontherapyDetectorMessenger::changeTheDetectorSizeCmd

private

Definition at line 58 of file HadrontherapyDetectorMessenger.hh.

changeTheDetectorToPhantomPositionCmd

G4UIcmdWith3VectorAndUnit * HadrontherapyDetectorMessenger::changeTheDetectorToPhantomPositionCmd

private

Definition at line 58 of file HadrontherapyDetectorMessenger.hh.

changeTheDetectorVoxelCmd

G4UIcmdWith3VectorAndUnit * HadrontherapyDetectorMessenger::changeTheDetectorVoxelCmd

private

Definition at line 58 of file HadrontherapyDetectorMessenger.hh.

changeThePhantomDir

G4UIdirectory* HadrontherapyDetectorMessenger::changeThePhantomDir

private

Definition at line 54 of file HadrontherapyDetectorMessenger.hh.

changeThePhantomMaterialCmd

G4UIcmdWithAString* HadrontherapyDetectorMessenger::changeThePhantomMaterialCmd

private

Definition at line 57 of file HadrontherapyDetectorMessenger.hh.

changeThePhantomPositionCmd

G4UIcmdWith3VectorAndUnit * HadrontherapyDetectorMessenger::changeThePhantomPositionCmd

private

Definition at line 58 of file HadrontherapyDetectorMessenger.hh.

changeThePhantomSizeCmd

G4UIcmdWith3VectorAndUnit* HadrontherapyDetectorMessenger::changeThePhantomSizeCmd

private

Definition at line 58 of file HadrontherapyDetectorMessenger.hh.

hadrontherapyDetector

HadrontherapyDetectorConstruction* HadrontherapyDetectorMessenger::hadrontherapyDetector

private

Definition at line 52 of file HadrontherapyDetectorMessenger.hh.

updateCmd

G4UIcmdWithoutParameter* HadrontherapyDetectorMessenger::updateCmd

private

Definition at line 56 of file HadrontherapyDetectorMessenger.hh.

---

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

• HadrontherapyDetectorMessenger.hh
• HadrontherapyDetectorMessenger.cc