OPALX (Object Oriented Parallel Accelerator Library for Exascal) master (dc2a29eed580)
OPALX
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
OpalBend Class Referenceabstract

Base class for all bending magnets. More...

#include <OpalBend.h>

Inheritance diagram for OpalBend:
Inheritance graph
Collaboration diagram for OpalBend:
Collaboration graph

Public Types

enum  {
  ANGLE = COMMON , K0 , K0S , K1 ,
  K1S , K2 , K2S , K3 ,
  K3S , E1 , E2 , H1 ,
  H2 , HGAP , FINT , SLICES ,
  STEPSIZE , FMAPFN , GAP , HAPERT ,
  ROTATION , DESIGNENERGY , GREATERTHANPI , NSLICES ,
  SIZE
}
 The attribute numbers for OPAL bend magnets. More...
 
enum  {
  TYPE , APERT , LENGTH , ELEMEDGE ,
  WAKEF , PARTICLEMATTERINTERACTION , ORIGIN , ORIENTATION ,
  X , Y , Z , THETA ,
  PHI , PSI , DX , DY ,
  DZ , DTHETA , DPHI , DPSI ,
  OUTFN , DELETEONTRANSVERSEEXIT , COMMON
}
 The common attributes for all elements. More...
 
enum  ReferenceType { IS_ENTRY , IS_CENTRE , IS_EXIT }
 Reference for element positioning. More...
 

Public Member Functions

 OpalBend (const char *name, const char *help)
 Exemplar constructor.
 
virtual ~OpalBend ()
 
virtual void print (std::ostream &) const
 Print the bend magnet.
 
virtual double getLength () const
 Return element length.
 
const std::string getTypeName () const
 Return the element's type name.
 
std::pair< ApertureType, std::vector< double > > getApert () const
 
const std::string getWakeF () const
 Return the element's type name.
 
const std::string getParticleMatterInteraction () const
 
const std::string getWMaterial () const
 
const std::string getWakeGeom () const
 
std::vector< double > getWakeParam () const
 
const std::string getWakeConductivity () const
 
virtual void parse (Statement &)
 Parse the element.
 
virtual void update ()
 Update the embedded OPALX element.
 
