MonitorRep Class Reference

Representation for an orbit position monitor. More...

#include <MonitorRep.h>

Inheritance diagram for MonitorRep:

Collaboration diagram for MonitorRep:

Public Member Functions
	MonitorRep (const std::string &name)
	Constructor with given name. More...
	MonitorRep ()
	MonitorRep (const MonitorRep &)
virtual	~MonitorRep ()
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 ElementImage *	getImage () const
	Construct an image. More...
virtual Plane	getPlane () const
	Get planes. More...
virtual void	setActive (bool=true)
	Set active flag. More...
Public Member Functions inherited from Monitor
	Monitor (const std::string &name)
	Constructor with given name. More...
	Monitor ()
	Monitor (const Monitor &)
virtual	~Monitor ()
virtual void	accept (BeamlineVisitor &) const override
	Apply visitor to Monitor. More...
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
virtual void	initialise (PartBunchBase< double, 3 > *bunch, double &startField, double &endField) override
virtual void	finalise () override
virtual bool	bends () const override
virtual void	goOnline (const double &kineticEnergy) override
virtual void	goOffline () override
virtual ElementBase::ElementType	getType () const override
	Get element type std::string. More...
virtual void	getDimensions (double &zBegin, double &zEnd) const override
void	setOutputFN (std::string fn)
void	setType (Type type)
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 void	addKR (int i, double t, Vector_t &K)
virtual void	addKT (int i, double t, Vector_t &K)
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 &R, const double &t, Vector_t &A, double &phi)
virtual double	getDesignEnergy () const
virtual void	setDesignEnergy (const double &energy, bool changeable)
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...
virtual ElementBase *	makeAlignWrapper ()
	Allow misalignment. More...
virtual ElementBase *	makeFieldWrapper ()
	Allow field errors. More...
virtual ElementBase *	makeWrappers ()
	Allow errors. More...
virtual ElementBase *	removeAlignWrapper ()
	Remove align wrapper. More...
virtual const ElementBase *	removeAlignWrapper () const
	Remove align wrapper. More...
virtual ElementBase *	removeFieldWrapper ()
	Remove field wrapper. More...
virtual const ElementBase *	removeFieldWrapper () const
	Remove field wrapper. More...
virtual ElementBase *	removeWrappers ()
	Return the design element. More...
virtual const ElementBase *	removeWrappers () const
	Return the design element. 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
ElemType	getElType () const
	returns element type as enumeration needed in the envelope tracker More...
void	setElType (ElemType elt)
	set the element type as enumeration needed in the envelope tracker More...
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 (double x, double y, double s)
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
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 monitor geometry. More...
bool	active
	The active/inactive flag. More...
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 MonitorRep &)

Additional Inherited Members
Public Types inherited from Monitor
enum	Plane { OFF, X, Y, XY }
	Plane selection. More...
enum	Type { TEMPORAL, SPATIAL }
Public Types inherited from ElementBase
enum	ApertureType { RECTANGULAR, ELLIPTICAL, CONIC_RECTANGULAR, CONIC_ELLIPTICAL }
enum	ElementType {   ALIGNWRAPPER, BEAMBEAM, BEAMBEAM3D, BEAMLINE,   BEAMSTRIPPING, CCOLLIMATOR, CORRECTOR, CORRECTORWRAPPER,   CYCLOTRON, CYCLOTRONWRAPPER, CYCLOTRONVALLEY, DEGRADER,   DIAGNOSTIC, DRIFT, FLEXIBLECOLLIMATOR, INTEGRATOR,   LAMBERTSON, MARKER, MONITOR, MPSPLITINTEGRATOR,   MULTIPOLE, MULTIPOLET, MULTIPOLEWRAPPER, OFFSET,   PARALLELPLATE, PATCH, PROBE, RBEND,   RBEND3D, RBENDWRAPPER, RFCAVITY, RFQUADRUPOLE,   RING, SBEND3D, SBEND, SBENDWRAPPER,   SEPARATOR, SEPTUM, SOLENOID, SOURCE,   STRIPPER, TRAVELINGWAVE, VARIABLERFCAVITY, ANY }
Static Public Member Functions inherited from Monitor
static void	writeStatistics ()
Static Public Member Functions inherited from ElementBase
static std::string	getTypeString (ElementType type)
Protected Member Functions inherited from ElementBase
bool	isInsideTransverse (const Vector_t &r, double f=1) 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

Representation for an orbit position monitor.

Definition at line 32 of file MonitorRep.h.

Constructor & Destructor Documentation

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

explicit

Constructor with given name.

Definition at line 61 of file MonitorRep.cpp.

MonitorRep::MonitorRep

(

)

Definition at line 51 of file MonitorRep.cpp.

Referenced by clone().

MonitorRep::MonitorRep

(

const MonitorRep &

right

)

Definition at line 56 of file MonitorRep.cpp.

MonitorRep::~MonitorRep ( )

virtual

Definition at line 66 of file MonitorRep.cpp.

Member Function Documentation

ElementBase * MonitorRep::clone ( ) const

virtual

Return clone.

Implements ElementBase.

Reimplemented in XMonitorRep, and YMonitorRep.

Definition at line 70 of file MonitorRep.cpp.

References MonitorRep().

Here is the call graph for this function:

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

virtual

Construct a read/write channel.

Reimplemented from ElementBase.

Reimplemented in XMonitorRep, and YMonitorRep.

Definition at line 75 of file MonitorRep.cpp.

References ElementBase::getChannel().

Here is the call graph for this function:

NullField & MonitorRep::getField ( )

virtual

Get field.

Implements Component.

Definition at line 86 of file MonitorRep.cpp.

References field.

const NullField & MonitorRep::getField ( ) const

virtual

Get field.

Implements Component.

Definition at line 90 of file MonitorRep.cpp.

References field.

StraightGeometry & MonitorRep::getGeometry ( )

virtual

Get geometry.

Implements Monitor.

Definition at line 95 of file MonitorRep.cpp.

References geometry.

const StraightGeometry & MonitorRep::getGeometry ( ) const

virtual

Get geometry.

Implements Monitor.

Definition at line 99 of file MonitorRep.cpp.

References geometry.

ElementImage * MonitorRep::getImage ( ) const

virtual

Construct an image.

Reimplemented from ElementBase.

Reimplemented in XMonitorRep, and YMonitorRep.

Definition at line 104 of file MonitorRep.cpp.

References ElementBase::getImage(), and AttributeSet::setAttribute().

Here is the call graph for this function:

Monitor::Plane MonitorRep::getPlane ( ) const

virtual

Get planes.

Implements Monitor.

Reimplemented in XMonitorRep, and YMonitorRep.

Definition at line 115 of file MonitorRep.cpp.

References active, Monitor::OFF, and Monitor::XY.

void MonitorRep::operator= ( const MonitorRep &  )

private

void MonitorRep::setActive ( bool  flag = true )

virtual

Set active flag.

Definition at line 120 of file MonitorRep.cpp.

References active.

Member Data Documentation

bool MonitorRep::active

protected

The active/inactive flag.

Definition at line 94 of file MonitorRep.h.

Referenced by XMonitorRep::getPlane(), YMonitorRep::getPlane(), getPlane(), and setActive().

NullField MonitorRep::field

protected

The zero magnetic field.

Definition at line 88 of file MonitorRep.h.

Referenced by getField().

StraightGeometry MonitorRep::geometry

protected

The monitor geometry.

Definition at line 91 of file MonitorRep.h.

Referenced by getGeometry().

---

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

• src/Classic/BeamlineCore/MonitorRep.h
• src/Classic/BeamlineCore/MonitorRep.cpp