Garfield++ 3.0
A toolkit for the detailed simulation of particle detectors based on ionisation measurement in gases and semiconductors
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
Garfield::PlottingEngine Class Reference

Abstract base class for plotting engines. More...

#include <PlottingEngine.hh>

+ Inheritance diagram for Garfield::PlottingEngine:

Public Member Functions

 PlottingEngine ()=delete
 Default constructor.
 
 PlottingEngine (const std::string &name)
 Constructor.
 
virtual ~PlottingEngine ()
 Destructor.
 
void SetSerif ()
 Use serif font.
 
void SetSansSerif ()
 Use sans-serif font.
 
void SetLineColor1 (const std::string &col)
 
void SetLineColor2 (const std::string &col)
 
void SetElectronColor (const std::string &col)
 
void SetHoleColor (const std::string &col)
 
void SetIonColor (const std::string &col)
 
void SetPhotonColor (const std::string &col)
 
void SetChargedParticleColor (const std::string &col)
 
std::string GetLineColor1 () const
 
std::string GetLineColor2 () const
 
std::string GetElectronColor () const
 
std::string GetHoleColor () const
 
std::string GetIonColor () const
 
std::string GetPhotonColor () const
 
std::string GetChargedParticleColor () const
 
void EnableDebugging (const bool on=true)
 Switch debugging messages on/off.
 

Protected Attributes

std::string m_className = "PlottingEngine"
 
bool m_serif = false
 
std::string m_colorLine1 = "dark-blue"
 
std::string m_colorLine2 = "olive"
 
std::string m_colorElectron = "orange"
 
std::string m_colorHole = "red"
 
std::string m_colorIon = "dark-red"
 
std::string m_colorPhoton = "blue"
 
std::string m_colorChargedParticle = "dark-green"
 
bool m_debug = false
 

Detailed Description

Abstract base class for plotting engines.

Definition at line 8 of file PlottingEngine.hh.

Constructor & Destructor Documentation

◆ PlottingEngine() [1/2]

Garfield::PlottingEngine::PlottingEngine ( )
delete

Default constructor.

◆ PlottingEngine() [2/2]

Garfield::PlottingEngine::PlottingEngine ( const std::string &  name)
inline

Constructor.

Definition at line 13 of file PlottingEngine.hh.

13: m_className(name) {}

◆ ~PlottingEngine()

virtual Garfield::PlottingEngine::~PlottingEngine ( )
inlinevirtual

Destructor.

Definition at line 15 of file PlottingEngine.hh.

15{}

Member Function Documentation

◆ EnableDebugging()

void Garfield::PlottingEngine::EnableDebugging ( const bool  on = true)
inline

Switch debugging messages on/off.

Definition at line 42 of file PlottingEngine.hh.

42{ m_debug = on; }

◆ GetChargedParticleColor()

std::string Garfield::PlottingEngine::GetChargedParticleColor ( ) const
inline

Definition at line 39 of file PlottingEngine.hh.

39{ return m_colorChargedParticle; }
Garfield::PlottingEngine::m_colorChargedParticle
std::string m_colorChargedParticle
Definition: PlottingEngine.hh:55

◆ GetElectronColor()

std::string Garfield::PlottingEngine::GetElectronColor ( ) const
inline

Definition at line 35 of file PlottingEngine.hh.

35{ return m_colorElectron; }

◆ GetHoleColor()

std::string Garfield::PlottingEngine::GetHoleColor ( ) const
inline

Definition at line 36 of file PlottingEngine.hh.

36{ return m_colorHole; }

◆ GetIonColor()

std::string Garfield::PlottingEngine::GetIonColor ( ) const
inline

Definition at line 37 of file PlottingEngine.hh.

37{ return m_colorIon; }

◆ GetLineColor1()

std::string Garfield::PlottingEngine::GetLineColor1 ( ) const
inline

Definition at line 33 of file PlottingEngine.hh.

33{ return m_colorLine1; }

◆ GetLineColor2()

std::string Garfield::PlottingEngine::GetLineColor2 ( ) const
inline

Definition at line 34 of file PlottingEngine.hh.

34{ return m_colorLine2; }

◆ GetPhotonColor()

std::string Garfield::PlottingEngine::GetPhotonColor ( ) const
inline

Definition at line 38 of file PlottingEngine.hh.

38{ return m_colorPhoton; }

◆ SetChargedParticleColor()

void Garfield::PlottingEngine::SetChargedParticleColor ( const std::string &  col)
inline

Definition at line 29 of file PlottingEngine.hh.

