Belle II Software development
Public Member Functions | Private Member Functions | Private Attributes | List of all members
GeoOpticalSurface Class Reference
Packages » geometry

Represent an optical finish of a surface. More...

#include <GeoOpticalSurface.h>

Inheritance diagram for GeoOpticalSurface:

Public Member Functions

 GeoOpticalSurface ()=default
 empty constructor for ROOT
 
 GeoOpticalSurface (const std::string &name, int model, int finish, int type, double value)
 real constructor
 
void setName (const std::string &name)
 set name of the optical surface
 
void setModel (int model)
 set model for the surface
 
void setFinish (int finish)
 set finish of the surface
 
void setType (int type)
 set type of the surface
 
void setValue (double value)
 set value for the surface condition
 
void addProperty (const GeoMaterialProperty &property)
 add a property to the material
 
const std::string & getName () const
 get name of the optical surface
 
int getModel () const
 get model for the surface
 
int getFinish () const
 get finish of the surface
 
int getType () const
 get type of the surface
 
double getValue () const
 get value for the surface condition
 
const std::vector< GeoMaterialProperty > & getProperties () const
 get all properties
 
bool hasProperties () const
 check if the material has at least one property
 

Private Member Functions

 ClassDef (GeoOpticalSurface, 1)
 Add ROOT reflection info.
 

Private Attributes

std::string m_name
 name of the optical surface
 
int m_model
 model for the surface
 
int m_finish
 finish of the surface
 
int m_type
 type of the surface
 
double m_value
 value for the surface condition
 
std::vector< GeoMaterialProperty > m_properties
 properties of this material
 

Detailed Description

Represent an optical finish of a surface.

Definition at line 21 of file GeoOpticalSurface.h.

Constructor & Destructor Documentation

◆ GeoOpticalSurface()

GeoOpticalSurface ( const std::string &  name,
int  model,
int  finish,
int  type,
double  value 
)
inline

real constructor

Definition at line 26 of file GeoOpticalSurface.h.

26 : TObject(), m_name(name), m_model(model),
27 m_finish(finish), m_type(type), m_value(value) {}
Belle2::GeoOpticalSurface::m_model
int m_model
model for the surface
Definition: GeoOpticalSurface.h:59
Belle2::GeoOpticalSurface::m_type
int m_type
type of the surface
Definition: GeoOpticalSurface.h:63
Belle2::GeoOpticalSurface::m_finish
int m_finish
finish of the surface
Definition: GeoOpticalSurface.h:61
Belle2::GeoOpticalSurface::m_name
std::string m_name
name of the optical surface
Definition: GeoOpticalSurface.h:57
Belle2::GeoOpticalSurface::m_value
double m_value
value for the surface condition
Definition: GeoOpticalSurface.h:65

Member Function Documentation

◆ addProperty()

void addProperty ( const GeoMaterialProperty &  property)
inline

add a property to the material

Definition at line 39 of file GeoOpticalSurface.h.

39{ m_properties.emplace_back(property); }
Belle2::GeoOpticalSurface::m_properties
std::vector< GeoMaterialProperty > m_properties
properties of this material
Definition: GeoOpticalSurface.h:67

◆ getFinish()

int getFinish ( ) const
inline

get finish of the surface

Definition at line 45 of file GeoOpticalSurface.h.

45{ return m_finish; }

◆ getModel()

int getModel ( ) const
inline

get model for the surface

Definition at line 43 of file GeoOpticalSurface.h.

43{ return m_model; }

◆ getName()

const std::string & getName ( ) const
inline

get name of the optical surface

Definition at line 41 of file GeoOpticalSurface.h.

41{ return m_name; }

◆ getProperties()

const std::vector< GeoMaterialProperty > & getProperties ( ) const
inline

get all properties

Definition at line 51 of file GeoOpticalSurface.h.

51{ return m_properties; }

◆ getType()

int getType ( ) const
inline

get type of the surface

Definition at line 47 of file GeoOpticalSurface.h.

47{ return m_type; }

◆ getValue()

double getValue ( ) const
inline

get value for the surface condition

Definition at line 49 of file GeoOpticalSurface.h.

49{ return m_value; }

◆ hasProperties()

bool hasProperties ( ) const
inline

check if the material has at least one property

Returns
true if there is at least one property

Definition at line 54 of file GeoOpticalSurface.h.

54{ return m_properties.size() > 0; }

◆ setFinish()

void setFinish ( int  finish)
inline

set finish of the surface

Definition at line 33 of file GeoOpticalSurface.h.

33{ m_finish = finish; }

◆ setModel()

void setModel ( int  model)
inline

set model for the surface

Definition at line 31 of file GeoOpticalSurface.h.

31{ m_model = model; }

◆ setName()

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

set name of the optical surface

Definition at line 29 of file GeoOpticalSurface.h.

29{ m_name = name; }

◆ setType()

void setType ( int  type)
inline

set type of the surface

Definition at line 35 of file GeoOpticalSurface.h.

35{ m_type = type; }

◆ setValue()

void setValue ( double  value)
inline

set value for the surface condition

Definition at line 37 of file GeoOpticalSurface.h.

37{ m_value = value; }

Member Data Documentation

◆ m_finish

int m_finish
private

finish of the surface

Definition at line 61 of file GeoOpticalSurface.h.

◆ m_model

int m_model
private

model for the surface

Definition at line 59 of file GeoOpticalSurface.h.

◆ m_name

std::string m_name
private

name of the optical surface

Definition at line 57 of file GeoOpticalSurface.h.

◆ m_properties

std::vector<GeoMaterialProperty> m_properties
private

properties of this material

Definition at line 67 of file GeoOpticalSurface.h.

◆ m_type

int m_type
private

type of the surface

Definition at line 63 of file GeoOpticalSurface.h.

◆ m_value

double m_value
private

value for the surface condition

Definition at line 65 of file GeoOpticalSurface.h.

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