Garfield++ v2r0
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 ()
 Constructor.
 
virtual ~PlottingEngine ()
 Destructor.
 
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 ()
 
void DisableDebugging ()
 

Protected Attributes

std::string m_className
 
std::string m_colorLine1
 
std::string m_colorLine2
 
std::string m_colorElectron
 
std::string m_colorHole
 
std::string m_colorIon
 
std::string m_colorPhoton
 
std::string m_colorChargedParticle
 
bool m_debug
 

Detailed Description

Abstract base class for plotting engines.

Definition at line 11 of file PlottingEngine.hh.

Constructor & Destructor Documentation

◆ PlottingEngine()

Garfield::PlottingEngine::PlottingEngine ( )
inline

Constructor.

Definition at line 15 of file PlottingEngine.hh.

16 : m_className("PlottingEngine"),
17 m_colorLine1("dark-blue"),
18 m_colorLine2("olive"),
19 m_colorElectron("orange"),
20 m_colorHole("red"),
21 m_colorIon("dark-red"),
22 m_colorPhoton("blue"),
23 m_colorChargedParticle("dark-green"),
24 m_debug(false) {}
Garfield::PlottingEngine::m_colorChargedParticle
std::string m_colorChargedParticle
Definition: PlottingEngine.hh:60

◆ ~PlottingEngine()

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

Destructor.

Definition at line 27 of file PlottingEngine.hh.

27{}

Member Function Documentation

◆ DisableDebugging()

void Garfield::PlottingEngine::DisableDebugging ( )
inline

Definition at line 50 of file PlottingEngine.hh.

50{ m_debug = false; }

◆ EnableDebugging()

void Garfield::PlottingEngine::EnableDebugging ( )
inline

Definition at line 49 of file PlottingEngine.hh.

49{ m_debug = true; }

◆ GetChargedParticleColor()

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

Definition at line 46 of file PlottingEngine.hh.

46{ return m_colorChargedParticle; }

◆ GetElectronColor()

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

Definition at line 42 of file PlottingEngine.hh.

42{ return m_colorElectron; }

◆ GetHoleColor()

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

Definition at line 43 of file PlottingEngine.hh.

43{ return m_colorHole; }

◆ GetIonColor()

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

Definition at line 44 of file PlottingEngine.hh.

44{ return m_colorIon; }

◆ GetLineColor1()

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

Definition at line 40 of file PlottingEngine.hh.

40{ return m_colorLine1; }

◆ GetLineColor2()

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

Definition at line 41 of file PlottingEngine.hh.

41{ return m_colorLine2; }

◆ GetPhotonColor()

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

Definition at line 45 of file PlottingEngine.hh.

45{ return m_colorPhoton; }

◆ SetChargedParticleColor()

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

Definition at line 36 of file PlottingEngine.hh.

36 {
37 m_colorChargedParticle = col;
38 }

◆ SetElectronColor()

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

Definition at line 32 of file PlottingEngine.hh.

32{ m_colorElectron = col; }

◆ SetHoleColor()

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

Definition at line 33 of file PlottingEngine.hh.

33{ m_colorHole = col; }

◆ SetIonColor()

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

Definition at line 34 of file PlottingEngine.hh.

34{ m_colorIon = col; }

◆ SetLineColor1()

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

Definition at line 30 of file PlottingEngine.hh.

30{ m_colorLine1 = col; }

◆ SetLineColor2()

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

Definition at line 31 of file PlottingEngine.hh.

31{ m_colorLine2 = col; }

◆ SetPhotonColor()

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

Definition at line 35 of file PlottingEngine.hh.

35{ m_colorPhoton = col; }

Member Data Documentation

◆ m_className

std::string Garfield::PlottingEngine::m_className
protected

Definition at line 53 of file PlottingEngine.hh.

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

◆ m_colorChargedParticle

std::string Garfield::PlottingEngine::m_colorChargedParticle
protected

Definition at line 60 of file PlottingEngine.hh.

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

◆ m_colorElectron

std::string Garfield::PlottingEngine::m_colorElectron
protected

Definition at line 56 of file PlottingEngine.hh.

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

◆ m_colorHole

std::string Garfield::PlottingEngine::m_colorHole
protected

Definition at line 57 of file PlottingEngine.hh.

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

◆ m_colorIon

std::string Garfield::PlottingEngine::m_colorIon
protected

Definition at line 58 of file PlottingEngine.hh.

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

◆ m_colorLine1

std::string Garfield::PlottingEngine::m_colorLine1
protected

Definition at line 55 of file PlottingEngine.hh.

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

◆ m_colorLine2

std::string Garfield::PlottingEngine::m_colorLine2
protected

Definition at line 55 of file PlottingEngine.hh.

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

◆ m_colorPhoton

std::string Garfield::PlottingEngine::m_colorPhoton
protected

Definition at line 59 of file PlottingEngine.hh.

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

◆ m_debug

bool Garfield::PlottingEngine::m_debug
protected

Definition at line 62 of file PlottingEngine.hh.

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

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