Sampler placement class for parser. More...

#include <samplerplacement.h>

Inheritance diagram for GMAD::SamplerPlacement:

Collaboration diagram for GMAD::SamplerPlacement:

Public Member Functions
	SamplerPlacement ()
	constructor

void	clear ()
	reset

void	print () const
	print some properties

template<typename T >
void	set_value (std::string property, T value)
	set methods by property name and value

Public Member Functions inherited from GMAD::Published< SamplerPlacement >
bool	NameExists (const std::string &name) const

Published< SamplerPlacement >::template AttributeMap< T > &	attribute_map () const

Data Fields
std::string	name
	Name of this samplerplacement.

std::string	samplerType
	Plane, Cylinder, Sphere.

std::string	referenceElement
	Name of reference element w.r.t. to place to.

int	referenceElementNumber
	Index of repetition of element if there are multiple uses.

double	s
	Curvilinear s position to place w.r.t..

double	x
	Offset in x.

double	y
	Offset in y.

double	z

bool	axisAngle
	Flag to use the axis angle construction of rotation.

std::string	apertureModel

std::string	shape

double	aper1

double	aper2

double	aper3

double	aper4

double	startAnglePhi

double	sweepAnglePhi

double	startAngleTheta

double	sweepAngleTheta

std::list< double >	partID
	List of PDG IDs of which particles to record for - default is empty, so all particles.

int	partIDSetID
	The unique ID of the particle set given by the parser.


double	phi
	Euler angle for rotation.

double	theta
	Euler angle for rotation.

double	psi
	Euler angle for rotation.


double	axisX

double	axisY

double	axisZ

double	angle

Private Member Functions
void	PublishMembers ()
	publish members

Additional Inherited Members
Protected Types inherited from GMAD::Published< SamplerPlacement >
using	AttributeMap = typename std::unordered_map< std::string, T C::* >
	Define AttributeMap of string and class member pointer.

Protected Member Functions inherited from GMAD::Published< SamplerPlacement >
void	publish (const std::string &name, T C::*mp)
	Make pointer to member from class C and type T with accessible with a name.

void	set (SamplerPlacement instance, const SamplerPlacement instance2, const std::string &name)
	Set member with name of class instance to value of second instance.

AttributeMap< T > &	attribute_map () const
	Access method to static map for type T and class C.

T	get (const SamplerPlacement *instance, const std::string &name) const
	Get method for class C.

void	set (SamplerPlacement *instance, const std::string &name, double value)

void	set (SamplerPlacement instance, const std::string &name, GMAD::Array const &value)

void	set (SamplerPlacement *instance, const std::string &name, const T &value)

Detailed Description

Sampler placement class for parser.

Author: Laurie Nevay

Definition at line 36 of file samplerplacement.h.

Constructor & Destructor Documentation

◆ SamplerPlacement()

SamplerPlacement::SamplerPlacement ( )

constructor

Definition at line 23 of file samplerplacement.cc.

References clear(), and PublishMembers().

Here is the call graph for this function:

Member Function Documentation

◆ clear()

void SamplerPlacement::clear ( )

reset

Definition at line 29 of file samplerplacement.cc.

References angle, axisAngle, axisX, axisY, axisZ, name, partID, partIDSetID, phi, psi, referenceElement, referenceElementNumber, s, samplerType, theta, x, y, and z.

Referenced by SamplerPlacement().

Here is the caller graph for this function:

◆ print()

void SamplerPlacement::print ( ) const

print some properties

Definition at line 94 of file samplerplacement.cc.

References angle, axisAngle, axisX, axisY, axisZ, name, partID, partIDSetID, phi, psi, referenceElement, referenceElementNumber, s, samplerType, theta, x, y, and z.

◆ PublishMembers()

void SamplerPlacement::PublishMembers ( )

private

publish members

Definition at line 61 of file samplerplacement.cc.

References angle, axisAngle, axisX, axisY, axisZ, name, partID, phi, psi, GMAD::Published< SamplerPlacement >::publish(), referenceElement, referenceElementNumber, s, samplerType, theta, x, y, and z.

Referenced by SamplerPlacement().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ set_value()

template<typename T >

void GMAD::SamplerPlacement::set_value	(	std::string	property,
		T	value
	)

set methods by property name and value

Definition at line 93 of file samplerplacement.h.

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

Here is the call graph for this function:

Field Documentation

◆ angle

double GMAD::SamplerPlacement::angle

Axis angle rotation.

Definition at line 56 of file samplerplacement.h.

Referenced by clear(), GMAD::Placement::Placement(), print(), and PublishMembers().

◆ aper1

double GMAD::SamplerPlacement::aper1

Definition at line 62 of file samplerplacement.h.

◆ aper2

double GMAD::SamplerPlacement::aper2

Definition at line 63 of file samplerplacement.h.

◆ aper3

double GMAD::SamplerPlacement::aper3

Definition at line 64 of file samplerplacement.h.

◆ aper4

double GMAD::SamplerPlacement::aper4

Definition at line 65 of file samplerplacement.h.

◆ apertureModel

std::string GMAD::SamplerPlacement::apertureModel

Definition at line 60 of file samplerplacement.h.

◆ axisAngle

bool GMAD::SamplerPlacement::axisAngle

Flag to use the axis angle construction of rotation.

Definition at line 58 of file samplerplacement.h.

Referenced by clear(), GMAD::Placement::Placement(), print(), and PublishMembers().

◆ axisX

