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

Aperture class. More...

#include <aperture.h>

Inheritance diagram for GMAD::Aperture:
Inheritance graph
Collaboration diagram for GMAD::Aperture:
Collaboration graph

Public Member Functions

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

Data Fields

std::string name
 
std::string apertureType
 
double aper1
 
double aper2
 
double aper3
 
double aper4
 

Private Member Functions

void PublishMembers ()
 publish members More...
 

Additional Inherited Members

- Protected Types inherited from GMAD::Published< Aperture >
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< Aperture >
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 (Aperture *instance, const Aperture *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 Aperture *instance, const std::string &name) const
 Get method for class C. More...
 
void set (Aperture *instance, const std::string &name, double value)
 
void set (Aperture *instance, const std::string &name, GMAD::Array *const &value)
 
void set (Aperture *instance, const std::string &name, const T &value)
 

Detailed Description

Aperture class.

Author
Laurie Nevay

Definition at line 37 of file aperture.h.

Constructor & Destructor Documentation

◆ Aperture()

Aperture::Aperture ( )

Constructor.

Definition at line 23 of file aperture.cc.

References clear(), and PublishMembers().

Here is the call graph for this function:

Member Function Documentation

◆ clear()

void Aperture::clear ( )

Reset.

Definition at line 29 of file aperture.cc.

Referenced by Aperture().

Here is the caller graph for this function:

◆ print()

void Aperture::print ( ) const

Print some properties.

Definition at line 55 of file aperture.cc.

◆ PublishMembers()

void Aperture::PublishMembers ( )
private

publish members

Definition at line 39 of file aperture.cc.

References GMAD::Published< Aperture >::publish().

Referenced by Aperture().

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

◆ set_value()

template<typename T >
void GMAD::Aperture::set_value ( std::string  name,
value 
)

Set methods by property name and value.

Definition at line 63 of file aperture.h.

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

Here is the call graph for this function:

Field Documentation

◆ aper1

double GMAD::Aperture::aper1

Definition at line 42 of file aperture.h.

◆ aper2

double GMAD::Aperture::aper2

Definition at line 43 of file aperture.h.

◆ aper3

double GMAD::Aperture::aper3

Definition at line 44 of file aperture.h.

◆ aper4

double GMAD::Aperture::aper4

Definition at line 45 of file aperture.h.

◆ apertureType

std::string GMAD::Aperture::apertureType

Definition at line 41 of file aperture.h.

◆ name

std::string GMAD::Aperture::name

Definition at line 40 of file aperture.h.


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