G4BlineTracerMessenger Class Reference

#include <Doxymodules_field.h>

Inheritance diagram for G4BlineTracerMessenger:

Public Member Functions
	G4BlineTracerMessenger (G4BlineTracer *aBlineTool)
	~G4BlineTracerMessenger () override
void	SetNewValue (G4UIcommand *command, G4String newValues) override

Private Attributes
G4BlineTracer *	fTheBlineTool = nullptr
G4UIdirectory *	fBlineToolDir = nullptr
G4UIcmdWithAnInteger *	fBlineCmd = nullptr
G4UIcmdWithADoubleAndUnit *	fSetMaxTrackingStepCmd = nullptr
G4UIcmdWith3Vector *	fSetDrawColourCmd = nullptr
G4UIcmdWithABool *	fSetDrawBlineCmd = nullptr
G4UIcmdWithABool *	fSetDrawPointsCmd = nullptr
G4UIcmdWithADouble *	fSetPointSizeCmd = nullptr
G4UIcmdWithoutParameter *	fDrawCmd = nullptr
G4UIcmdWithoutParameter *	fResetCmd = nullptr

Detailed Description

Definition at line 23 of file Doxymodules_field.h.

Constructor & Destructor Documentation

G4BlineTracerMessenger()

G4BlineTracerMessenger::G4BlineTracerMessenger

(

G4BlineTracer *

aBlineTool

)

Definition at line 56 of file G4BlineTracerMessenger.cc.

 : 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::~G4BlineTracerMessenger ( )

override

Definition at line 111 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

SetNewValue()

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

override

Definition at line 126 of file G4BlineTracerMessenger.cc.

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

Member Data Documentation

fTheBlineTool

G4BlineTracer* G4BlineTracerMessenger::fTheBlineTool = nullptr

private

Definition at line 72 of file G4BlineTracerMessenger.hh.

fBlineToolDir

G4UIdirectory* G4BlineTracerMessenger::fBlineToolDir = nullptr

private

Definition at line 73 of file G4BlineTracerMessenger.hh.

fBlineCmd

G4UIcmdWithAnInteger* G4BlineTracerMessenger::fBlineCmd = nullptr

private

Definition at line 77 of file G4BlineTracerMessenger.hh.

fSetMaxTrackingStepCmd

G4UIcmdWithADoubleAndUnit* G4BlineTracerMessenger::fSetMaxTrackingStepCmd = nullptr

private

Definition at line 78 of file G4BlineTracerMessenger.hh.

fSetDrawColourCmd

G4UIcmdWith3Vector* G4BlineTracerMessenger::fSetDrawColourCmd = nullptr

private

Definition at line 79 of file G4BlineTracerMessenger.hh.

fSetDrawBlineCmd

G4UIcmdWithABool* G4BlineTracerMessenger::fSetDrawBlineCmd = nullptr

private

Definition at line 80 of file G4BlineTracerMessenger.hh.

fSetDrawPointsCmd

G4UIcmdWithABool* G4BlineTracerMessenger::fSetDrawPointsCmd = nullptr

private

Definition at line 81 of file G4BlineTracerMessenger.hh.

fSetPointSizeCmd

G4UIcmdWithADouble* G4BlineTracerMessenger::fSetPointSizeCmd = nullptr

private

Definition at line 82 of file G4BlineTracerMessenger.hh.

fDrawCmd

G4UIcmdWithoutParameter* G4BlineTracerMessenger::fDrawCmd = nullptr

private

Definition at line 83 of file G4BlineTracerMessenger.hh.

fResetCmd

G4UIcmdWithoutParameter* G4BlineTracerMessenger::fResetCmd = nullptr

private

Definition at line 84 of file G4BlineTracerMessenger.hh.

---

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

• .doxygen/Doxymodules_field.h
• extended/field/BlineTracer/include/G4BlineTracerMessenger.hh
• extended/field/BlineTracer/src/G4BlineTracerMessenger.cc