#include <ProbeRep.h>

Inheritance diagram for ProbeRep:

[legend]

Collaboration diagram for ProbeRep:

[legend]

Public Member Functions
	ProbeRep (const std::string &name)
	Constructor with given name. More...

	ProbeRep ()

	ProbeRep (const ProbeRep &)

virtual	~ProbeRep ()

virtual ElementBase *	clone () const
	Return clone. More...

virtual Channel *	getChannel (const std::string &aKey, bool=false)
	Construct a read/write channel. More...

virtual NullField &	getField ()
	Get field. More...

virtual const NullField &	getField () const
	Get field. More...

virtual StraightGeometry &	getGeometry ()
	Get geometry. More...

virtual const StraightGeometry &	getGeometry () const
	Get geometry. More...

virtual void	setActive (bool=true)
	Set active flag. More...

Public Member Functions inherited from Probe
	Probe (const std::string &name)
	Constructor with given name. More...

	Probe ()

	Probe (const Probe &)

void	operator= (const Probe &)=delete

virtual	~Probe ()

virtual void	accept (BeamlineVisitor &) const override
	Apply visitor to Probe. More...

void	setStep (double step)
	Set probe histogram bin width. More...

virtual ElementBase::ElementType	getType () const override
	Get element type std::string. More...

virtual double	getStep () const
	Member variable access. More...

Public Member Functions inherited from PluginElement
	PluginElement (const std::string &name)
	Constructor with given name. More...

	PluginElement ()

	PluginElement (const PluginElement &)

void	operator= (const PluginElement &)=delete

virtual	~PluginElement ()

void	setDimensions (double xstart, double xend, double ystart, double yend)
	Set dimensions and consistency checks. More...

bool	check (PartBunchBase< double, 3 > *bunch, const int turnnumber, const double t, const double tstep)

int	checkPoint (const double &x, const double &y) const
	Checks if coordinate is within element. More...

void	save ()
	Save output. More...

virtual void	initialise (PartBunchBase< double, 3 > *bunch, double &startField, double &endField) override
	Pure virtual implementation of Component. More...

void	initialise (PartBunchBase< double, 3 > *bunch)

virtual void	finalise () final

virtual void	goOffline () final

virtual bool	bends () const override

virtual void	getDimensions (double &zBegin, double &zEnd) const override

virtual bool	apply (const size_t &i, const double &t, Vector_t &E, Vector_t &B) override

virtual bool	applyToReferenceParticle (const Vector_t &R, const Vector_t &P, const double &t, Vector_t &E, Vector_t &B) override

double	getXStart () const
	Member variable access. More...

double	getXEnd () const

double	getYStart () const

double	getYEnd () const

Public Member Functions inherited from Component
	Component (const std::string &name)
	Constructor with given name. More...

	Component ()

	Component (const Component &right)

virtual	~Component ()

EVector	Efield (const Point3D &P) const
	Return the field in a point. More...

BVector	Bfield (const Point3D &P) const
	Return the field in a point. More...

EVector	Efield (const Point3D &P, double t) const
	Return the field in a point. More...

BVector	Bfield (const Point3D &P, double t) const
	Return the field in a point. More...

EBVectors	EBfield (const Point3D &P) const
	Return the field in a point. More...

EBVectors	EBfield (const Point3D &P, double t) const
	Return the field in a point. More...

virtual bool	apply (const Vector_t &R, const Vector_t &P, const double &t, Vector_t &E, Vector_t &B)

virtual bool	getPotential (const Vector_t &, const double &, Vector_t &, double &)

virtual double	getDesignEnergy () const

virtual void	setDesignEnergy (const double &energy, bool changeable=true)

virtual void	goOnline (const double &kineticEnergy)

virtual bool	Online ()

virtual void	setComponentType (std::string)

virtual std::string	getComponentType () const

virtual const ElementBase &	getDesign () const
	Return design element. More...

virtual void	trackBunch (PartBunchBase< double, 3 > *bunch, const PartData &, bool revBeam, bool revTrack) const
	Track particle bunch. More...

virtual void	trackMap (FVps< double, 6 > &map, const PartData &, bool revBeam, bool revTrack) const
	Track a map. More...

void	setExitFaceSlope (const double &)

Public Member Functions inherited from ElementBase
	ElementBase (const std::string &name)
	Constructor with given name. More...

	ElementBase ()

	ElementBase (const ElementBase &)

virtual	~ElementBase ()

virtual const std::string &	getName () const
	Get element name. More...

virtual void	setName (const std::string &name)
	Set element name. More...

std::string	getTypeString () const

virtual double	getArcLength () const
	Get arc length. More...

virtual double	getElementLength () const
	Get design length. More...

virtual void	setElementLength (double length)
	Set design length. More...

virtual void	getElementDimensions (double &begin, double &end) const

virtual double	getOrigin () const
	Get origin position. More...

virtual double	getEntrance () const
	Get entrance position. More...

virtual double	getExit () const
	Get exit position. More...

virtual Euclid3D	getTransform (double fromS, double toS) const
	Get transform. More...

