OPAL (Object Oriented Parallel Accelerator Library) 2022.1
OPAL
Public Member Functions | Protected Attributes | Private Member Functions | List of all members
MonitorRep Class Reference

#include <MonitorRep.h>

Inheritance diagram for MonitorRep:
Inheritance graph
[legend]
Collaboration diagram for MonitorRep:
Collaboration graph
[legend]

Public Member Functions

 MonitorRep (const std::string &name)
 Constructor with given name. More...
 
 MonitorRep ()
 
 MonitorRep (const MonitorRep &)
 
virtual ~MonitorRep ()
 
virtual ElementBaseclone () const
 Return clone. More...
 
virtual ChannelgetChannel (const std::string &aKey, bool=false)
 Construct a read/write channel. More...
 
virtual NullFieldgetField ()
 Get field. More...
 
virtual const NullFieldgetField () const
 Get field. More...
 
virtual StraightGeometrygetGeometry ()
 Get geometry. More...
 
virtual const StraightGeometrygetGeometry () const
 Get geometry. 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 StraightGeometrygetGeometry () override=0
 Get geometry. More...
 
virtual const StraightGeometrygetGeometry () const override=0
 Get geometry. Version for const object. More...
 
virtual Plane getPlane () const =0
 Get plane on which monitor observes. 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 ElementType getType () const override
 Get element type std::string. More...
 
virtual void getDimensions (double &zBegin, double &zEnd) const override
 
void setCollectionType (CollectionType type)
 
virtual int getRequiredNumberOfTimeSteps () const override
 
virtual bool isInside (const Vector_t &r) const override
 
- Public Member Functions inherited from Component
 Component (const std::string &name)
 Constructor with given name. More...
 
 Component ()
 
 Component (const Component &right)
 
virtual ~Component ()
 
virtual EMFieldgetField ()=0
 Return field. More...
 
virtual const EMFieldgetField () const =0
 Return field. More...
 
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 size_t &i, const double &t, Vector_t &E, Vector_t &B)
 
virtual bool apply (const Vector_t &R, const Vector_t &P, const double &t, Vector_t &E, Vector_t &B)
 
virtual bool applyToReferenceParticle (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 initialise (PartBunchBase< double, 3 > *bunch, double &startField, double &endField)=0
 
virtual void finalise ()=0
 
virtual bool bends () const =0
 
virtual void goOnline (const double &kineticEnergy)
 
virtual void goOffline ()
 
virtual bool Online ()
 
virtual void getDimensions (double &zBegin, double &zEnd) const =0
 
virtual ElementType getType () const
 Get element type std::string. More...
 
virtual const ElementBasegetDesign () 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...
 
virtual ElementType getType () const =0
 Get element type std::string. More...
 
std::string getTypeString () const
 
virtual BGeometryBasegetGeometry ()=0
 Get geometry. More...
 
virtual const BGeometryBasegetGeometry () const =0
 Get geometry. More...
 
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 ChannelgetChannel (const std::string &aKey, bool create=false)
 Construct a read/write channel. More...
 
virtual const ConstChannelgetConstChannel (const std::string &aKey) const
 Construct a read-only channel. More...
 
virtual void accept (BeamlineVisitor &visitor) const =0
 Apply visitor. More...
 
virtual ElementBaseclone () const =0
 Return clone. More...
 
virtual ElementBasecopyStructure ()
 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 BoundaryGeometrygetBoundaryGeometry () 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 WakeFunctiongetWake () const
 return the attached wake object if there is any More...
 
virtual bool hasWake () const
 
virtual void setParticleMatterInteraction (ParticleMatterInteractionHandler *spys)
 
virtual ParticleMatterInteractionHandlergetParticleMatterInteraction () 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< 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 setFlagDeleteOnTransverseExit (bool=true)
 
bool getFlagDeleteOnTransverseExit () 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...
 
- 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) const
 
- Protected Member Functions inherited from RCObject
 RCObject ()
 Default constructor. More...
 
 RCObject (const RCObject &)
 Copy constructor. More...
 
virtual ~RCObject ()=0
 
RCObjectoperator= (const RCObject &right)
 
- Static Protected Attributes inherited from Component
static const std::vector< double > defaultAperture_m
 

Detailed Description

Definition at line 26 of file MonitorRep.h.

Constructor & Destructor Documentation

◆ MonitorRep() [1/3]

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

Constructor with given name.

Definition at line 50 of file MonitorRep.cpp.

◆ MonitorRep() [2/3]

MonitorRep::MonitorRep ( )

Definition at line 40 of file MonitorRep.cpp.

Referenced by clone().

◆ MonitorRep() [3/3]

MonitorRep::MonitorRep ( const MonitorRep right)

Definition at line 45 of file MonitorRep.cpp.

◆ ~MonitorRep()

MonitorRep::~MonitorRep ( )
virtual

Definition at line 55 of file MonitorRep.cpp.

Member Function Documentation

◆ clone()

ElementBase * MonitorRep::clone ( ) const
virtual

Return clone.

Implements ElementBase.

Definition at line 59 of file MonitorRep.cpp.

References MonitorRep().

Here is the call graph for this function:

◆ getChannel()

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

Construct a read/write channel.

Reimplemented from ElementBase.

Definition at line 64 of file MonitorRep.cpp.

References ElementBase::getChannel().

Here is the call graph for this function:

◆ getField() [1/2]

NullField & MonitorRep::getField ( )
virtual

Get field.

Implements Component.

Definition at line 75 of file MonitorRep.cpp.

References field.

◆ getField() [2/2]

const NullField & MonitorRep::getField ( ) const
virtual

Get field.

Implements Component.

Definition at line 79 of file MonitorRep.cpp.

References field.

◆ getGeometry() [1/2]

StraightGeometry & MonitorRep::getGeometry ( )
virtual

Get geometry.

Implements Monitor.

Definition at line 84 of file MonitorRep.cpp.

References geometry.

◆ getGeometry() [2/2]

const StraightGeometry & MonitorRep::getGeometry ( ) const
virtual

Get geometry.

Implements Monitor.

Definition at line 88 of file MonitorRep.cpp.

References geometry.

◆ getPlane()

Monitor::Plane MonitorRep::getPlane ( ) const
virtual

Get planes.

Implements Monitor.

Definition at line 93 of file MonitorRep.cpp.

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

◆ operator=()

void MonitorRep::operator= ( const MonitorRep )
private

◆ setActive()

void MonitorRep::setActive ( bool  flag = true)
virtual

Set active flag.

Definition at line 98 of file MonitorRep.cpp.

References active.

Member Data Documentation

◆ active

bool MonitorRep::active
protected

The active/inactive flag.

Definition at line 83 of file MonitorRep.h.

Referenced by getPlane(), and setActive().

◆ field

NullField MonitorRep::field
protected

The zero magnetic field.

Definition at line 77 of file MonitorRep.h.

Referenced by getField().

◆ geometry

StraightGeometry MonitorRep::geometry
protected

The monitor geometry.

Definition at line 80 of file MonitorRep.h.

Referenced by getGeometry().


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