29 {
30 m_colorChargedParticle = col;
31 }

◆ SetElectronColor()

void Garfield::PlottingEngine::SetElectronColor ( const std::string &  col)
inline

Definition at line 25 of file PlottingEngine.hh.

25{ m_colorElectron = col; }

◆ SetHoleColor()

void Garfield::PlottingEngine::SetHoleColor ( const std::string &  col)
inline

Definition at line 26 of file PlottingEngine.hh.

26{ m_colorHole = col; }

◆ SetIonColor()

void Garfield::PlottingEngine::SetIonColor ( const std::string &  col)
inline

Definition at line 27 of file PlottingEngine.hh.

27{ m_colorIon = col; }

◆ SetLineColor1()

void Garfield::PlottingEngine::SetLineColor1 ( const std::string &  col)
inline

Definition at line 23 of file PlottingEngine.hh.

23{ m_colorLine1 = col; }

◆ SetLineColor2()

void Garfield::PlottingEngine::SetLineColor2 ( const std::string &  col)
inline

Definition at line 24 of file PlottingEngine.hh.

24{ m_colorLine2 = col; }

◆ SetPhotonColor()

void Garfield::PlottingEngine::SetPhotonColor ( const std::string &  col)
inline

Definition at line 28 of file PlottingEngine.hh.

28{ m_colorPhoton = col; }

◆ SetSansSerif()

void Garfield::PlottingEngine::SetSansSerif ( )
inline

Use sans-serif font.

Definition at line 20 of file PlottingEngine.hh.

20{ m_serif = false; }

◆ SetSerif()

void Garfield::PlottingEngine::SetSerif ( )
inline

Use serif font.

Definition at line 18 of file PlottingEngine.hh.

18{ m_serif = true; }

Member Data Documentation

◆ m_className

std::string Garfield::PlottingEngine::m_className = "PlottingEngine"
protected

Definition at line 45 of file PlottingEngine.hh.

Referenced by Garfield::PlottingEngineRoot::GetRootColor().

◆ m_colorChargedParticle

std::string Garfield::PlottingEngine::m_colorChargedParticle = "dark-green"
protected

Definition at line 55 of file PlottingEngine.hh.

Referenced by GetChargedParticleColor(), Garfield::PlottingEngineRoot::GetRootColorChargedParticle(), and SetChargedParticleColor().

◆ m_colorElectron

std::string Garfield::PlottingEngine::m_colorElectron = "orange"
protected

Definition at line 51 of file PlottingEngine.hh.

Referenced by GetElectronColor(), Garfield::PlottingEngineRoot::GetRootColorElectron(), and SetElectronColor().

◆ m_colorHole

std::string Garfield::PlottingEngine::m_colorHole = "red"
protected

Definition at line 52 of file PlottingEngine.hh.

Referenced by GetHoleColor(), Garfield::PlottingEngineRoot::GetRootColorHole(), and SetHoleColor().

◆ m_colorIon

std::string Garfield::PlottingEngine::m_colorIon = "dark-red"
protected

Definition at line 53 of file PlottingEngine.hh.

Referenced by GetIonColor(), Garfield::PlottingEngineRoot::GetRootColorIon(), and SetIonColor().

◆ m_colorLine1

std::string Garfield::PlottingEngine::m_colorLine1 = "dark-blue"
protected

Definition at line 49 of file PlottingEngine.hh.

Referenced by GetLineColor1(), Garfield::PlottingEngineRoot::GetRootColorLine1(), and SetLineColor1().

◆ m_colorLine2

std::string Garfield::PlottingEngine::m_colorLine2 = "olive"
protected

Definition at line 50 of file PlottingEngine.hh.

Referenced by GetLineColor2(), Garfield::PlottingEngineRoot::GetRootColorLine2(), and SetLineColor2().

◆ m_colorPhoton

std::string Garfield::PlottingEngine::m_colorPhoton = "blue"
protected

Definition at line 54 of file PlottingEngine.hh.

Referenced by GetPhotonColor(), Garfield::PlottingEngineRoot::GetRootColorPhoton(), and SetPhotonColor().

◆ m_debug

bool Garfield::PlottingEngine::m_debug = false
protected

Definition at line 57 of file PlottingEngine.hh.

Referenced by EnableDebugging(), and Garfield::PlottingEngineRoot::GetRootColor().

◆ m_serif

bool Garfield::PlottingEngine::m_serif = false
protected

Definition at line 47 of file PlottingEngine.hh.

Referenced by Garfield::PlottingEngineRoot::SetDefaultStyle(), SetSansSerif(), and SetSerif().

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