virtual Euclid3D	getTransform (double s) const
	Get transform. More...

virtual Euclid3D	getTotalTransform () const
	Get transform. More...

virtual Euclid3D	getEntranceFrame () const
	Get transform. More...

virtual Euclid3D	getExitFrame () const
	Get transform. More...

virtual Euclid3D	getEntrancePatch () const
	Get patch. More...

virtual Euclid3D	getExitPatch () const
	Get patch. More...

virtual double	getAttribute (const std::string &aKey) const
	Get attribute value. More...

virtual bool	hasAttribute (const std::string &aKey) const
	Test for existence of an attribute. More...

virtual void	removeAttribute (const std::string &aKey)
	Remove an existing attribute. More...

virtual void	setAttribute (const std::string &aKey, double val)
	Set value of an attribute. More...

virtual const ConstChannel *	getConstChannel (const std::string &aKey) const
	Construct a read-only channel. More...

virtual ElementBase *	copyStructure ()
	Make a structural copy. More...

bool	isSharable () const
	Test if the element can be shared. More...

virtual void	makeSharable ()
	Set sharable flag. More...

bool	update (const AttributeSet &)
	Update element. More...

virtual void	setBoundaryGeometry (BoundaryGeometry *geo)

virtual BoundaryGeometry *	getBoundaryGeometry () const
	return the attached boundary geometrt object if there is any More...

virtual bool	hasBoundaryGeometry () const

virtual void	setWake (WakeFunction *wf)
	attach a wake field to the element More...

virtual WakeFunction *	getWake () const
	return the attached wake object if there is any More...

virtual bool	hasWake () const

virtual void	setParticleMatterInteraction (ParticleMatterInteractionHandler *spys)

virtual ParticleMatterInteractionHandler *	getParticleMatterInteraction () const

virtual bool	hasParticleMatterInteraction () const

void	setCSTrafoGlobal2Local (const CoordinateSystemTrafo &ori)

CoordinateSystemTrafo	getCSTrafoGlobal2Local () const

void	releasePosition ()

void	fixPosition ()

bool	isPositioned () const

virtual CoordinateSystemTrafo	getEdgeToBegin () const

virtual CoordinateSystemTrafo	getEdgeToEnd () const

void	setAperture (const ApertureType &type, const std::vector< double > &args)

std::pair< ElementBase::ApertureType, std::vector< double > >	getAperture () const

virtual bool	isInside (const Vector_t &r) const

void	setMisalignment (const CoordinateSystemTrafo &cst)

void	getMisalignment (double &x, double &y, double &s) const

CoordinateSystemTrafo	getMisalignment () const

void	setActionRange (const std::queue< std::pair< double, double > > &range)

void	setCurrentSCoordinate (double s)

void	setRotationAboutZ (double rotation)
	Set rotation about z axis in bend frame. More...

double	getRotationAboutZ () const

virtual BoundingBox	getBoundingBoxInLabCoords () const

virtual int	getRequiredNumberOfTimeSteps () const

void	setOutputFN (std::string fn)
	Set output filename. More...

std::string	getOutputFN () const
	Get output filename. More...

void	setElementPosition (double elemedge)
	Access to ELEMEDGE attribute. More...

double	getElementPosition () const

bool	isElementPositionSet () const

Public Member Functions inherited from RCObject
int	addReference () const
	Increment reference count. More...

int	removeReference () const
	Decrement the reference count. More...

bool	isShared () const
	Test for sharing. More...

Protected Attributes
NullField	field
	The zero magnetic field. More...

StraightGeometry	geometry
	The probe's geometry. More...

bool	active
	The active/inactive flag. More...

Protected Attributes inherited from PluginElement
double	rmin_m
	radius closest to the origin More...

Point	geom_m [5]
	actual geometry positions with adaptive width such that each particle hits element once per turn More...

double	A_m

double	B_m

double	R_m

double	C_m
	Geometric lengths used in calculations. More...

std::unique_ptr< LossDataSink >	lossDs_m
	Pointer to Loss instance. More...

int	numPassages_m = 0
	Number of turns (number of times save() method is called) More...

double	xstart_m
	input geometry positions More...

double	xend_m

double	ystart_m

double	yend_m

double	rstart_m

double	rend_m

Protected Attributes inherited from Component
double	exit_face_slope_m

PartBunchBase< double, 3 > *	RefPartBunch_m

bool	online_m

Protected Attributes inherited from ElementBase
bool	shareFlag

CoordinateSystemTrafo	csTrafoGlobal2Local_m

CoordinateSystemTrafo	misalignment_m

std::pair< ApertureType, std::vector< double > >	aperture_m

double	elementEdge_m

double	rotationZAxis_m

Private Member Functions
void	operator= (const ProbeRep &)

Additional Inherited Members
Public Types inherited from ElementBase
enum	ApertureType { RECTANGULAR , ELLIPTICAL , CONIC_RECTANGULAR , CONIC_ELLIPTICAL }