virtual void updateUnknown (ElementBase *)
 Transmit the `‘unknown’' (not known to OPALX) attributes to OPALX.
 
void registerOwnership (const AttributeHandler::OwnerType &itsClass) const
 
virtual bool canReplaceBy (Object *object)
 Test if replacement is allowed.
 
virtual const std::string getCategory () const
 Return the object category as a string.
 
virtual bool shouldTrace () const
 Trace flag.
 
virtual bool shouldUpdate () const
 Update flag.
 
virtual double getEntrance (ReferenceType) const
 Return arc length from origin to entrance (negative !).
 
virtual double getExit (ReferenceType) const
 Return arc length from origin to exit (positive !).
 
virtual void setShared (bool)
 Set shared flag.
 
ElementBase * getElement () const
 Return the embedded OPALX element.
 
std::shared_ptr< ElementBase > getElementPtr () const
 Return the embedded OPALX element as shared_ptr.
 
void setElement (ElementBase *)
 Assign new OPALX element.
 
void setElement (std::shared_ptr< ElementBase > base)
 
virtual Object * clone (const std::string &name)=0
 Return a clone.
 
void copyAttributes (const Object &)
 Copy attributes from another object.
 
virtual void execute ()
 Execute the command.
 
virtual Attribute * findAttribute (const std::string &name)
 Find an attribute by name.
 
virtual const Attribute * findAttribute (const std::string &name) const
 Find an attribute by name.
 
virtual Object * makeTemplate (const std::string &, TokenStream &, Statement &)
 Macro handler function.
 
virtual Object * makeInstance (const std::string &name, Statement &, const Parser *)
 Macro handler function.
 
virtual void parseShortcut (Statement &, bool eval=true)
 Parser for single-attribute commands.
 
virtual void printValue (std::ostream &) const
 
virtual void printHelp (std::ostream &) const
 Print help.
 
virtual void replace (Object *oldObject, Object *newObject)
 Replace references.
 
bool isBuiltin () const
 True, if [b]this[/b] is a built-in object.
 
virtual bool isShared () const
 Shared flag.
 
void setDirty (bool)
 Set/reset the [b]modified[/b] flag.
 
bool isDirty () const
 True, if the [b]modified[/b] flag is set.
 
void setFlag (bool)
 Flag/unflag this object, e. g. to control output of objects for.
 
bool isFlagged () const
 True, if [b]this[/b] is flagged by setFlag(true).
 
const Object * getBaseObject () const
 Return the object's base type object.
 
const std::string & getOpalName () const
 Return object name.
 
Object * getParent () const
 Return parent pointer.
 
bool isTreeMember (const Object *subTree) const
 Test for tree membership.
 
void setOpalName (const std::string &name)
 Set object name.
 
void setParent (Object *)
 Set parent object.
 
void clear ()
 Clear the occurrence counter.
 
int increment ()
 Increment and return the occurrence counter.
 
int occurrenceCount ()
 Return the occurrence counter.
 
void registerReference (Invalidator *a)
 Register a reference to this object.
 
void unregisterReference (Invalidator *a)
 Unegister a reference to this object.
 

Static Public Member Functions

static Element * find (const std::string &name)
 Find named Element.
 

Public Attributes

std::vector< Attribute > itsAttr
 The object attributes.
 

Protected Member Functions

 OpalBend (const std::string &name, OpalBend *parent)
 Clone constructor.
 
void registerOwnership () const
 

Static Protected Member Functions

static void printMultipoleStrength (std::ostream &os, int order, int &len, const std::string &sName, const std::string &tName, const Attribute &length, const Attribute &vNorm, const Attribute &vSkew)
 Print multipole components in OPAL-8 format.
 
static void printAttribute (std::ostream &os, const std::string &name, const std::string &image, int &len)
 Print an attribute with a OPAL-8 name (as an expression).
 
static void printAttribute (std::ostream &os, const std::string &name, double value, int &len)
 Print an attribute with a OPAL-8 name (as a constant).
 

Protected Attributes

bool builtin
 Built-in flag.
 
bool modified
 Dirty flag.
 
bool flagged
 Object flag.
 

Private Member Functions

 OpalBend (const OpalBend &)
 
void operator= (const OpalBend &)
 

Private Attributes

int itsSize
 
std::shared_ptr< ElementBase > itsOPALXElement
 
Object * itsParent
 
std::string itsName
 
std::string itsHelp
 
int occurrence
 
double timeStamp
 
std::set< Invalidator * > references
 
bool sharedFlag
 

Detailed Description

Base class for all bending magnets.

Definition at line 29 of file OpalBend.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
inherited

The common attributes for all elements.

Enumerator
TYPE 
APERT 
LENGTH 
ELEMEDGE 
WAKEF 
PARTICLEMATTERINTERACTION 
ORIGIN 
ORIENTATION 
X 
Y 
Z 
THETA 
PHI 
PSI 
DX 
DY 
DZ 
DTHETA 
DPHI 
DPSI 
OUTFN 
DELETEONTRANSVERSEEXIT 
COMMON 

Definition at line 34 of file OpalElement.h.

◆ anonymous enum

anonymous enum

The attribute numbers for OPAL bend magnets.

Enumerator
ANGLE 
K0 
K0S 
K1 
K1S 
K2 
K2S 
K3 
K3S 
E1 
E2 
H1 
H2 
HGAP 
FINT 
SLICES 
STEPSIZE 
FMAPFN 
GAP 
HAPERT 
ROTATION 
DESIGNENERGY 
GREATERTHANPI 
NSLICES 
SIZE 

Definition at line 32 of file OpalBend.h.

◆ ReferenceType

enum Element::ReferenceType
inherited

Reference for element positioning.

Enumerator
IS_ENTRY 
IS_CENTRE 
IS_EXIT 

Definition at line 43 of file Element.h.

Constructor & Destructor Documentation

◆ OpalBend() [1/3]

OpalBend::OpalBend ( const char *  name,
const char *  help 
)

Exemplar constructor.

Definition at line 29 of file OpalBend.cpp.

References ANGLE, DESIGNENERGY, E1, E2, FINT, FMAPFN, GAP, GREATERTHANPI, H1, H2, HAPERT, HGAP, Object::itsAttr, K0, K0S, K1, K1S, K2, K2S, K3, K3S, Attributes::makeBool(), Attributes::makeReal(), Attributes::makeString(), NSLICES, ROTATION, SLICES, and STEPSIZE.

Here is the call graph for this function:

◆ ~OpalBend()

OpalBend::~OpalBend ( )
virtual

Definition at line 61 of file OpalBend.cpp.

◆ OpalBend() [2/3]

OpalBend::OpalBend ( const std::string &  name,
OpalBend *  parent 
)
protected

Clone constructor.

Definition at line 59 of file OpalBend.cpp.

◆ OpalBend() [3/3]

OpalBend::OpalBend ( const OpalBend &  )
private

Member Function Documentation

◆ canReplaceBy()

bool Element::canReplaceBy ( Object *  object)
virtualinherited

Test if replacement is allowed.

Reimplemented from Object.

Definition at line 37 of file Element.cpp.

◆ clear()

void Object::clear ( )
inherited

Clear the occurrence counter.

Definition at line 285 of file Object.cpp.

References Object::occurrence.

◆ clone()

virtual Object * Object::clone ( const std::string &  name)
pure virtualinherited

Return a clone.

Implemented in Call, Echo, Help, Option, PSystem, Quit, Select, Stop, System, Title, Value, Distribution, OpalCavity, OpalConstantEFieldCavity, OpalDrift, OpalMarker, OpalMonitor, OpalMultipole, OpalProbe, OpalQuadrupole, OpalRBend, OpalRingDefinition, OpalSBend, OpalSolenoid, OpalSource, OpalTravelingWave, OpalVacuum, OpalVerticalFFAMagnet, EmissionSourceList, Line, LineTemplate, Sequence, SequenceTemplate, Macro, Beam, BinningCmd, BoundaryGeometry, EmissionSource, FieldSolverCmd, TrackCmd, TrackEnd, TrackRun, OpalFilter, BoolConstant, RealConstant, RealVariable, RealVector, StringConstant, DumpEMFields, OpalLaser, OpalMultipoleT, OpalPolynomialTimeDependence, OpalSinusoidalTimeDependence, OpalSplineTimeDependence, and OpalVariableRFCavity.

Referenced by OpalParser::parseAction(), OpalParser::parseAssign(), and OpalParser::parseDefine().

◆ copyAttributes()

void Object::copyAttributes ( const Object &  source)
inherited

Copy attributes from another object.

Definition at line 50 of file Object.cpp.

References Object::itsAttr.

Referenced by SequenceTemplate::makeInstance(), and LineTemplate::makeInstance().

◆ execute()

void Object::execute ( )
virtualinherited

Execute the command.

Reimplemented in Call, Echo, Help, Option, PSystem, Quit, Select, Stop, System, Title, Value, Distribution, EmissionSourceList, MacroCmd, Beam, BinningCmd, BoundaryGeometry, EmissionSource, FieldSolverCmd, TrackCmd, TrackEnd, TrackRun, OpalFilter, and DumpEMFields.

Definition at line 52 of file Object.cpp.

◆ find()

Element * Element::find ( const std::string &  name)
staticinherited

Find named Element.

Definition at line 39 of file Element.cpp.

References OpalData::find(), and OpalData::getInstance().

Referenced by Sequence::addEndMarkers(), SequenceParser::findNeighbourPositions(), Selector::handleElement(), Line::parse(), Selector::Selector(), and Sequence::storeLine().

Here is the call graph for this function:

◆ findAttribute() [1/2]

Attribute * Object::findAttribute ( const std::string &  name)
virtualinherited

Find an attribute by name.

Definition at line 56 of file Object.cpp.

References Object::itsAttr.

Referenced by SequenceParser::findNeighbourPositions(), OpalElement::getParticleMatterInteraction(), OpalElement::getTypeName(), OpalElement::getWakeF(), Object::parse(), OpalElement::parse(), Line::parse(), OpalParser::parseAssign(), SequenceParser::parsePosition(), TrackRun::print(), and TEST().

◆ findAttribute() [2/2]

const Attribute * Object::findAttribute ( const std::string &  name) const
virtualinherited

Find an attribute by name.

Definition at line 63 of file Object.cpp.

References Object::itsAttr.

◆ getApert()

std::pair< ApertureType, std::vector< double > > OpalElement::getApert ( ) const
inherited

Definition at line 103 of file OpalElement.cpp.

References OpalElement::APERT, CONIC_ELLIPTICAL, CONIC_RECTANGULAR, ELLIPTICAL, Attributes::getString(), Object::itsAttr, and RECTANGULAR.

Referenced by OpalElement::update().

Here is the call graph for this function:

◆ getBaseObject()

const Object * Object::getBaseObject ( ) const
inherited

Return the object's base type object.

Definition at line 260 of file Object.cpp.

References Object::itsParent.

◆ getCategory()

const std::string Element::getCategory ( ) const
virtualinherited

Return the object category as a string.

Implements Object.

Reimplemented in BeamSequence.

Definition at line 48 of file Element.cpp.

◆ getElement()

ElementBase * Element::getElement ( ) const
inlineinherited

Return the embedded OPALX element.

Definition at line 119 of file Element.h.

References Element::itsOPALXElement.

Referenced by Line::fetchLine(), Sequence::fetchLine(), OpalMarker::OpalMarker(), OpalVariableRFCavity::OpalVariableRFCavity(), Line::replace(), Sequence::replace(), TEST(), TEST(), TEST(), TEST_F(), TEST_F(), OpalCavity::update(), OpalConstantEFieldCavity::update(), OpalDrift::update(), OpalElement::update(), OpalMarker::update(), OpalMonitor::update(), OpalMultipole::update(), OpalProbe::update(), OpalQuadrupole::update(), OpalRBend::update(), OpalRingDefinition::update(), OpalSBend::update(), OpalSolenoid::update(), OpalTravelingWave::update(), OpalVacuum::update(), OpalVerticalFFAMagnet::update(), OpalLaser::update(), OpalMultipoleT::update(), and OpalVariableRFCavity::update().

◆ getElementPtr()

std::shared_ptr< ElementBase > Element::getElementPtr ( ) const
inlineinherited

Return the embedded OPALX element as shared_ptr.

Definition at line 121 of file Element.h.

References Element::itsOPALXElement.

Referenced by Sequence::addEndMarkers(), and Line::parse().

◆ getEntrance()

double Element::getEntrance ( ReferenceType  ref) const
virtualinherited

Return arc length from origin to entrance (negative !).

Reimplemented in Sequence.

Definition at line 54 of file Element.cpp.

References Element::getLength(), Element::IS_CENTRE, and Element::IS_EXIT.

Referenced by Sequence::getEntrance().

Here is the call graph for this function:

◆ getExit()

double Element::getExit ( ReferenceType  ref) const
virtualinherited

Return arc length from origin to exit (positive !).

Reimplemented in Sequence.

Definition at line 67 of file Element.cpp.

References Element::getLength(), Element::IS_CENTRE, and Element::IS_ENTRY.

Referenced by Sequence::getExit().

Here is the call graph for this function:

◆ getLength()

double OpalElement::getLength ( ) const
virtualinherited

Return element length.

Implements Element.

Definition at line 277 of file OpalElement.cpp.

References Attributes::getReal(), Object::itsAttr, and OpalElement::LENGTH.

Referenced by OpalConstantEFieldCavity::update(), OpalMultipole::update(), and OpalQuadrupole::update().

Here is the call graph for this function:

◆ getOpalName()

const std::string & Object::getOpalName ( ) const
inherited

Return object name.

Definition at line 267 of file Object.cpp.

References Object::itsName.

Referenced by OpalVariableRFCavity::clone(), Macro::clone(), OpalData::create(), OpalData::define(), Sequence::findDriftLength(), SequenceParser::findNeighbourPositions(), ValueDefinition::getBool(), ValueDefinition::getBoolComponent(), ValueDefinition::getReal(), ValueDefinition::getRealComponent(), ValueDefinition::getString(), ValueDefinition::getStringComponent(), Object::makeInstance(), SequenceTemplate::makeInstance(), LineTemplate::makeInstance(), Object::parse(), SequenceParser::parseMember(), SequenceParser::parsePosition(), Object::print(), OpalElement::print(), Sequence::print(), TrackRun::print(), BoolConstant::print(), RealConstant::print(), RealVariable::print(), RealVector::print(), StringConstant::print(), Beam::print(), OpalFilter::print(), Line::print(), BinningCmd::printInfo(), BoundaryGeometry::printInfo(), FieldSolverCmd::printInfo(), OpalElement::registerOwnership(), Object::registerOwnership(), Line::replace(), Sequence::replace(), PartBunch< T, Dim >::setBins(), TEST(), TEST(), TEST(), TEST_F(), Beam::update(), BoundaryGeometry::update(), OpalFilter::update(), OpalPolynomialTimeDependence::update(), OpalSinusoidalTimeDependence::update(), and OpalSplineTimeDependence::update().

◆ getParent()

Object * Object::getParent ( ) const
inherited

Return parent pointer.

Definition at line 269 of file Object.cpp.

References Object::itsParent.

Referenced by OpalData::erase(), Object::print(), OpalElement::print(), OpalElement::registerOwnership(), and Object::registerOwnership().

◆ getParticleMatterInteraction()

const std::string OpalElement::getParticleMatterInteraction ( ) const
inherited

Definition at line 292 of file OpalElement.cpp.

References Object::findAttribute(), and Attributes::getString().

Here is the call graph for this function:

◆ getTypeName()

const std::string OpalElement::getTypeName ( ) const
inherited

Return the element's type name.

Definition at line 279 of file OpalElement.cpp.

References Object::findAttribute(), and Attributes::getString().

Referenced by Selector::handleElement().

Here is the call graph for this function:

◆ getWakeConductivity()

const std::string OpalElement::getWakeConductivity ( ) const
inherited

◆ getWakeF()

const std::string OpalElement::getWakeF ( ) const
inherited

Return the element's type name.

Functions to get the wake field parametes

Definition at line 287 of file OpalElement.cpp.

References Object::findAttribute(), and Attributes::getString().

Here is the call graph for this function:

◆ getWakeGeom()

const std::string OpalElement::getWakeGeom ( ) const
inherited

◆ getWakeParam()

std::vector< double > OpalElement::getWakeParam ( ) const
inherited

◆ getWMaterial()

const std::string OpalElement::getWMaterial ( ) const
inherited

◆ increment()

int Object::increment ( )
inherited

Increment and return the occurrence counter.

Definition at line 287 of file Object.cpp.

References Object::occurrence.

Referenced by Line::parse(), and Sequence::storeLine().

◆ isBuiltin()

bool Object::isBuiltin ( ) const
inherited

True, if [b]this[/b] is a built-in object.

Definition at line 243 of file Object.cpp.

References Object::builtin.

Referenced by OpalData::define(), and OpalData::getVariableNames().

◆ isDirty()

bool Object::isDirty ( ) const
inherited

True, if the [b]modified[/b] flag is set.

Definition at line 254 of file Object.cpp.

References Object::modified.

◆ isFlagged()

bool Object::isFlagged ( ) const
inherited

True, if [b]this[/b] is flagged by setFlag(true).

Definition at line 258 of file Object.cpp.

References Object::flagged.

◆ isShared()

bool Object::isShared ( ) const
virtualinherited

Shared flag.

Definition at line 245 of file Object.cpp.

References Object::sharedFlag.

Referenced by Sequence::print().

◆ isTreeMember()

bool Object::isTreeMember ( const Object *  subTree) const
inherited

Test for tree membership.

Definition at line 271 of file Object.cpp.

References Object::itsParent.

Referenced by Selector::handleElement(), and OpalParser::parseAssign().

◆ makeInstance()

Object * Object::makeInstance ( const std::string &  name,
Statement &  ,
const Parser *   
)
virtualinherited

Macro handler function.

Reimplemented in SequenceTemplate, MacroCmd, and LineTemplate.

Definition at line 76 of file Object.cpp.

References Object::getOpalName().

Referenced by OpalParser::parseDefine(), and OpalParser::parseMacro().

Here is the call graph for this function:

◆ makeTemplate()

Object * Object::makeTemplate ( const std::string &  name,
TokenStream &  ,
Statement &   
)
virtualinherited

Macro handler function.

Reimplemented in LineTemplate, Sequence, MacroCmd, SequenceTemplate, and Line.

Definition at line 71 of file Object.cpp.

Referenced by OpalParser::parseMacro().

◆ occurrenceCount()

int Object::occurrenceCount ( )
inherited

Return the occurrence counter.

Definition at line 289 of file Object.cpp.

References Object::occurrence.

◆ operator=()

void OpalBend::operator= ( const OpalBend &  )
private

◆ parse()

void OpalElement::parse ( Statement &  stat)
virtualinherited

Parse the element.

Reimplemented from Object.

Definition at line 297 of file OpalElement.cpp.

References Statement::delimiter(), Object::findAttribute(), Attribute::parse(), Attribute::parseComponent(), Expressions::parseDelimiter(), Expressions::parseRealConst(), Expressions::parseString(), and Attribute::setDefault().

Here is the call graph for this function:

◆ parseShortcut()

void Object::parseShortcut ( Statement &  stat,
bool  eval = true 
)
virtualinherited

Parser for single-attribute commands.

Definition at line 113 of file Object.cpp.

Referenced by Call::parse(), Echo::parse(), Help::parse(), PSystem::parse(), System::parse(), Title::parse(), and Value::parse().

◆ print()

void OpalBend::print ( std::ostream &  os) const
virtual

Print the bend magnet.

Reimplemented from OpalElement.

Definition at line 63 of file OpalBend.cpp.

References OpalElement::print().

Here is the call graph for this function:

◆ printAttribute() [1/2]

void OpalElement::printAttribute ( std::ostream &  os,
const std::string &  name,
const std::string &  image,
int &  len 
)
staticprotectedinherited

Print an attribute with a OPAL-8 name (as an expression).

Definition at line 540 of file OpalElement.cpp.

Referenced by OpalElement::printAttribute(), and OpalElement::printMultipoleStrength().

◆ printAttribute() [2/2]

void OpalElement::printAttribute ( std::ostream &  os,
const std::string &  name,
double  value,
int &  len 
)
staticprotectedinherited

Print an attribute with a OPAL-8 name (as a constant).

Definition at line 552 of file OpalElement.cpp.

References OpalElement::printAttribute().

Here is the call graph for this function:

◆ printHelp()

void Object::printHelp ( std::ostream &  ) const
virtualinherited

Print help.

Definition at line 179 of file Object.cpp.

References gmsg, Object::itsAttr, and Object::itsHelp.

Referenced by Help::execute().

◆ printMultipoleStrength()

void OpalElement::printMultipoleStrength ( std::ostream &  os,
int  order,
int &  len,
const std::string &  sName,
const std::string &  tName,
const Attribute &  length,
const Attribute &  vNorm,
const Attribute &  vSkew 
)
staticprotectedinherited

Print multipole components in OPAL-8 format.

Definition at line 343 of file OpalElement.cpp.

References Attribute::getBase(), Attribute::getImage(), Attributes::getReal(), AttributeBase::isExpression(), Physics::pi, and OpalElement::printAttribute().

Here is the call graph for this function:

◆ printValue()

void Object::printValue ( std::ostream &  os) const
inlinevirtualinherited

Reimplemented in BoolConstant, RealConstant, RealVariable, RealVector, and StringConstant.

Definition at line 270 of file Object.h.

References Object::print().

Here is the call graph for this function:

◆ registerOwnership() [1/2]

void OpalElement::registerOwnership ( ) const
protectedinherited

Definition at line 559 of file OpalElement.cpp.

References AttributeHandler::addAttributeOwner(), OpalElement::COMMON, AttributeHandler::ELEMENT, Object::getOpalName(), Object::getParent(), Object::itsAttr, and OpalElement::itsSize.

Referenced by OpalCavity::OpalCavity(), OpalConstantEFieldCavity::OpalConstantEFieldCavity(), OpalDrift::OpalDrift(), OpalLaser::OpalLaser(), OpalMonitor::OpalMonitor(), OpalMultipole::OpalMultipole(), OpalMultipoleT::OpalMultipoleT(), OpalPolynomialTimeDependence::OpalPolynomialTimeDependence(), OpalProbe::OpalProbe(), OpalQuadrupole::OpalQuadrupole(), OpalRBend::OpalRBend(), OpalRingDefinition::OpalRingDefinition(), OpalSBend::OpalSBend(), OpalSinusoidalTimeDependence::OpalSinusoidalTimeDependence(), OpalSolenoid::OpalSolenoid(), OpalSplineTimeDependence::OpalSplineTimeDependence(), OpalTravelingWave::OpalTravelingWave(), OpalVacuum::OpalVacuum(), OpalVariableRFCavity::OpalVariableRFCavity(), and OpalVerticalFFAMagnet::OpalVerticalFFAMagnet().

Here is the call graph for this function:

◆ registerOwnership() [2/2]

void Object::registerOwnership ( const AttributeHandler::OwnerType &  itsClass) const
inherited

Definition at line 169 of file Object.cpp.

References AttributeHandler::addAttributeOwner(), Object::getOpalName(), Object::getParent(), and Object::itsAttr.

Referenced by Beam::Beam(), BoolConstant::BoolConstant(), BoundaryGeometry::BoundaryGeometry(), Call::Call(), Distribution::Distribution(), DumpEMFields::DumpEMFields(), Echo::Echo(), EmissionSource::EmissionSource(), EmissionSourceList::EmissionSourceList(), Help::Help(), Line::Line(), OpalFilter::OpalFilter(), Option::Option(), PSystem::PSystem(), RealConstant::RealConstant(), RealVariable::RealVariable(), RealVector::RealVector(), Select::Select(), Sequence::Sequence(), StringConstant::StringConstant(), System::System(), Title::Title(), TrackCmd::TrackCmd(), TrackRun::TrackRun(), and Value::Value().

Here is the call graph for this function:

◆ registerReference()

void Object::registerReference ( Invalidator *  a)
inherited

Register a reference to this object.

Definition at line 165 of file Object.cpp.

References Object::references.

◆ replace()

void Object::replace ( Object *  oldObject,
Object *  newObject 
)
virtualinherited

Replace references.

Reimplemented in Line, and Sequence.

Definition at line 235 of file Object.cpp.

◆ setDirty()

void Object::setDirty ( bool  dirty)
inherited

Set/reset the [b]modified[/b] flag.

Definition at line 249 of file Object.cpp.

References Object::modified.

Referenced by OpalData::define(), OpalData::makeDirty(), and RealVariable::RealVariable().

◆ setElement() [1/2]

void Element::setElement ( ElementBase *  base)
inlineinherited

Assign new OPALX element.

Definition at line 123 of file Element.h.

References Element::itsOPALXElement.

Referenced by Line::Line(), Line::Line(), OpalCavity::OpalCavity(), OpalCavity::OpalCavity(), OpalConstantEFieldCavity::OpalConstantEFieldCavity(), OpalConstantEFieldCavity::OpalConstantEFieldCavity(), OpalDrift::OpalDrift(), OpalDrift::OpalDrift(), OpalLaser::OpalLaser(), OpalLaser::OpalLaser(), OpalMarker::OpalMarker(), OpalMarker::OpalMarker(), OpalMonitor::OpalMonitor(), OpalMonitor::OpalMonitor(), OpalMultipole::OpalMultipole(), OpalMultipole::OpalMultipole(), OpalMultipoleT::OpalMultipoleT(), OpalMultipoleT::OpalMultipoleT(), OpalProbe::OpalProbe(), OpalProbe::OpalProbe(), OpalQuadrupole::OpalQuadrupole(), OpalQuadrupole::OpalQuadrupole(), OpalRBend::OpalRBend(), OpalRBend::OpalRBend(), OpalRingDefinition::OpalRingDefinition(), OpalRingDefinition::OpalRingDefinition(), OpalSBend::OpalSBend(), OpalSBend::OpalSBend(), OpalSolenoid::OpalSolenoid(), OpalSolenoid::OpalSolenoid(), OpalTravelingWave::OpalTravelingWave(), OpalTravelingWave::OpalTravelingWave(), OpalVacuum::OpalVacuum(), OpalVacuum::OpalVacuum(), OpalVariableRFCavity::OpalVariableRFCavity(), OpalVariableRFCavity::OpalVariableRFCavity(), OpalVerticalFFAMagnet::OpalVerticalFFAMagnet(), OpalVerticalFFAMagnet::OpalVerticalFFAMagnet(), Sequence::Sequence(), Sequence::Sequence(), and OpalVariableRFCavity::update().

◆ setElement() [2/2]

void Element::setElement ( std::shared_ptr< ElementBase >  base)
inlineinherited

Definition at line 130 of file Element.h.

References Element::itsOPALXElement.

◆ setFlag()

void Object::setFlag ( bool  flag)
inherited

Flag/unflag this object, e. g. to control output of objects for.

Definition at line 256 of file Object.cpp.

References Object::flagged.

◆ setOpalName()

void Object::setOpalName ( const std::string &  name)
inherited

Set object name.

Definition at line 281 of file Object.cpp.

References Object::itsName.

Referenced by TEST(), TEST(), TEST(), Beam::update(), BoundaryGeometry::update(), and OpalFilter::update().

◆ setParent()

void Object::setParent ( Object *  parent)
inherited

Set parent object.

Definition at line 283 of file Object.cpp.

References Object::itsParent.

Referenced by OpalData::erase().

◆ setShared()

void Element::setShared ( bool  flag)
virtualinherited

Set shared flag.

Reimplemented from Object.

Definition at line 80 of file Element.cpp.

References Element::itsOPALXElement, and Object::setShared().

Here is the call graph for this function:

◆ shouldTrace()

bool Element::shouldTrace ( ) const
virtualinherited

Trace flag.

Implements Object.

Definition at line 50 of file Element.cpp.

◆ shouldUpdate()

bool Element::shouldUpdate ( ) const
virtualinherited

Update flag.

Implements Object.

Definition at line 52 of file Element.cpp.

◆ unregisterReference()

void Object::unregisterReference ( Invalidator *  a)
inherited

Unegister a reference to this object.

Definition at line 167 of file Object.cpp.

References Object::references.

◆ update()

void OpalElement::update ( )
virtualinherited

Update the embedded OPALX element.

Reimplemented from Object.

Reimplemented in OpalCavity, OpalConstantEFieldCavity, OpalDrift, OpalMarker, OpalMonitor, OpalMultipole, OpalProbe, OpalQuadrupole, OpalRBend, OpalRingDefinition, OpalSBend, OpalSolenoid, OpalSource, OpalTravelingWave, OpalVacuum, OpalVerticalFFAMagnet, OpalLaser, OpalMultipoleT, OpalPolynomialTimeDependence, OpalSinusoidalTimeDependence, OpalSplineTimeDependence, and OpalVariableRFCavity.

Definition at line 445 of file OpalElement.cpp.

References Quaternion::conjugate(), OpalElement::DELETEONTRANSVERSEEXIT, OpalElement::DPHI, OpalElement::DPSI, OpalElement::DTHETA, OpalElement::DX, OpalElement::DY, OpalElement::DZ, OpalElement::ELEMEDGE, ElementBase::fixPosition(), OpalElement::getApert(), Attributes::getBool(), Element::getElement(), Attributes::getReal(), Attributes::getRealArray(), Object::itsAttr, OpalElement::ORIENTATION, OpalElement::ORIGIN, OpalElement::PHI, OpalElement::PSI, ElementBase::setAperture(), ElementBase::setCSTrafoGlobal2Local(), ElementBase::setElementPosition(), ElementBase::setFlagDeleteOnTransverseExit(), ElementBase::setMisalignment(), ElementBase::setRotationAboutZ(), OpalElement::THETA, OpalElement::X, OpalElement::Y, and OpalElement::Z.

Referenced by OpalCavity::update(), OpalConstantEFieldCavity::update(), OpalDrift::update(), OpalMonitor::update(), OpalMultipole::update(), OpalProbe::update(), OpalQuadrupole::update(), OpalRBend::update(), OpalRingDefinition::update(), OpalSBend::update(), OpalSolenoid::update(), OpalTravelingWave::update(), OpalVacuum::update(), OpalLaser::update(), OpalMultipoleT::update(), and OpalVariableRFCavity::update().

Here is the call graph for this function:

◆ updateUnknown()

void OpalElement::updateUnknown ( ElementBase *  base)
virtualinherited

Transmit the `‘unknown’' (not known to OPALX) attributes to OPALX.

