G4PlotParameters Class Reference

#include <G4PlotParameters.hh>

Public Member Functions
	G4PlotParameters ()
void	SetLayout (G4int columns, G4int rows)
void	SetDimensions (G4int width, G4int height)
void	SetStyle (const G4String &style)
G4int	GetMaxColumns ()
G4int	GetMaxRows ()
G4String	GetAvailableStyles ()
G4int	GetColumns () const
G4int	GetRows () const
G4int	GetWidth () const
G4int	GetHeight () const
G4float	GetScale () const
G4String	GetStyle () const

Detailed Description

Definition at line 40 of file G4PlotParameters.hh.

Constructor & Destructor Documentation

G4PlotParameters()

G4PlotParameters::G4PlotParameters

(

)

Definition at line 35 of file G4PlotParameters.cc.

 : fMessenger(nullptr),
   fDefaultColumns(1),
   fDefaultRows   (2), 
#if defined(TOOLS_USE_FREETYPE)
   //Have vertical A4 :
   fDefaultWidth(2000), 
   fDefaultHeight((G4int)(29.7f/21.0f*fDefaultWidth)),
   fDefaultStyle("ROOT_default"),
   fDefaultScale(0.9f),
   fMaxColumns(3),
   fMaxRows   (5),
   fAvailableStyles("ROOT_default hippodrow inlib_default"), 
#else
   fDefaultWidth (700),
   fDefaultHeight((G4int)(29.7f/21.0f*fDefaultWidth)),
   fDefaultStyle("inlib_default"),
   fDefaultScale(0.9f),
   fMaxColumns(2),
   fMaxRows   (3),
   fAvailableStyles("inlib_default"),
#endif
   fColumns(fDefaultColumns), 
   fRows(fDefaultRows), 
   fWidth(fDefaultWidth), 
   fHeight(fDefaultHeight),
   fScale(fDefaultScale),
   fStyle(fDefaultStyle)
{
   fMessenger = G4Analysis::make_unique<G4PlotMessenger>(this);
}

Member Function Documentation

GetAvailableStyles()

G4String G4PlotParameters::GetAvailableStyles ( )

inline

Definition at line 94 of file G4PlotParameters.hh.

{ return fAvailableStyles; }

GetColumns()

G4int G4PlotParameters::GetColumns ( ) const

inline

Definition at line 97 of file G4PlotParameters.hh.

{ return fColumns; }

Referenced by G4PlotManager::G4PlotManager(), and G4PlotManager::PlotAndWrite().

GetHeight()

G4int G4PlotParameters::GetHeight ( ) const

inline

Definition at line 106 of file G4PlotParameters.hh.

{ return fHeight; }

Referenced by G4PlotManager::G4PlotManager().

GetMaxColumns()

G4int G4PlotParameters::GetMaxColumns ( )

inline

Definition at line 88 of file G4PlotParameters.hh.

{ return fMaxColumns; }

GetMaxRows()

G4int G4PlotParameters::GetMaxRows ( )

inline

Definition at line 91 of file G4PlotParameters.hh.

{ return fMaxRows; }

GetRows()

G4int G4PlotParameters::GetRows ( ) const

inline

Definition at line 100 of file G4PlotParameters.hh.

{ return fRows; }

Referenced by G4PlotManager::G4PlotManager(), and G4PlotManager::PlotAndWrite().

GetScale()

G4float G4PlotParameters::GetScale ( ) const

inline

Definition at line 109 of file G4PlotParameters.hh.

{ return fScale; }

GetStyle()

G4String G4PlotParameters::GetStyle ( ) const

inline

Definition at line 112 of file G4PlotParameters.hh.

{ return fStyle; }

Referenced by G4PlotManager::PlotAndWrite().

GetWidth()

G4int G4PlotParameters::GetWidth ( ) const

inline

Definition at line 103 of file G4PlotParameters.hh.

{ return fWidth; }

Referenced by G4PlotManager::G4PlotManager().

SetDimensions()

void G4PlotParameters::SetDimensions	(	G4int	width,
		G4int	height
	)

Definition at line 93 of file G4PlotParameters.cc.

{ 
  fWidth = width; 
  fHeight = height;
}

Referenced by G4PlotMessenger::SetNewValue().

SetLayout()

void G4PlotParameters::SetLayout	(	G4int	columns,
		G4int	rows
	)

Definition at line 72 of file G4PlotParameters.cc.

{
  if ( columns > rows ||
       columns < 1 || columns > fMaxColumns || 
       rows < 1 || rows > fMaxRows ) {
    G4ExceptionDescription description;
    description 
      << "Layout: " << columns << " x " << rows << " was ignored." << G4endl
      << "Supported layouts: " << G4endl
      << "  columns <= rows" << G4endl
      << "  columns = 1 .. " << fMaxColumns << G4endl
      << "  rows    = 1 .. " << fMaxRows << G4endl;
    G4Exception("G4PlotParameters::SetLayout",
                "Analysis_W013", JustWarning, description);
    return;
  }
  fColumns = columns;
  fRows = rows;
}

Referenced by G4PlotMessenger::SetNewValue().

SetStyle()

void G4PlotParameters::SetStyle

(

const G4String &

style

)

Definition at line 100 of file G4PlotParameters.cc.

{
// Set style and update scale according to the style selected
 
  if ( fAvailableStyles.find(style) == std::string::npos ) {
    G4ExceptionDescription description;
    description 
      << "Style: " << style << " was ignored." << G4endl
      << "Supported styles: " << fAvailableStyles << G4endl;
    G4Exception("G4PlotParameters::SetLayout",
                "Analysis_W013", JustWarning, description);
    return;
  }
 
  fStyle = style;
 
  if ( fStyle == "ROOT_default" ) {
    fScale = fDefaultScale;
  } else {
    fScale = 1.f;       
  }
}

Referenced by G4PlotMessenger::SetNewValue().

---

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

• G4PlotParameters.hh
• G4PlotParameters.cc