G4VisCommandMultithreadingMaxEventQueueSize Class Reference

#include <G4VisCommandsMultithreading.hh>

Inheritance diagram for G4VisCommandMultithreadingMaxEventQueueSize:

Public Member Functions
	G4VisCommandMultithreadingMaxEventQueueSize ()
virtual	~G4VisCommandMultithreadingMaxEventQueueSize ()
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 52 of file G4VisCommandsMultithreading.hh.

Constructor & Destructor Documentation

G4VisCommandMultithreadingMaxEventQueueSize()

G4VisCommandMultithreadingMaxEventQueueSize::G4VisCommandMultithreadingMaxEventQueueSize

(

)

Definition at line 96 of file G4VisCommandsMultithreading.cc.

{
  G4bool omitable;
  fpCommand = new G4UIcmdWithAnInteger("/vis/multithreading/maxEventQueueSize", this);
  fpCommand->SetGuidance
  ("Defines maximum event queue size. N <=0 means \"unlimited\".");
  fpCommand->SetGuidance
  ("If adding an event to the visualisation event queue would cause the"
   " queue size to exceed this value:");
  fpCommand->SetGuidance
  (" if actionOnEventQueueFull==wait the worker threads are paused for a short"
   " time to give the visualisation manager a chance to catch up.");
  fpCommand->SetGuidance
  (" if actionOnEventQueueFull==discard the event is discarded for drawing.");
  fpCommand->SetParameterName ("maxSize", omitable = true);
  fpCommand->SetDefaultValue (100);
}

~G4VisCommandMultithreadingMaxEventQueueSize()

G4VisCommandMultithreadingMaxEventQueueSize::~G4VisCommandMultithreadingMaxEventQueueSize ( )

virtual

Definition at line 114 of file G4VisCommandsMultithreading.cc.

{
  delete fpCommand;
}

Member Function Documentation

GetCurrentValue()

G4String G4VisCommandMultithreadingMaxEventQueueSize::GetCurrentValue ( G4UIcommand * command )

virtual

Reimplemented from G4UImessenger.

Definition at line 119 of file G4VisCommandsMultithreading.cc.

{
  return "";
}

SetNewValue()

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

virtual

Reimplemented from G4UImessenger.

Definition at line 124 of file G4VisCommandsMultithreading.cc.

{
  G4VisManager::Verbosity verbosity = fpVisManager->GetVerbosity();
 
  // Only relevant in a MT application
  if(!G4Threading::IsMultithreadedApplication()) {
    if (verbosity >= G4VisManager::warnings) {
      G4warn << "command /vis/multithreading/maxEventQueueSize ignored in sequential mode" << G4endl;
    }
    return;
  }
 
  G4int maxEventQueueSize = fpCommand->GetNewIntValue(newValue);
  fpVisManager->SetMaxEventQueueSize(maxEventQueueSize);
 
  if (verbosity >= G4VisManager::confirmations) {
    G4cout <<
    "Maximum event queue size has been set to "
       << fpVisManager->GetMaxEventQueueSize()
       << G4endl;
  }
}

---

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

• G4VisCommandsMultithreading.hh
• G4VisCommandsMultithreading.cc