Belle II Software development
TOPGeoFrontEnd Class Reference

Geometry parameters of board stack (front-end electronic module) More...

#include <TOPGeoFrontEnd.h>

Inheritance diagram for TOPGeoFrontEnd:
TOPGeoBase

Public Member Functions

 TOPGeoFrontEnd ()
 Default constructor.
 
void setFrontBoard (double width, double height, double thickness, double gap, double y, const std::string &material)
 Sets front board data.
 
void setHVBoard (double width, double length, double thickness, double gap, double y, const std::string &material)
 Sets HV board data.
 
void setBoardStack (double width, double height, double length, double gap, double y, const std::string &material, double spacerWidth, const std::string &spacerMaterial)
 Sets board stack data.
 
double getFrontBoardWidth () const
 Returns front board width.
 
double getFrontBoardHeight () const
 Returns front board height.
 
double getFrontBoardThickness () const
 Returns front board thickness.
 
double getFrontBoardGap () const
 Returns gap between front board and PMT array.
 
double getFrontBoardY () const
 Returns position of front board center in bar frame.
 
const std::string & getFrontBoardMaterial () const
 Returns front board material.
 
double getHVBoardWidth () const
 Returns HV board width.
 
double getHVBoardLength () const
 Returns HV board length.
 
double getHVBoardThickness () const
 Returns HV board thickness.
 
double getHVBoardGap () const
 Returns gap between HV board and front board.
 
double getHVBoardY () const
 Returns position of HV board center in bar frame.
 
const std::string & getHVBoardMaterial () const
 Returns HV board material.
 
double getBoardStackWidth () const
 Returns board stack width.
 
double getBoardStackHeight () const
 Returns board stack height.
 
double getBoardStackLength () const
 Returns board stack length.
 
double getBoardStackGap () const
 Returns gap between board stack and front board.
 
double getBoardStackY () const
 Returns position of board stack center in bar frame.
 
const std::string & getBoardStackMaterial () const
 Returns board stack material.
 
double getSpacerWidth () const
 Returns board stack spacer width.
 
const std::string & getSpacerMaterial () const
 Returns board stack spacer material.
 
bool isConsistent () const override
 Check for consistency of data members.
 
virtual void print (const std::string &title="Front-end geometry parameters") const override
 Print the content of the class.
 
void setName (const std::string &name)
 Sets object name.
 
const std::string & getName () const
 Returns object name.
 
virtual void printSurface (const GeoOpticalSurface &surface) const
 Print the content of optical surface.
 
double getReflectivity (const GeoOpticalSurface &surface, double energy) const
 Returns reflectivity of optical surface at given photon energy.
 

Protected Member Functions

void printUnderlined (const std::string &title) const
 Print the content of the class.
 
 ClassDef (TOPGeoBase, 1)
 ClassDef.
 

Protected Attributes

std::string m_name
 geometry object name
 

Static Protected Attributes

static double s_unit = Unit::cm
 conversion unit for length
 
static std::string s_unitName
 conversion unit name
 

Private Member Functions

 ClassDefOverride (TOPGeoFrontEnd, 1)
 ClassDef.
 

Private Attributes

float m_FBWidth = 0
 front board width
 
float m_FBHeight = 0
 front board height
 
float m_FBThickness = 0
 front board thickness
 
float m_FBGap = 0
 gap between front board and PMT array
 
float m_FBy = 0
 position of front board center in bar frame
 
std::string m_FBMaterial
 front board material
 
float m_HVWidth = 0
 HV board width.
 
float m_HVLength = 0
 HV board length.
 
float m_HVThickness = 0
 HV board thickness.
 
float m_HVGap = 0
 gap between HV board and front board
 
float m_HVy = 0
 position of HV board center in bar frame
 
std::string m_HVMaterial
 HV board material.
 
float m_BSWidth = 0
 board stack width
 
float m_BSHeight = 0
 board stack height
 
float m_BSLength = 0
 board stack length
 
float m_BSGap = 0
 gap between board stack and front board
 
