G4VisCommandSetVolumeForField Class Reference

#include <G4VisCommandsSet.hh>

Inheritance diagram for G4VisCommandSetVolumeForField:

Public Member Functions
	G4VisCommandSetVolumeForField ()
virtual	~G4VisCommandSetVolumeForField ()
G4String	GetCurrentValue (G4UIcommand *command)
void	SetNewValue (G4UIcommand *command, G4String newValue)
Public Member Functions inherited from G4VVisCommand
	G4VVisCommand ()
virtual	~G4VVisCommand ()
Public Member Functions inherited from G4UImessenger
	G4UImessenger ()=default
	G4UImessenger (const G4String &path, const G4String &dsc, G4bool commandsToBeBroadcasted=true)
virtual	~G4UImessenger ()
G4bool	CommandsShouldBeInMaster () const

Additional Inherited Members
Static Public Member Functions inherited from G4VVisCommand
static G4VisManager *	GetVisManager ()
static void	SetVisManager (G4VisManager *pVisManager)
static const G4Colour &	GetCurrentTextColour ()
Protected Member Functions inherited from G4VVisCommand
void	SetViewParameters (G4VViewer *viewer, const G4ViewParameters &viewParams)
void	RefreshIfRequired (G4VViewer *viewer)
void	InterpolateViews (G4VViewer *currentViewer, const std::vector< G4ViewParameters > &viewVector, const G4int nInterpolationPoints=50, const G4int waitTimePerPointmilliseconds=20, const G4String &exportString="")
void	InterpolateToNewView (G4VViewer *currentViewer, const G4ViewParameters &oldVP, const G4ViewParameters &newVP, const G4int nInterpolationPoints=50, const G4int waitTimePerPointmilliseconds=20, const G4String &exportString="")
void	Twinkle (G4VViewer *currentViewer, const G4ViewParameters &baseVP, const std::vector< std::vector< G4PhysicalVolumeModel::G4PhysicalVolumeNodeID > > &paths)
const G4String &	ConvertToColourGuidance ()
void	ConvertToColour (G4Colour &colour, const G4String &redOrString, G4double green, G4double blue, G4double opacity)
G4bool	ProvideValueOfUnit (const G4String &where, const G4String &unit, const G4String &category, G4double &value)
void	CopyCameraParameters (G4ViewParameters &target, const G4ViewParameters &from)
void	CheckSceneAndNotifyHandlers (G4Scene *=nullptr)
G4bool	CheckView ()
void	G4VisCommandsSceneAddUnsuccessful (G4VisManager::Verbosity verbosity)
void	CopyGuidanceFrom (const G4UIcommand *fromCmd, G4UIcommand *toCmd, G4int startLine=0)
void	CopyParametersFrom (const G4UIcommand *fromCmd, G4UIcommand *toCmd)
void	DrawExtent (const G4VisExtent &)
Protected Member Functions inherited from G4UImessenger
G4String	ItoS (G4int i)
G4String	LtoS (G4long l)
G4String	DtoS (G4double a)
G4String	BtoS (G4bool b)
G4int	StoI (const G4String &s)
G4long	StoL (const G4String &s)
G4double	StoD (const G4String &s)
G4bool	StoB (const 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)
Static Protected Member Functions inherited from G4VVisCommand
static G4String	ConvertToString (G4double x, G4double y, const char *unitName)
static G4bool	ConvertToDoublePair (const G4String &paramString, G4double &xval, G4double &yval)
Protected Attributes inherited from G4UImessenger
G4UIdirectory *	baseDir = nullptr
G4String	baseDirName = ""
G4bool	commandsShouldBeInMaster = false
Static Protected Attributes inherited from G4VVisCommand
static G4VisManager *	fpVisManager = nullptr
static G4int	fCurrentArrow3DLineSegmentsPerCircle = 6
static G4Colour	fCurrentColour = G4Colour::White()
static G4double	fCurrentLineWidth = 1.
static G4Colour	fCurrentTextColour = G4Colour::Blue()
static G4Text::Layout	fCurrentTextLayout = G4Text::left
static G4double	fCurrentTextSize = 12.
static G4PhysicalVolumeModel::TouchableProperties	fCurrentTouchableProperties
static G4VisExtent	fCurrentExtentForField
static std::vector< G4PhysicalVolumesSearchScene::Findings >	fCurrrentPVFindingsForField
static G4bool	fThereWasAViewer = false
static G4ViewParameters	fExistingVP
static G4SceneTreeItem	fExistingSceneTree

Detailed Description

Definition at line 137 of file G4VisCommandsSet.hh.