enum	ElementType { BEAMLINE , CCOLLIMATOR , CORRECTOR , CYCLOTRON , DEGRADER , DRIFT , FLEXIBLECOLLIMATOR , MARKER , MONITOR , MPSPLITINTEGRATOR , MULTIPOLE , MULTIPOLET , OFFSET , PROBE , RBEND , RBEND3D , RFCAVITY , RING , SBEND3D , SBEND , SEPTUM , SOLENOID , SOURCE , STRIPPER , TRAVELINGWAVE , UNDULATOR , VACUUM , VARIABLERFCAVITY , ANY }

Static Public Member Functions inherited from ElementBase
static std::string	getTypeString (ElementType type)

Protected Member Functions inherited from PluginElement
void	setGeom (const double dist)
	Sets geometry geom_m with element width dist. More...

void	changeWidth (PartBunchBase< double, 3 > *bunch, int i, const double tstep, const double tangle)
	Change probe width depending on step size and angle of particle. More...

double	calculateIncidentAngle (double xp, double yp) const
	Calculate angle of particle/bunch wrt to element. More...

Protected Member Functions inherited from ElementBase
bool	isInsideTransverse (const Vector_t &r) const

Protected Member Functions inherited from RCObject
	RCObject ()
	Default constructor. More...

	RCObject (const RCObject &)
	Copy constructor. More...

virtual	~RCObject ()=0

RCObject &	operator= (const RCObject &right)

Static Protected Attributes inherited from Component
static const std::vector< double >	defaultAperture_m

Detailed Description

Definition at line 25 of file ProbeRep.h.

Constructor & Destructor Documentation

◆ ProbeRep() [1/3]

ProbeRep::ProbeRep ( const std::string & name )

explicit

Constructor with given name.

Definition at line 50 of file ProbeRep.cpp.

◆ ProbeRep() [2/3]

ProbeRep::ProbeRep ( )

Definition at line 40 of file ProbeRep.cpp.

Referenced by clone().

◆ ProbeRep() [3/3]

ProbeRep::ProbeRep ( const ProbeRep & right )

Definition at line 45 of file ProbeRep.cpp.

◆ ~ProbeRep()

ProbeRep::~ProbeRep ( )

virtual

Definition at line 55 of file ProbeRep.cpp.

Member Function Documentation

◆ clone()

ElementBase * ProbeRep::clone ( ) const

virtual

Return clone.

Implements ElementBase.

Definition at line 59 of file ProbeRep.cpp.

References ProbeRep().

Here is the call graph for this function:

◆ getChannel()

Channel * ProbeRep::getChannel	(	const std::string &	aKey,
		bool	create = `false`
	)

virtual

Construct a read/write channel.

Reimplemented from ElementBase.

Definition at line 64 of file ProbeRep.cpp.

References ElementBase::getChannel().

Here is the call graph for this function:

◆ getField() [1/2]

NullField & ProbeRep::getField ( )

virtual

Get field.

Implements Component.

Definition at line 74 of file ProbeRep.cpp.

References field.

◆ getField() [2/2]

const NullField & ProbeRep::getField ( ) const

virtual

Get field.

Implements Component.

Definition at line 78 of file ProbeRep.cpp.

References field.

◆ getGeometry() [1/2]

StraightGeometry & ProbeRep::getGeometry ( )

virtual

Get geometry.

Implements ElementBase.

Definition at line 82 of file ProbeRep.cpp.

References geometry.

◆ getGeometry() [2/2]

const StraightGeometry & ProbeRep::getGeometry ( ) const

virtual

Get geometry.

Implements ElementBase.

Definition at line 86 of file ProbeRep.cpp.

References geometry.

◆ operator=()

void ProbeRep::operator= ( const ProbeRep & )

private

◆ setActive()

void ProbeRep::setActive ( bool flag = true )

virtual

Set active flag.

Definition at line 91 of file ProbeRep.cpp.

References active.

Member Data Documentation

◆ active

bool ProbeRep::active

protected

The active/inactive flag.

Definition at line 79 of file ProbeRep.h.

Referenced by setActive().

◆ field

NullField ProbeRep::field

protected

The zero magnetic field.

Definition at line 73 of file ProbeRep.h.

Referenced by getField().

◆ geometry

StraightGeometry ProbeRep::geometry

protected

The probe's geometry.

Definition at line 76 of file ProbeRep.h.

Referenced by getGeometry().

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

/Users/gsell/src/OPAL/src/src/Classic/BeamlineCore/ProbeRep.h
/Users/gsell/src/OPAL/src/src/Classic/BeamlineCore/ProbeRep.cpp

Public Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ProbeRep() [1/3]

◆ ProbeRep() [2/3]

◆ ProbeRep() [3/3]

◆ ~ProbeRep()

Member Function Documentation

◆ clone()

◆ getChannel()

◆ getField() [1/2]

◆ getField() [2/2]

◆ getGeometry() [1/2]

◆ getGeometry() [2/2]

◆ operator=()

◆ setActive()

Member Data Documentation

◆ active

◆ field

◆ geometry