float m_BSy = 0
 position of board stack center in bar frame
 
std::string m_BSMaterial
 board stack material
 
float m_spacerWidth = 0
 board stack spacer width
 
std::string m_spacerMaterial
 board stack spacer material
 

Detailed Description

Geometry parameters of board stack (front-end electronic module)

Definition at line 23 of file TOPGeoFrontEnd.h.

Constructor & Destructor Documentation

◆ TOPGeoFrontEnd()

TOPGeoFrontEnd ( )
inline

Default constructor.

Definition at line 29 of file TOPGeoFrontEnd.h.

29 : TOPGeoBase("TOPFrontEnd")
30 {}
TOPGeoBase()
Default constructor.
Definition: TOPGeoBase.h:31

Member Function Documentation

◆ getBoardStackGap()

double getBoardStackGap ( ) const
inline

Returns gap between board stack and front board.

Returns
gap

Definition at line 195 of file TOPGeoFrontEnd.h.

195{return m_BSGap / s_unit;}
float m_BSGap
gap between board stack and front board
static double s_unit
conversion unit for length
Definition: TOPGeoBase.h:86

◆ getBoardStackHeight()

double getBoardStackHeight ( ) const
inline

Returns board stack height.

Returns
height

Definition at line 183 of file TOPGeoFrontEnd.h.

183{return m_BSHeight / s_unit;}
float m_BSHeight
board stack height

◆ getBoardStackLength()

double getBoardStackLength ( ) const
inline

Returns board stack length.

Returns
length

Definition at line 189 of file TOPGeoFrontEnd.h.

189{return m_BSLength / s_unit;}
float m_BSLength
board stack length

◆ getBoardStackMaterial()

const std::string & getBoardStackMaterial ( ) const
inline

Returns board stack material.

Returns
material

Definition at line 207 of file TOPGeoFrontEnd.h.

207{return m_BSMaterial;}
std::string m_BSMaterial
board stack material

◆ getBoardStackWidth()

double getBoardStackWidth ( ) const
inline

Returns board stack width.

Returns
width

Definition at line 177 of file TOPGeoFrontEnd.h.

177{return m_BSWidth / s_unit;}
float m_BSWidth
board stack width

◆ getBoardStackY()

double getBoardStackY ( ) const
inline

Returns position of board stack center in bar frame.

Returns
y

Definition at line 201 of file TOPGeoFrontEnd.h.

201{return m_BSy / s_unit;}
float m_BSy
position of board stack center in bar frame

◆ getFrontBoardGap()

double getFrontBoardGap ( ) const
inline

Returns gap between front board and PMT array.

Returns
gap

Definition at line 121 of file TOPGeoFrontEnd.h.

121{return m_FBGap / s_unit;}
float m_FBGap
gap between front board and PMT array

◆ getFrontBoardHeight()

double getFrontBoardHeight ( ) const
inline

Returns front board height.

Returns
height

Definition at line 109 of file TOPGeoFrontEnd.h.

109{return m_FBHeight / s_unit;}
float m_FBHeight
front board height

◆ getFrontBoardMaterial()

const std::string & getFrontBoardMaterial ( ) const
inline

Returns front board material.

Returns
material

Definition at line 133 of file TOPGeoFrontEnd.h.

133{return m_FBMaterial;}
std::string m_FBMaterial
front board material

◆ getFrontBoardThickness()

double getFrontBoardThickness ( ) const
inline

Returns front board thickness.

Returns
thickness

Definition at line 115 of file TOPGeoFrontEnd.h.

115{return m_FBThickness / s_unit;}
float m_FBThickness
front board thickness

◆ getFrontBoardWidth()

double getFrontBoardWidth ( ) const
inline

Returns front board width.

Returns
width

Definition at line 103 of file TOPGeoFrontEnd.h.

103{return m_FBWidth / s_unit;}
float m_FBWidth
front board width

◆ getFrontBoardY()

double getFrontBoardY ( ) const
inline

Returns position of front board center in bar frame.