Definition at line 533 of file OpalElement.cpp.

References Attribute::getName(), Attributes::getReal(), Object::itsAttr, OpalElement::itsSize, and ElementBase::setAttribute().

Referenced by OpalCavity::update(), OpalConstantEFieldCavity::update(), OpalDrift::update(), OpalMarker::update(), OpalMonitor::update(), OpalMultipole::update(), OpalProbe::update(), OpalQuadrupole::update(), OpalRBend::update(), OpalRingDefinition::update(), OpalSBend::update(), OpalSolenoid::update(), OpalTravelingWave::update(), OpalVacuum::update(), OpalLaser::update(), and OpalMultipoleT::update().

Here is the call graph for this function:

Member Data Documentation

◆ builtin

bool Object::builtin
protectedinherited

Built-in flag.

Definition at line 226 of file Object.h.

Referenced by Beam::Beam(), BoundaryGeometry::BoundaryGeometry(), Object::isBuiltin(), Object::Object(), Object::Object(), OpalFilter::OpalFilter(), OpalMarker::OpalMarker(), RealConstant::RealConstant(), StringConstant::StringConstant(), and Table::~Table().

◆ flagged

bool Object::flagged
protectedinherited

Object flag.

Definition at line 235 of file Object.h.

Referenced by Object::isFlagged(), Object::Object(), Object::Object(), and Object::setFlag().

