OPAL (Object Oriented Parallel Accelerator Library) 2024.2
OPAL
ClassicField Class Reference

#include <ClassicField.h>

Collaboration diagram for ClassicField:

Public Member Functions

 ClassicField (std::shared_ptr< Component >, const double &, const double &)
 ~ClassicField ()
std::shared_ptr< Component > getElement ()
std::shared_ptr< const Component > getElement () const
double getLength () const
const double & getStart () const
const double & getEnd () const
void setStart (const double &z)
void setEnd (const double &z)
const bool & isOn () const
void setOn (const double &kinematicEnergy)
void setOff ()
BoundingBox getBoundingBoxInLabCoords () const

Static Public Member Functions

static bool SortAsc (const ClassicField &fle1, const ClassicField &fle2)
static bool ZeroLength (const ClassicField &fle)

Public Attributes

unsigned int order_m

Private Attributes

std::shared_ptr< Component > element_m
double start_m
double end_m
bool is_on_m

Detailed Description

Definition at line 9 of file ClassicField.h.

Constructor & Destructor Documentation

◆ ClassicField()

ClassicField::ClassicField ( std::shared_ptr< Component > element,
const double & start,
const double & end )

Definition at line 5 of file ClassicField.cpp.

References element_m, end(), end_m, is_on_m, and start_m.

Referenced by SortAsc(), and ZeroLength().

Here is the call graph for this function:

◆ ~ClassicField()

ClassicField::~ClassicField ( )

Definition at line 12 of file ClassicField.cpp.

References element_m.

Member Function Documentation

◆ getBoundingBoxInLabCoords()

BoundingBox ClassicField::getBoundingBoxInLabCoords ( ) const
inline

Definition at line 78 of file ClassicField.h.

References element_m.

◆ getElement() [1/2]

std::shared_ptr< Component > ClassicField::getElement ( )
inline

Definition at line 45 of file ClassicField.h.

References element_m.

◆ getElement() [2/2]

std::shared_ptr< const Component > ClassicField::getElement ( ) const
inline

Definition at line 49 of file ClassicField.h.

References element_m.

◆ getEnd()

const double & ClassicField::getEnd ( ) const
inline

Definition at line 61 of file ClassicField.h.

References end_m.

◆ getLength()

double ClassicField::getLength ( ) const
inline

Definition at line 53 of file ClassicField.h.

References end_m, and start_m.

Referenced by ZeroLength().

◆ getStart()

const double & ClassicField::getStart ( ) const
inline

Definition at line 57 of file ClassicField.h.

References start_m.

◆ isOn()

const bool & ClassicField::isOn ( ) const
inline

Definition at line 65 of file ClassicField.h.

References is_on_m.

◆ setEnd()

void ClassicField::setEnd ( const double & z)
inline

Definition at line 73 of file ClassicField.h.

References end_m.

◆ setOff()

void ClassicField::setOff ( )

Definition at line 24 of file ClassicField.cpp.

References element_m, endl(), INFOMSG, is_on_m, and level3().

Here is the call graph for this function:

◆ setOn()

void ClassicField::setOn ( const double & kinematicEnergy)

Definition at line 16 of file ClassicField.cpp.

References element_m, endl(), INFOMSG, is_on_m, and level3().

Here is the call graph for this function:

◆ setStart()

void ClassicField::setStart ( const double & z)
inline

Definition at line 69 of file ClassicField.h.

References start_m.

◆ SortAsc()

bool ClassicField::SortAsc ( const ClassicField & fle1,
const ClassicField & fle2 )
inlinestatic

Definition at line 24 of file ClassicField.h.

References ClassicField(), element_m, ElementBase::getName(), and start_m.

Referenced by OpalBeamline::prepareSections(), and OpalBeamline::save3DLattice().

Here is the call graph for this function:

◆ ZeroLength()

bool ClassicField::ZeroLength ( const ClassicField & fle)
inlinestatic

Definition at line 29 of file ClassicField.h.

References ClassicField(), and getLength().

Here is the call graph for this function:

Member Data Documentation

◆ element_m

std::shared_ptr<Component> ClassicField::element_m
private

Definition at line 37 of file ClassicField.h.

Referenced by ClassicField(), getBoundingBoxInLabCoords(), getElement(), getElement(), setOff(), setOn(), SortAsc(), and ~ClassicField().

◆ end_m

double ClassicField::end_m
private

Definition at line 39 of file ClassicField.h.

Referenced by ClassicField(), getEnd(), getLength(), and setEnd().

◆ is_on_m

bool ClassicField::is_on_m
private

Definition at line 40 of file ClassicField.h.

Referenced by ClassicField(), isOn(), setOff(), and setOn().

◆ order_m

unsigned int ClassicField::order_m

Definition at line 35 of file ClassicField.h.

Referenced by OpalBeamline::save3DLattice().

◆ start_m

double ClassicField::start_m
private

Definition at line 38 of file ClassicField.h.

Referenced by ClassicField(), getLength(), getStart(), setStart(), and SortAsc().

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