Returns
y

Definition at line 127 of file TOPGeoFrontEnd.h.

127{return m_FBy / s_unit;}
float m_FBy
position of front board center in bar frame

◆ getHVBoardGap()

double getHVBoardGap ( ) const
inline

Returns gap between HV board and front board.

Returns
gap

Definition at line 158 of file TOPGeoFrontEnd.h.

158{return m_HVGap / s_unit;}
float m_HVGap
gap between HV board and front board

◆ getHVBoardLength()

double getHVBoardLength ( ) const
inline

Returns HV board length.

Returns
length

Definition at line 146 of file TOPGeoFrontEnd.h.

146{return m_HVLength / s_unit;}
float m_HVLength
HV board length.

◆ getHVBoardMaterial()

const std::string & getHVBoardMaterial ( ) const
inline

Returns HV board material.

Returns
material

Definition at line 170 of file TOPGeoFrontEnd.h.

170{return m_HVMaterial;}
std::string m_HVMaterial
HV board material.

◆ getHVBoardThickness()

double getHVBoardThickness ( ) const
inline

Returns HV board thickness.

Returns
thickness

Definition at line 152 of file TOPGeoFrontEnd.h.

152{return m_HVThickness / s_unit;}
float m_HVThickness
HV board thickness.

◆ getHVBoardWidth()

double getHVBoardWidth ( ) const
inline

Returns HV board width.

Returns
width

Definition at line 140 of file TOPGeoFrontEnd.h.

140{return m_HVWidth / s_unit;}
float m_HVWidth
HV board width.

◆ getHVBoardY()

double getHVBoardY ( ) const
inline

Returns position of HV board center in bar frame.

Returns
y

Definition at line 164 of file TOPGeoFrontEnd.h.

164{return m_HVy / s_unit;}
float m_HVy
position of HV board center in bar frame

◆ getName()

const std::string & getName ( ) const
inlineinherited

Returns object name.

Returns
object name

Definition at line 51 of file TOPGeoBase.h.

51{return m_name;}
std::string m_name
geometry object name
Definition: TOPGeoBase.h:89

◆ getSpacerMaterial()

const std::string & getSpacerMaterial ( ) const
inline

Returns board stack spacer material.

Returns
material

Definition at line 219 of file TOPGeoFrontEnd.h.

219{return m_spacerMaterial;}
std::string m_spacerMaterial
board stack spacer material

◆ getSpacerWidth()

double getSpacerWidth ( ) const
inline

Returns board stack spacer width.

Returns
width

Definition at line 213 of file TOPGeoFrontEnd.h.

213{return m_spacerWidth / s_unit;}
float m_spacerWidth
board stack spacer width

◆ setBoardStack()

void setBoardStack ( double  width,
double  height,
double  length,
double  gap,
double  y,
const std::string &  material,
double  spacerWidth,
const std::string &  spacerMaterial 
)
inline

Sets board stack data.

Parameters
widthboard stack width
heightboard stack height
lengthboard stack length
gapgap between board stack and front board
yposition of board stack center in bar frame
materialboard stack material
spacerWidthspacer width
spacerMaterialspacer material

Definition at line 85 of file TOPGeoFrontEnd.h.

88 {
89 m_BSWidth = width;
90 m_BSHeight = height;
91 m_BSLength = length;
92 m_BSGap = gap;
93 m_BSy = y;
94 m_BSMaterial = material;
95 m_spacerWidth = spacerWidth;
96 m_spacerMaterial = spacerMaterial;
97 }

◆ setFrontBoard()

void setFrontBoard ( double  width,
double  height,
double  thickness,
double  gap,
double  y,
const std::string &  material 
)
inline

Sets front board data.

Parameters
widthfront board width
heightfront board height
thicknessfront board thickness
gapgap between front board and PMT array
yposition of front board center in bar frame
materialfront board material

Definition at line 41 of file TOPGeoFrontEnd.h.