◆ itsAttr

std::vector<Attribute> Object::itsAttr
inherited

The object attributes.

Definition at line 210 of file Object.h.

Referenced by Beam::Beam(), BinningCmd::BinningCmd(), BoolConstant::BoolConstant(), BoundaryGeometry::BoundaryGeometry(), BoundaryGeometry::BoundaryGeometry(), DumpEMFields::buildGrid(), Call::Call(), FieldSolverCmd::constructBCHandler(), Object::copyAttributes(), Distribution::Distribution(), BinningCmd::dumpBinsToFile(), DumpEMFields::DumpEMFields(), Echo::Echo(), EmissionSource::EmissionSource(), Call::execute(), Echo::execute(), Help::execute(), Option::execute(), PSystem::execute(), Select::execute(), System::execute(), Title::execute(), Value::execute(), Beam::execute(), TrackCmd::execute(), TrackRun::execute(), FieldSolverCmd::FieldSolverCmd(), Object::findAttribute(), Object::findAttribute(), BoundaryGeometry::getA(), BinningCmd::getAdaptiveBinning(), OpalElement::getApert(), BoundaryGeometry::getB(), BinningCmd::getBinningAlpha(), BinningCmd::getBinningBeta(), FieldSolverCmd::getBinsName(), BoolConstant::getBool(), FieldSolverCmd::getBoxIncr(), Beam::getBunchCharge(), BoundaryGeometry::getC(), Beam::getCharge(), Beam::getCurrent(), Beam::getDaughterBeamName(), BinningCmd::getDesiredWidth(), EmissionSource::getDistributionName(), FieldSolverCmd::getDomDec(), TrackCmd::getDT(), TrackCmd::getDTAU(), TrackCmd::getDTSCINIT(), BinningCmd::getDumpBinsFileName(), BinningCmd::getDumpBinsFrequency(), EmissionSource::getEmissionModel(), Beam::getEmissionSourceListName(), Distribution::getEmissionSteps(), Distribution::getFilename(), BoundaryGeometry::getFilename(), Beam::getFrequency(), Beam::getGlobalProcessNames(), BoundaryGeometry::getL1(), BoundaryGeometry::getL2(), BoundaryGeometry::getLength(), OpalElement::getLength(), Line::getLength(), Sequence::getLength(), Beam::getMass(), BinningCmd::getMaxBins(), TrackCmd::getMaxSteps(), Beam::getNumAlloc(), FieldSolverCmd::getNX(), FieldSolverCmd::getNY(), FieldSolverCmd::getNZ(), EmissionSource::getP0(), BinningCmd::getParameter(), Beam::getParticleName(), Beam::getPolarization(), EmissionSource::getR0(), RealConstant::getReal(), RealVariable::getReal(), RealVector::getRealComponent(), Sequence::getReference(), BoundaryGeometry::getS(), EmissionSource::getShiftedGreensFunction(), TrackCmd::getStepsPerTurn(), StringConstant::getString(), EmissionSource::getT0(), TrackCmd::getT0(), BinningCmd::getTablePrintFrequency(), TrackCmd::getTimeIntegrator(), BoundaryGeometry::getTopology(), FieldSolverCmd::getType(), EmissionSource::getZerofaceMaxSteps(), EmissionSource::getZeroFacePlaneDumpFrequency(), EmissionSource::getZeroFaceR0Z(), TrackCmd::getZStart(), TrackCmd::getZStop(), Beam::hasExplicitEnergy(), Beam::hasPolarization(), Help::Help(), BoundaryGeometry::initialize(), OpalFilter::initOpalFilter(), Beam::isPhoton(), Line::Line(), OpalBend(), OpalCavity::OpalCavity(), OpalConstantEFieldCavity::OpalConstantEFieldCavity(), OpalDrift::OpalDrift(), OpalElement::OpalElement(), OpalFilter::OpalFilter(), OpalLaser::OpalLaser(), OpalMultipole::OpalMultipole(), OpalMultipoleT::OpalMultipoleT(), OpalPolynomialTimeDependence::OpalPolynomialTimeDependence(), OpalProbe::OpalProbe(), OpalQuadrupole::OpalQuadrupole(), OpalRingDefinition::OpalRingDefinition(), OpalSinusoidalTimeDependence::OpalSinusoidalTimeDependence(), OpalSolenoid::OpalSolenoid(), OpalSplineTimeDependence::OpalSplineTimeDependence(), OpalTravelingWave::OpalTravelingWave(), OpalVacuum::OpalVacuum(), OpalVariableRFCavity::OpalVariableRFCavity(), OpalVerticalFFAMagnet::OpalVerticalFFAMagnet(), Option::Option(), Option::Option(), Sequence::parse(), Line::parse(), DumpEMFields::parseCoordinateSystem(), Object::print(), Sequence::print(), BoolConstant::print(), RealConstant::print(), RealVariable::print(), RealVector::print(), StringConstant::print(), Beam::print(), OpalFilter::print(), DumpEMFields::print(), Object::printHelp(), BoundaryGeometry::printInfo(), FieldSolverCmd::printInfo(), BoolConstant::printValue(), RealConstant::printValue(), RealVariable::printValue(), RealVector::printValue(), StringConstant::printValue(), PSystem::PSystem(), RealConstant::RealConstant(), RealConstant::RealConstant(), RealVariable::RealVariable(), RealVariable::RealVariable(), RealVector::RealVector(), OpalElement::registerOwnership(), Object::registerOwnership(), Select::Select(), Select::select(), Sequence::Sequence(), TestableBinningCmd::setAdaptiveBinning(), Distribution::setAttributes(), TestMultipoleT::TestableFieldSolverCmd::setBCX(), TestMultipoleTCurvedConstRadius::TestableFieldSolverCmd::setBCX(), TestMultipoleTStraight::TestableFieldSolverCmd::setBCX(), SolenoidPlacementTest::TestableFieldSolverCmd::setBCX(), TestVariableRFCavity::TestableFieldSolverCmd::setBCX(), OrbitThreaderTest::TestableFieldSolverCmd::setBCX(), OpalBeamlinePlacementTest::TestableFieldSolverCmd::setBCX(), TestMultipoleT::TestableFieldSolverCmd::setBCY(), TestMultipoleTCurvedConstRadius::TestableFieldSolverCmd::setBCY(), TestMultipoleTStraight::TestableFieldSolverCmd::setBCY(), SolenoidPlacementTest::TestableFieldSolverCmd::setBCY(), TestVariableRFCavity::TestableFieldSolverCmd::setBCY(), OrbitThreaderTest::TestableFieldSolverCmd::setBCY(), OpalBeamlinePlacementTest::TestableFieldSolverCmd::setBCY(), TestMultipoleT::TestableFieldSolverCmd::setBCZ(), TestMultipoleTCurvedConstRadius::TestableFieldSolverCmd::setBCZ(), TestMultipoleTStraight::TestableFieldSolverCmd::setBCZ(), SolenoidPlacementTest::TestableFieldSolverCmd::setBCZ(), TestVariableRFCavity::TestableFieldSolverCmd::setBCZ(), OrbitThreaderTest::TestableFieldSolverCmd::setBCZ(), OpalBeamlinePlacementTest::TestableFieldSolverCmd::setBCZ(), TestableBinningCmd::setBinningAlpha(), TestableBinningCmd::setBinningBeta(), TestableBinningCmd::setDesiredWidth(), Distribution::setDistParametersFlatTop(), Distribution::setDistParametersMultiVariateGauss(), Distribution::setDistType(), TestableBinningCmd::setDumpBinsFile(), TestableBinningCmd::setDumpBinsFreq(), TestableBinningCmd::setMaxBins(), FieldSolverCmd::setNX(), FieldSolverCmd::setNY(), FieldSolverCmd::setNZ(), TestableBinningCmd::setParameterString(), TrackRun::setRunMethod(), Distribution::setSigmaP_m(), Distribution::setSigmaR_m(), TestableBinningCmd::setTablePrintFrequency(), TestMultipoleT::TestableFieldSolverCmd::setType(), TestMultipoleTCurvedConstRadius::TestableFieldSolverCmd::setType(), TestMultipoleTStraight::TestableFieldSolverCmd::setType(), SolenoidPlacementTest::TestableFieldSolverCmd::setType(), TestVariableRFCavity::TestableFieldSolverCmd::setType(), OrbitThreaderTest::TestableFieldSolverCmd::setType(), OpalBeamlinePlacementTest::TestableFieldSolverCmd::setType(), TrackRun::setupBoundaryGeometry(), StringConstant::StringConstant(), StringConstant::StringConstant(), System::System(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), Title::Title(), TrackCmd::TrackCmd(), TrackRun::TrackRun(), OpalCavity::update(), OpalConstantEFieldCavity::update(), OpalDrift::update(), OpalElement::update(), OpalMonitor::update(), OpalMultipole::update(), OpalProbe::update(), OpalQuadrupole::update(), OpalRBend::update(), OpalRingDefinition::update(), OpalSBend::update(), OpalSolenoid::update(), OpalTravelingWave::update(), OpalVacuum::update(), OpalVerticalFFAMagnet::update(), Beam::update(), BinningCmd::update(), FieldSolverCmd::update(), OpalLaser::update(), OpalMultipoleT::update(), OpalPolynomialTimeDependence::update(), OpalSinusoidalTimeDependence::update(), OpalSplineTimeDependence::update(), OpalVariableRFCavity::update(), Option::update(), OpalElement::updateUnknown(), Beam::validatePolarization(), ValueDefinition::value(), Value::Value(), and ValueDefinition::value().

