G4BlineTracerMessenger Class Reference

#include <G4BlineTracerMessenger.hh>

Inheritance diagram for G4BlineTracerMessenger:

Public Member Functions
	G4BlineTracerMessenger (G4BlineTracer *aBlineTool)
virtual	~G4BlineTracerMessenger ()
virtual void	SetNewValue (G4UIcommand *command, G4String newValues)
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

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

Detailed Description

Definition at line 62 of file G4BlineTracerMessenger.hh.

Constructor & Destructor Documentation

G4BlineTracerMessenger::G4BlineTracerMessenger

(

G4BlineTracer *

aBlineTool

)

Definition at line 57 of file G4BlineTracerMessenger.cc.

References G4UIcommand::AvailableForStates(), G4State_Idle, G4State_PreInit, G4UIcommand::SetGuidance(), G4UIcmdWithAnInteger::SetParameterName(), G4UIcmdWithADouble::SetParameterName(), and G4UIcmdWithABool::SetParameterName().

{
  fTheBlineTool = aBlineTool;
  fBlineToolDir = new G4UIdirectory("/vis/blineTracer/");
  fBlineToolDir->SetGuidance("Commands to trace and visualise magnetic field lines.");
  fBlineToolDir->SetGuidance("These commands work only if a magnetic-field is set");
  fBlineToolDir->SetGuidance("in the application.");

  // commands

  fBlineCmd = new G4UIcmdWithAnInteger("/vis/blineTracer/computeBline",this);
  fBlineCmd->SetGuidance("Compute magnetic field lines for visualisation.");
  fBlineCmd->SetParameterName("nb_of_lines",false);
  fBlineCmd->AvailableForStates(G4State_PreInit,G4State_Idle);
  
  fSetMaxTrackingStepCmd =
    new G4UIcmdWithADoubleAndUnit("/vis/blineTracer/setMaxStepLength",this); 
  fSetMaxTrackingStepCmd->SetGuidance("Set the maximum length of tracking step");
  fSetMaxTrackingStepCmd->SetGuidance("when integrating magnetic field line.");
  fSetMaxTrackingStepCmd->AvailableForStates(G4State_PreInit,G4State_Idle);
  
  fSetDrawColourCmd = new G4UIcmdWith3Vector("/vis/blineTracer/setColour",this);
  fSetDrawColourCmd->SetGuidance("Set the colour drawing trajectories");
  fSetDrawColourCmd->SetGuidance("and magnetic field lines.");
  fSetDrawColourCmd->AvailableForStates(G4State_PreInit,G4State_Idle);

  fSetDrawBlineCmd = new G4UIcmdWithABool("/vis/blineTracer/stockLines",this);
  fSetDrawBlineCmd->SetGuidance("If true field lines are stocked in lines");
  fSetDrawBlineCmd->SetGuidance("to be drawn.");
  fSetDrawBlineCmd->SetParameterName("StockLines",false);
  fSetDrawBlineCmd->AvailableForStates(G4State_PreInit,G4State_Idle);
  
  fSetDrawPointsCmd = new G4UIcmdWithABool("/vis/blineTracer/stockPoints",this);
  fSetDrawPointsCmd->SetGuidance("If true step field line points are stocked");
  fSetDrawPointsCmd->SetGuidance("in vector of points to be drawn.");
  fSetDrawPointsCmd->SetParameterName("StockPoints",false);
  fSetDrawPointsCmd->AvailableForStates(G4State_PreInit,G4State_Idle);
  
  fSetPointSizeCmd = new G4UIcmdWithADouble("/vis/blineTracer/setPointSize",this);
  fSetPointSizeCmd->SetGuidance("Set the size of points for drawing.");
  fSetPointSizeCmd->SetParameterName("StepSize",false);
  fSetPointSizeCmd->AvailableForStates(G4State_PreInit,G4State_Idle);
  
  fDrawCmd = new G4UIcmdWithoutParameter("/vis/blineTracer/show",this);
  fDrawCmd->SetGuidance("Show the stored magnetic field lines.");
  fDrawCmd->AvailableForStates(G4State_PreInit,G4State_Idle);
  
  fResetCmd =
    new G4UIcmdWithoutParameter("/vis/blineTracer/resetMaterialToBeDrawn",this);
  fResetCmd->SetGuidance("Clear the vectors of lines and points to be drawn.");
  fResetCmd->AvailableForStates(G4State_PreInit,G4State_Idle);
}

G4BlineTracerMessenger::~G4BlineTracerMessenger ( )

virtual

Definition at line 112 of file G4BlineTracerMessenger.cc.

{
  delete fResetCmd;
  delete fDrawCmd;
  delete fSetPointSizeCmd;
  delete fSetDrawPointsCmd;
  delete fSetDrawBlineCmd;
  delete fSetDrawColourCmd;
  delete fSetMaxTrackingStepCmd;
  delete fBlineCmd;
  delete fBlineToolDir;
}  

Member Function Documentation

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

virtual

Reimplemented from G4UImessenger.

Definition at line 127 of file G4BlineTracerMessenger.cc.

References G4BlineTracer::ComputeBlines(), G4BlineEventAction::DrawFieldLines(), G4BlineTracer::GetEventAction(), G4UIcmdWith3Vector::GetNew3VectorValue(), G4BlineEventAction::ResetVectorObjectToBeDrawn(), G4BlineEventAction::SetDrawBline(), G4BlineEventAction::SetDrawPoints(), G4BlineTracer::SetMaxTrackingStep(), G4BlineEventAction::SetPointSize(), CLHEP::Hep3Vector::x(), CLHEP::Hep3Vector::y(), and CLHEP::Hep3Vector::z().

{ 
  if (command == fBlineCmd)
    fTheBlineTool->ComputeBlines(1);
  else if( command == fSetMaxTrackingStepCmd ) 
    fTheBlineTool->SetMaxTrackingStep(fSetMaxTrackingStepCmd
                                   ->GetNewDoubleValue(newValues));
  else if( command == fSetDrawBlineCmd ) 
    fTheBlineTool->GetEventAction()->SetDrawBline(fSetDrawBlineCmd
                                   ->GetNewBoolValue(newValues));
  else if( command == fSetDrawColourCmd ) 
  {
    G4ThreeVector vec=fSetDrawColourCmd->GetNew3VectorValue(newValues);
    fTheBlineTool->GetEventAction()->
                  SetDrawColour(G4Colour(vec.x(),vec.y(),vec.z()));
  }
  else if( command == fSetDrawPointsCmd ) 
    fTheBlineTool->GetEventAction()->SetDrawPoints(fSetDrawPointsCmd
                                   ->GetNewBoolValue(newValues));
  else if( command == fSetPointSizeCmd ) 
    fTheBlineTool->GetEventAction()->SetPointSize(fSetPointSizeCmd
                                   ->GetNewDoubleValue(newValues));      
  else if( command == fDrawCmd ) 
    fTheBlineTool->GetEventAction()->DrawFieldLines(.5,45.,45.);
  else if( command == fResetCmd )
    fTheBlineTool->GetEventAction()->ResetVectorObjectToBeDrawn();
}

---

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

• G4BlineTracerMessenger.hh
• G4BlineTracerMessenger.cc