43 {
44 m_FBWidth = width;
45 m_FBHeight = height;
46 m_FBThickness = thickness;
47 m_FBGap = gap;
48 m_FBy = y;
49 m_FBMaterial = material;
50 }

◆ setHVBoard()

void setHVBoard ( double  width,
double  length,
double  thickness,
double  gap,
double  y,
const std::string &  material 
)
inline

Sets HV board data.

Parameters
widthHV board width
lengthHV board length
thicknessHV board thickness
gapgap between HV board and front board
yposition of HV board center in bar frame
materialHV board material

Definition at line 62 of file TOPGeoFrontEnd.h.

64 {
65 m_HVWidth = width;
66 m_HVLength = length;
67 m_HVThickness = thickness;
68 m_HVGap = gap;
69 m_HVy = y;
70 m_HVMaterial = material;
71 }

◆ setName()

void setName ( const std::string &  name)
inlineinherited

Sets object name.

Parameters
nameobject name

Definition at line 45 of file TOPGeoBase.h.

45{m_name = name;}

Member Data Documentation

◆ m_BSGap

float m_BSGap = 0
private

gap between board stack and front board

Definition at line 252 of file TOPGeoFrontEnd.h.

◆ m_BSHeight

float m_BSHeight = 0
private

board stack height

Definition at line 250 of file TOPGeoFrontEnd.h.

◆ m_BSLength

float m_BSLength = 0
private

board stack length

Definition at line 251 of file TOPGeoFrontEnd.h.

◆ m_BSMaterial

std::string m_BSMaterial
private

board stack material

Definition at line 254 of file TOPGeoFrontEnd.h.

◆ m_BSWidth

float m_BSWidth = 0
private

board stack width

Definition at line 249 of file TOPGeoFrontEnd.h.

◆ m_BSy

float m_BSy = 0
private

position of board stack center in bar frame

Definition at line 253 of file TOPGeoFrontEnd.h.

◆ m_FBGap

float m_FBGap = 0
private

gap between front board and PMT array

Definition at line 238 of file TOPGeoFrontEnd.h.

◆ m_FBHeight

float m_FBHeight = 0
private

front board height

Definition at line 236 of file TOPGeoFrontEnd.h.

◆ m_FBMaterial

std::string m_FBMaterial
private

front board material

Definition at line 240 of file TOPGeoFrontEnd.h.

◆ m_FBThickness

float m_FBThickness = 0
private

front board thickness

Definition at line 237 of file TOPGeoFrontEnd.h.

◆ m_FBWidth

float m_FBWidth = 0
private

front board width

Definition at line 235 of file TOPGeoFrontEnd.h.

◆ m_FBy

float m_FBy = 0
private

position of front board center in bar frame

Definition at line 239 of file TOPGeoFrontEnd.h.

◆ m_HVGap

float m_HVGap = 0
private

gap between HV board and front board

Definition at line 245 of file TOPGeoFrontEnd.h.

◆ m_HVLength

float m_HVLength = 0
private

HV board length.

Definition at line 243 of file TOPGeoFrontEnd.h.

◆ m_HVMaterial

std::string m_HVMaterial
private

HV board material.

Definition at line 247 of file TOPGeoFrontEnd.h.

◆ m_HVThickness

float m_HVThickness = 0
private

HV board thickness.

Definition at line 244 of file TOPGeoFrontEnd.h.

◆ m_HVWidth

float m_HVWidth = 0
private

HV board width.

Definition at line 242 of file TOPGeoFrontEnd.h.

◆ m_HVy

float m_HVy = 0
private

position of HV board center in bar frame

Definition at line 246 of file TOPGeoFrontEnd.h.

◆ m_name

std::string m_name
protectedinherited

geometry object name

Definition at line 89 of file TOPGeoBase.h.

◆ m_spacerMaterial

std::string m_spacerMaterial
private

board stack spacer material

Definition at line 256 of file TOPGeoFrontEnd.h.

◆ m_spacerWidth

float m_spacerWidth = 0
private

board stack spacer width

Definition at line 255 of file TOPGeoFrontEnd.h.


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