◆ itsHelp

std::string Object::itsHelp
privateinherited

Definition at line 250 of file Object.h.

Referenced by Object::printHelp().

◆ itsName

std::string Object::itsName
privateinherited

Definition at line 247 of file Object.h.

Referenced by Object::getOpalName(), and Object::setOpalName().

◆ itsOPALXElement

std::shared_ptr<ElementBase> Element::itsOPALXElement
privateinherited

Definition at line 113 of file Element.h.

Referenced by Element::getElement(), Element::getElementPtr(), Element::setElement(), Element::setElement(), and Element::setShared().

◆ itsParent

Object* Object::itsParent
privateinherited

Definition at line 244 of file Object.h.

Referenced by Object::getBaseObject(), Object::getParent(), Object::isTreeMember(), and Object::setParent().

◆ itsSize

int OpalElement::itsSize
privateinherited

Definition at line 129 of file OpalElement.h.

Referenced by OpalElement::registerOwnership(), and OpalElement::updateUnknown().

◆ modified

bool Object::modified
protectedinherited

Dirty flag.

Definition at line 231 of file Object.h.

Referenced by Object::isDirty(), Object::Object(), Object::Object(), and Object::setDirty().

◆ occurrence

int Object::occurrence
privateinherited

Definition at line 253 of file Object.h.

Referenced by Object::clear(), Object::increment(), and Object::occurrenceCount().

◆ references

std::set<Invalidator*> Object::references
privateinherited

Definition at line 260 of file Object.h.

Referenced by Object::registerReference(), Object::unregisterReference(), and Object::~Object().

◆ sharedFlag

bool Object::sharedFlag
privateinherited

Definition at line 263 of file Object.h.

Referenced by Object::isShared(), and Object::setShared().

◆ timeStamp

double Object::timeStamp
privateinherited

Definition at line 256 of file Object.h.

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