double GMAD::SamplerPlacement::axisX

Axis angle rotation.

Definition at line 53 of file samplerplacement.h.

Referenced by clear(), GMAD::Placement::Placement(), print(), and PublishMembers().

◆ axisY

double GMAD::SamplerPlacement::axisY

Axis angle rotation.

Definition at line 54 of file samplerplacement.h.

Referenced by clear(), GMAD::Placement::Placement(), print(), and PublishMembers().

◆ axisZ

double GMAD::SamplerPlacement::axisZ

Axis angle rotation.

Definition at line 55 of file samplerplacement.h.

Referenced by clear(), GMAD::Placement::Placement(), print(), and PublishMembers().

◆ name

std::string GMAD::SamplerPlacement::name

Name of this samplerplacement.

Definition at line 39 of file samplerplacement.h.

Referenced by BDSParallelWorldSampler::BuildSampler(), BDSDetectorConstruction::CalculateExtentOfSamplerPlacement(), clear(), GMAD::Placement::Placement(), print(), and PublishMembers().

◆ partID

std::list<double> GMAD::SamplerPlacement::partID

List of PDG IDs of which particles to record for - default is empty, so all particles.

Definition at line 74 of file samplerplacement.h.

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

◆ partIDSetID

int GMAD::SamplerPlacement::partIDSetID

The unique ID of the particle set given by the parser.

Definition at line 75 of file samplerplacement.h.

Referenced by BDSParallelWorldSampler::BuildSampler(), clear(), and print().

◆ phi

double GMAD::SamplerPlacement::phi

Euler angle for rotation.

Definition at line 48 of file samplerplacement.h.

Referenced by clear(), GMAD::Placement::Placement(), print(), and PublishMembers().

◆ psi

double GMAD::SamplerPlacement::psi

Euler angle for rotation.

Definition at line 50 of file samplerplacement.h.

Referenced by clear(), GMAD::Placement::Placement(), print(), and PublishMembers().

◆ referenceElement

std::string GMAD::SamplerPlacement::referenceElement

Name of reference element w.r.t. to place to.

Definition at line 41 of file samplerplacement.h.

Referenced by clear(), GMAD::Placement::Placement(), print(), and PublishMembers().

◆ referenceElementNumber

int GMAD::SamplerPlacement::referenceElementNumber

Index of repetition of element if there are multiple uses.

Definition at line 42 of file samplerplacement.h.

Referenced by clear(), GMAD::Placement::Placement(), print(), and PublishMembers().

◆ s

double GMAD::SamplerPlacement::s

Curvilinear s position to place w.r.t..

Definition at line 43 of file samplerplacement.h.

Referenced by clear(), GMAD::Placement::Placement(), print(), and PublishMembers().

◆ samplerType

std::string GMAD::SamplerPlacement::samplerType

Plane, Cylinder, Sphere.

Definition at line 40 of file samplerplacement.h.

Referenced by BDSDetectorConstruction::CalculateExtentOfSamplerPlacement(), clear(), print(), and PublishMembers().

◆ shape

std::string GMAD::SamplerPlacement::shape

Definition at line 61 of file samplerplacement.h.

◆ startAnglePhi

double GMAD::SamplerPlacement::startAnglePhi

Definition at line 67 of file samplerplacement.h.

◆ startAngleTheta

double GMAD::SamplerPlacement::startAngleTheta

Definition at line 69 of file samplerplacement.h.

◆ sweepAnglePhi

double GMAD::SamplerPlacement::sweepAnglePhi

Definition at line 68 of file samplerplacement.h.

◆ sweepAngleTheta

double GMAD::SamplerPlacement::sweepAngleTheta

Definition at line 70 of file samplerplacement.h.

◆ theta

double GMAD::SamplerPlacement::theta

Euler angle for rotation.

Definition at line 49 of file samplerplacement.h.

Referenced by clear(), GMAD::Placement::Placement(), print(), and PublishMembers().

◆ x

double GMAD::SamplerPlacement::x

Offset in x.

Definition at line 44 of file samplerplacement.h.

Referenced by clear(), GMAD::Placement::Placement(), print(), and PublishMembers().

◆ y

double GMAD::SamplerPlacement::y

Offset in y.

Definition at line 45 of file samplerplacement.h.

Referenced by clear(), GMAD::Placement::Placement(), print(), and PublishMembers().

◆ z

double GMAD::SamplerPlacement::z

Offset in z.

Definition at line 46 of file samplerplacement.h.

Referenced by clear(), GMAD::Placement::Placement(), print(), and PublishMembers().

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

/Users/lnevay/physics/reps/bdsim/parser/samplerplacement.h
/Users/lnevay/physics/reps/bdsim/parser/samplerplacement.cc

Public Member Functions

Data Fields

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SamplerPlacement()

Member Function Documentation

◆ clear()

◆ print()

◆ PublishMembers()

◆ set_value()

Field Documentation

◆ angle

◆ aper1

◆ aper2

◆ aper3

◆ aper4

◆ apertureModel

◆ axisAngle

◆ axisX

◆ axisY

◆ axisZ

◆ name

◆ partID

◆ partIDSetID

◆ phi

◆ psi

◆ referenceElement

◆ referenceElementNumber

◆ s

◆ samplerType

◆ shape

◆ startAnglePhi

◆ startAngleTheta

◆ sweepAnglePhi

◆ sweepAngleTheta

◆ theta

◆ x

◆ y

◆ z