BDSIM
BDSIM is a Geant4 extension toolkit for simulation of particle transport in accelerator beamlines.
Public Member Functions | Data Fields | Private Member Functions
GMAD::Tunnel Class Reference

Tunnel class for parser. More...

#include <tunnel.h>

Inheritance diagram for GMAD::Tunnel:
Inheritance graph
Collaboration diagram for GMAD::Tunnel:
Collaboration graph

Public Member Functions

 Tunnel ()
 constructor More...
 
void clear ()
 reset More...
 
void print () const
 print some properties More...
 
template<typename T >
void set_value (std::string property, T value)
 set methods by property name and value More...
 
- Public Member Functions inherited from GMAD::Published< Tunnel >
bool NameExists (const std::string &name) const
 
Published< Tunnel >::template AttributeMap< T > & attribute_map () const
 

Data Fields

std::string name
 
std::string type
 geometry type More...
 
double aper1
 radius, aperture parameters More...
 
double aper2
 
double offsetX
 offset x and y More...
 
double offsetY
 
double thickness
 tunnel geometry parameters More...
 
double soilThickness
 
double floorOffset
 
int visible
 visibility More...
 
std::string material
 material More...
 
std::string soilMaterial
 soil More...
 
std::string startElement
 start and end element by name More...
 
std::string endElement
 

Private Member Functions

void PublishMembers ()
 Publish members. More...
 

Additional Inherited Members

- Protected Types inherited from GMAD::Published< Tunnel >
using AttributeMap = typename std::unordered_map< std::string, T C::* >
 Define AttributeMap of string and class member pointer. More...
 
- Protected Member Functions inherited from GMAD::Published< Tunnel >
void publish (const std::string &name, T C::*mp)
 Make pointer to member from class C and type T with accessible with a name. More...
 
void set (Tunnel *instance, const Tunnel *instance2, const std::string &name)
 Set member with name of class instance to value of second instance. More...
 
AttributeMap< T > & attribute_map () const
 Access method to static map for type T and class C.
 
get (const Tunnel *instance, const std::string &name) const
 Get method for class C. More...
 
void set (Tunnel *instance, const std::string &name, double value)
 
void set (Tunnel *instance, const std::string &name, GMAD::Array *const &value)
 
void set (Tunnel *instance, const std::string &name, const T &value)
 

Detailed Description

Tunnel class for parser.

Author
Jochem Snuverink

Definition at line 35 of file tunnel.h.

Constructor & Destructor Documentation

◆ Tunnel()

Tunnel::Tunnel ( )

constructor

Definition at line 23 of file tunnel.cc.

References PublishMembers().

Here is the call graph for this function:

Member Function Documentation

◆ clear()

void Tunnel::clear ( )

reset

Definition at line 32 of file tunnel.cc.

References aper1, material, name, offsetX, soilMaterial, startElement, thickness, type, and visible.

◆ print()

void Tunnel::print ( ) const

print some properties

Definition at line 71 of file tunnel.cc.

References aper1, material, name, offsetX, soilMaterial, startElement, thickness, and type.

◆ PublishMembers()

void Tunnel::PublishMembers ( )
private

Publish members.

Definition at line 52 of file tunnel.cc.

References aper1, material, name, offsetX, GMAD::Published< Tunnel >::publish(), soilMaterial, startElement, thickness, type, and visible.

Referenced by Tunnel().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ set_value()

template<typename T >
void GMAD::Tunnel::set_value ( std::string  property,
value 
)

set methods by property name and value

Definition at line 79 of file tunnel.h.

References GMAD::Published< Tunnel >::set().

Here is the call graph for this function:

Field Documentation

◆ aper1

double GMAD::Tunnel::aper1

radius, aperture parameters

Definition at line 43 of file tunnel.h.

Referenced by clear(), print(), and PublishMembers().

◆ aper2

double GMAD::Tunnel::aper2

Definition at line 44 of file tunnel.h.

◆ endElement

std::string GMAD::Tunnel::endElement

Definition at line 61 of file tunnel.h.

◆ floorOffset

double GMAD::Tunnel::floorOffset

Definition at line 50 of file tunnel.h.

◆ material

std::string GMAD::Tunnel::material

material

Definition at line 56 of file tunnel.h.

Referenced by clear(), print(), and PublishMembers().

◆ name

std::string GMAD::Tunnel::name

name

Definition at line 38 of file tunnel.h.

Referenced by clear(), print(), and PublishMembers().

◆ offsetX

double GMAD::Tunnel::offsetX

offset x and y

Definition at line 46 of file tunnel.h.

Referenced by clear(), print(), and PublishMembers().

◆ offsetY

double GMAD::Tunnel::offsetY

Definition at line 46 of file tunnel.h.

◆ soilMaterial

std::string GMAD::Tunnel::soilMaterial

soil

Definition at line 58 of file tunnel.h.

Referenced by clear(), print(), and PublishMembers().

◆ soilThickness

double GMAD::Tunnel::soilThickness

Definition at line 49 of file tunnel.h.

◆ startElement

std::string GMAD::Tunnel::startElement

start and end element by name

Definition at line 61 of file tunnel.h.

Referenced by clear(), print(), and PublishMembers().

◆ thickness

double GMAD::Tunnel::thickness

tunnel geometry parameters

Definition at line 48 of file tunnel.h.

Referenced by clear(), print(), and PublishMembers().

◆ type

std::string GMAD::Tunnel::type

geometry type

Definition at line 40 of file tunnel.h.

Referenced by clear(), print(), and PublishMembers().

◆ visible

int GMAD::Tunnel::visible

visibility

Definition at line 53 of file tunnel.h.

Referenced by clear(), and PublishMembers().


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