Constructor & Destructor Documentation

G4VisCommandSetVolumeForField()

G4VisCommandSetVolumeForField::G4VisCommandSetVolumeForField

(

)

Definition at line 518 of file G4VisCommandsSet.cc.

{
  G4bool omitable;
  G4UIparameter* parameter;
  fpCommand = new G4UIcommand("/vis/set/volumeForField", this);
  fpCommand->SetGuidance
  ("Sets a volume for \"/vis/scene/add/*Field\" commands.");
  fpCommand->SetGuidance
  ("Takes a volume name or a /regular expression/ -- see guidance for"
   "\n\"/vis/drawVolume\"");
  parameter = new G4UIparameter ("physical-volume-name", 's', omitable = false);
  fpCommand -> SetParameter (parameter);
  parameter = new G4UIparameter ("copy-no", 'i', omitable = true);
  parameter -> SetGuidance ("If negative, matches any copy no.");
  parameter -> SetDefaultValue (-1);
  fpCommand -> SetParameter (parameter);
  parameter = new G4UIparameter ("draw", 'b', omitable = true);
  parameter -> SetGuidance ("If true, draw extent of found volumes.");
  parameter -> SetDefaultValue (false);
  fpCommand -> SetParameter (parameter);
}

~G4VisCommandSetVolumeForField()

G4VisCommandSetVolumeForField::~G4VisCommandSetVolumeForField ( )

virtual

Definition at line 540 of file G4VisCommandsSet.cc.

{
  delete fpCommand;
}

Member Function Documentation

GetCurrentValue()

G4String G4VisCommandSetVolumeForField::GetCurrentValue ( G4UIcommand * command )

virtual

Reimplemented from G4UImessenger.

Definition at line 545 of file G4VisCommandsSet.cc.

{
  return G4String();
}

SetNewValue()

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

virtual

Reimplemented from G4UImessenger.

Definition at line 550 of file G4VisCommandsSet.cc.

{
  G4VisManager::Verbosity verbosity = fpVisManager->GetVerbosity();
 
  G4String name, drawString;
  G4int copyNo;
  std::istringstream is (newValue);
  is >> name >> copyNo >> drawString;
  G4bool draw = G4UIcmdWithABool::ConvertToBool(drawString);
 
  G4TransportationManager* transportationManager =
  G4TransportationManager::GetTransportationManager ();
  size_t nWorlds = transportationManager->GetNoWorlds();
  std::vector<G4VPhysicalVolume*>::iterator iterWorld =
  transportationManager->GetWorldsIterator();
  fCurrrentPVFindingsForField.clear();
  G4BoundingExtentScene extentScene;
  for (size_t i = 0; i < nWorlds; ++i, ++iterWorld) {
    G4PhysicalVolumeModel searchModel (*iterWorld);  // Unlimited depth.
    G4ModelingParameters mp;  // Default - no culling.
    searchModel.SetModelingParameters (&mp);
    // Find all instances at any position in the tree
    G4PhysicalVolumesSearchScene searchScene (&searchModel, name, copyNo);
    searchModel.DescribeYourselfTo (searchScene);  // Initiate search.
    for (const auto& findings: searchScene.GetFindings()) {
      fCurrrentPVFindingsForField.push_back(findings);
      G4VisExtent extent = findings.fpFoundPV->GetLogicalVolume()->GetSolid()->GetExtent();
      extent.Transform(findings.fFoundObjectTransformation);
      extentScene.AccrueBoundingExtent(extent);
    }
  }
 
  if (fCurrrentPVFindingsForField.empty()) {
    if (verbosity >= G4VisManager::errors) {
      G4warn << "ERROR: Volume \"" << name << "\"";
      if (copyNo >= 0) {
        G4warn << ", copy no. " << copyNo << ",";
      }
      G4warn << " not found." << G4endl;
    }
    return;
  }
 
  fCurrentExtentForField = extentScene.GetExtent();
 
  if (draw) DrawExtent(fCurrentExtentForField);
 
  if (verbosity >= G4VisManager::confirmations) {
    for (const auto& findings: fCurrrentPVFindingsForField) {
      G4cout
      << "\"" << findings.fpFoundPV->GetName()
      << "\", copy no. " << findings.fFoundPVCopyNo
      << ", found\nin searched volume \""
      << findings.fpSearchPV->GetName()
      << "\" at depth " << findings.fFoundDepth
      << ",\nbase path: \"" << findings.fFoundBasePVPath
      << "\",\nand has been set as volume for field."
      << G4endl;
    }
  }
}

---

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

• G4VisCommandsSet.hh
• G4VisCommandsSet.cc