OPALX (Object Oriented Parallel Accelerator Library for Exascal) MINIorX
OPALX
OpalElement Class Referenceabstract

#include <OpalElement.h>

Inheritance diagram for OpalElement:
Collaboration diagram for OpalElement:

Public Types

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

virtual ~OpalElement ()
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 print (std::ostream &) const
 Print the object.
virtual void update ()
 Update the embedded CLASSIC element.
virtual void updateUnknown (ElementBase *)
 Transmit the ``unknown'' (not known to OPAL) attributes to CLASSIC.
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 CLASSIC element.
void setElement (ElementBase *)
 Assign new CLASSIC element.
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.
void registerOwnership (const AttributeHandler::OwnerType &itsClass) const
int addReference () const
 Increment reference count.
int removeReference () const
 Decrement the reference count.

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

 OpalElement (int size, const char *name, const char *help)
 Exemplar constructor.
 OpalElement (const std::string &name, OpalElement *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

 OpalElement ()
void operator= (const OpalElement &)

Private Attributes

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

Detailed Description

Definition at line 28 of file OpalElement.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

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 33 of file OpalElement.h.

◆ ReferenceType

enum Element::ReferenceType
inherited

Reference for element positioning.

Enumerator
IS_ENTRY 
IS_CENTRE 
IS_EXIT 

Definition at line 45 of file Element.h.

Constructor & Destructor Documentation

◆ ~OpalElement()

OpalElement::~OpalElement ( )
virtual

Definition at line 131 of file OpalElement.cpp.

◆ OpalElement() [1/3]

OpalElement::OpalElement ( int size,
const char * name,
const char * help )
protected

Exemplar constructor.

Definition at line 39 of file OpalElement.cpp.

References AttributeHandler::addAttributeOwner(), APERT, COMMON, DELETEONTRANSVERSEEXIT, DPHI, DPSI, DTHETA, DX, DY, DZ, ELEMEDGE, AttributeHandler::ELEMENT, Element::Element(), end(), Object::itsAttr, itsSize, LENGTH, Attributes::makeBool(), Attributes::makePredefinedString(), Attributes::makeReal(), Attributes::makeRealArray(), Attributes::makeString(), ORIENTATION, ORIGIN, OUTFN, PARTICLEMATTERINTERACTION, PHI, PSI, THETA, TYPE, WAKEF, X, Y, and Z.

Referenced by getWakeConductivity(), OpalCavity::OpalCavity(), OpalCavity::OpalCavity(), OpalDrift::OpalDrift(), OpalDrift::OpalDrift(), OpalElement(), OpalOffset::OpalGlobalCartesianOffset::OpalGlobalCartesianOffset(), OpalOffset::OpalGlobalCartesianOffset::OpalGlobalCartesianOffset(), OpalOffset::OpalGlobalCylindricalOffset::OpalGlobalCylindricalOffset(), OpalOffset::OpalGlobalCylindricalOffset::OpalGlobalCylindricalOffset(), OpalOffset::OpalLocalCartesianOffset::OpalLocalCartesianOffset(), OpalOffset::OpalLocalCartesianOffset::OpalLocalCartesianOffset(), OpalOffset::OpalLocalCylindricalOffset::OpalLocalCylindricalOffset(), OpalOffset::OpalLocalCylindricalOffset::OpalLocalCylindricalOffset(), OpalMarker::OpalMarker(), OpalMarker::OpalMarker(), OpalMonitor::OpalMonitor(), OpalMonitor::OpalMonitor(), OpalMultipole::OpalMultipole(), OpalMultipole::OpalMultipole(), OpalMultipoleT::OpalMultipoleT(), OpalMultipoleT::OpalMultipoleT(), OpalProbe::OpalProbe(), OpalProbe::OpalProbe(), OpalRingDefinition::OpalRingDefinition(), OpalRingDefinition::OpalRingDefinition(), OpalSolenoid::OpalSolenoid(), OpalSolenoid::OpalSolenoid(), OpalTravelingWave::OpalTravelingWave(), OpalTravelingWave::OpalTravelingWave(), OpalVacuum::OpalVacuum(), OpalVacuum::OpalVacuum(), OpalVerticalFFAMagnet::OpalVerticalFFAMagnet(), OpalVerticalFFAMagnet::OpalVerticalFFAMagnet(), and operator=().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ OpalElement() [2/3]

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

Clone constructor.

Definition at line 126 of file OpalElement.cpp.

References Element::Element(), itsSize, and OpalElement().

Here is the call graph for this function:

◆ OpalElement() [3/3]

OpalElement::OpalElement ( )
private

Member Function Documentation

◆ addReference()

int RCObject::addReference ( ) const
inlineinherited

Increment reference count.

Definition at line 83 of file RCObject.h.

References refCount.

Referenced by Pointer< Object >::operator=(), Pointer< Object >::operator=(), and Pointer< Object >::unique().

Here is the caller graph for this function:

◆ canReplaceBy()

bool Element::canReplaceBy ( Object * object)
virtualinherited

Test if replacement is allowed.

Reimplemented from Object.

Definition at line 40 of file Element.cpp.

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

Here is the call graph for this function:

◆ clear()

void Object::clear ( )
inherited

Clear the occurrence counter.

Definition at line 339 of file Object.cpp.

References occurrence.

◆ clone()

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

Return a clone.

Implemented in Beam, BoolConstant, BoundaryGeometry, Call, Distribution, DumpEMFields, DumpFields, Echo, FieldSolverCmd, Help, Line, LineTemplate, Macro, OpalCavity, OpalDrift, OpalFilter, OpalMarker, OpalMonitor, OpalMultipole, OpalMultipoleT, OpalOffset::OpalGlobalCartesianOffset, OpalOffset::OpalGlobalCylindricalOffset, OpalOffset::OpalLocalCartesianOffset, OpalOffset::OpalLocalCylindricalOffset, OpalProbe, OpalRingDefinition, OpalSolenoid, OpalSource, OpalTravelingWave, OpalVacuum, OpalVerticalFFAMagnet, Option, PSystem, Quit, RealConstant, RealVariable, RealVector, Select, Sequence, SequenceTemplate, Stop, StringConstant, System, Title, TrackCmd, TrackEnd, TrackRun, and Value.

References Object().

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

Here is the call graph for this function:
Here is the caller graph for this function:

◆ copyAttributes()

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

Copy attributes from another object.

Definition at line 54 of file Object.cpp.

References itsAttr, and Object().

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

Here is the call graph for this function:
Here is the caller graph for this function:

◆ execute()

void Object::execute ( )
virtualinherited

Execute the command.

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

Definition at line 59 of file Object.cpp.

◆ find()

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

Find named Element.

Definition at line 45 of file Element.cpp.

References Element(), 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:
Here is the caller graph for this function:

◆ findAttribute() [1/2]

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

Find an attribute by name.

Definition at line 64 of file Object.cpp.

References itsAttr.

Referenced by OpalElement::getParticleMatterInteraction(), OpalElement::getTypeName(), OpalElement::getWakeF(), Line::parse(), parse(), OpalElement::parse(), OpalParser::parseAssign(), SequenceParser::parsePosition(), and parseShortcut().

Here is the caller graph for this function:

◆ findAttribute() [2/2]

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

Find an attribute by name.

Definition at line 72 of file Object.cpp.

References itsAttr.

◆ getApert()

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

Definition at line 135 of file OpalElement.cpp.

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

Referenced by update().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getBaseObject()

const Object * Object::getBaseObject ( ) const
inherited

Return the object's base type object.

Definition at line 301 of file Object.cpp.

References itsParent, and Object().

Here is the call graph for this function:

◆ getCategory()

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

Return the object category as a string.

Implements Object.

Reimplemented in BeamSequence.

Definition at line 56 of file Element.cpp.

◆ getElement()

ElementBase * Element::getElement ( ) const
inlineinherited

Return the embedded CLASSIC element.

Definition at line 121 of file Element.h.

References itsClassicElement.

Referenced by Sequence::addEndMarkers(), Line::fetchLine(), Sequence::fetchLine(), OpalMarker::OpalMarker(), Line::parse(), Line::replace(), Sequence::replace(), OpalCavity::update(), OpalDrift::update(), OpalElement::update(), OpalMarker::update(), OpalMonitor::update(), OpalMultipole::update(), OpalMultipoleT::update(), OpalOffset::OpalLocalCartesianOffset::update(), OpalProbe::update(), OpalRingDefinition::update(), OpalSolenoid::update(), OpalTravelingWave::update(), OpalVacuum::update(), and OpalVerticalFFAMagnet::update().

Here is the caller graph for this function:

◆ getEntrance()

double Element::getEntrance ( ReferenceType ref) const
virtualinherited

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

Reimplemented in Sequence.

Definition at line 71 of file Element.cpp.

References getLength(), IS_CENTRE, and IS_EXIT.

Referenced by Sequence::getEntrance().

Here is the call graph for this function:
Here is the caller 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 86 of file Element.cpp.

References getLength(), IS_CENTRE, and IS_ENTRY.

Referenced by Sequence::getExit().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getLength()

double OpalElement::getLength ( ) const
virtual

Return element length.

Implements Element.

Definition at line 289 of file OpalElement.cpp.

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

Referenced by OpalMultipole::update().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getOpalName()

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

Return object name.

Definition at line 308 of file Object.cpp.

References itsName.

Referenced by Macro::clone(), OpalOffset::OpalLocalCartesianOffset::clone(), OpalData::create(), OpalData::define(), Sequence::findDriftLength(), ValueDefinition::getBool(), ValueDefinition::getBoolComponent(), ValueDefinition::getReal(), ValueDefinition::getRealComponent(), ValueDefinition::getString(), ValueDefinition::getStringComponent(), LineTemplate::makeInstance(), makeInstance(), SequenceTemplate::makeInstance(), parse(), SequenceParser::parsePosition(), parseShortcut(), Beam::print(), BoolConstant::print(), Line::print(), print(), OpalElement::print(), OpalFilter::print(), RealConstant::print(), RealVariable::print(), RealVector::print(), Sequence::print(), StringConstant::print(), BoundaryGeometry::printInfo(), FieldSolverCmd::printInfo(), registerOwnership(), OpalElement::registerOwnership(), Line::replace(), Sequence::replace(), Beam::update(), BoundaryGeometry::update(), OpalFilter::update(), OpalOffset::OpalGlobalCartesianOffset::update(), OpalOffset::OpalGlobalCylindricalOffset::update(), OpalOffset::OpalLocalCartesianOffset::update(), and OpalOffset::OpalLocalCylindricalOffset::update().

Here is the caller graph for this function:

◆ getParent()

Object * Object::getParent ( ) const
inherited

Return parent pointer.

Definition at line 313 of file Object.cpp.

References itsParent, and Object().

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

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getParticleMatterInteraction()

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

Definition at line 307 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

Return the element's type name.

Definition at line 294 of file OpalElement.cpp.

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

Referenced by Selector::handleElement().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getWakeConductivity()

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

References OpalElement().

Here is the call graph for this function:

◆ getWakeF()

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

Return the element's type name.

Functions to get the wake field parametes

Definition at line 302 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

◆ getWakeParam()

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

◆ getWMaterial()

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

◆ increment()

int Object::increment ( )
inherited

Increment and return the occurrence counter.

Definition at line 344 of file Object.cpp.

References occurrence.

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

Here is the caller graph for this function:

◆ isBuiltin()

bool Object::isBuiltin ( ) const
inherited

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

Definition at line 266 of file Object.cpp.

References builtin.

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

Here is the caller graph for this function:

◆ isDirty()

bool Object::isDirty ( ) const
inherited

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

Definition at line 287 of file Object.cpp.

References modified.

◆ isFlagged()

bool Object::isFlagged ( ) const
inherited

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

Definition at line 297 of file Object.cpp.

References flagged.

◆ isShared()

bool Object::isShared ( ) const
virtualinherited

Shared flag.

Definition at line 271 of file Object.cpp.

References sharedFlag.

Referenced by Sequence::print().

Here is the caller graph for this function:

◆ isTreeMember()

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

Test for tree membership.

Definition at line 318 of file Object.cpp.

References Object().

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

Here is the call graph for this function:
Here is the caller graph for this function:

◆ makeInstance()

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

Macro handler function.

Reimplemented in LineTemplate, MacroCmd, and SequenceTemplate.

Definition at line 89 of file Object.cpp.

References getOpalName(), and Object().

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

Here is the call graph for this function:
Here is the caller graph for this function:

◆ makeTemplate()

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

Macro handler function.

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

Definition at line 82 of file Object.cpp.

References Object().

Referenced by OpalParser::parseMacro().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ occurrenceCount()

int Object::occurrenceCount ( )
inherited

Return the occurrence counter.

Definition at line 349 of file Object.cpp.

References occurrence.

◆ operator=()

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

References OpalElement().

Here is the call graph for this function:

◆ parse()

void OpalElement::parse ( Statement & stat)
virtual

Parse the element.

Reimplemented from Object.

Definition at line 312 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 127 of file Object.cpp.

References Statement::delimiter(), findAttribute(), getOpalName(), Statement::mark(), and Statement::word().

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

Here is the call graph for this function:
Here is the caller graph for this function:

◆ print()

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

Print the object.

Reimplemented from Object.

Reimplemented in OpalMarker, OpalMultipole, OpalMultipoleT, OpalOffset::OpalGlobalCartesianOffset, OpalOffset::OpalGlobalCylindricalOffset, OpalOffset::OpalLocalCartesianOffset, OpalOffset::OpalLocalCylindricalOffset, and OpalRingDefinition.

Definition at line 347 of file OpalElement.cpp.

References Object::getOpalName(), Object::getParent(), and Object::Object().

Referenced by OpalMarker::print(), OpalMultipole::print(), OpalMultipoleT::print(), OpalOffset::OpalGlobalCartesianOffset::print(), OpalOffset::OpalGlobalCylindricalOffset::print(), OpalOffset::OpalLocalCartesianOffset::print(), OpalOffset::OpalLocalCylindricalOffset::print(), and OpalRingDefinition::print().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ printAttribute() [1/2]

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

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

Definition at line 574 of file OpalElement.cpp.

Referenced by printAttribute(), and printMultipoleStrength().

Here is the caller graph for this function:

◆ printAttribute() [2/2]

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

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

Definition at line 586 of file OpalElement.cpp.

References printAttribute().

Here is the call graph for this function:

◆ printHelp()

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

Print help.

Definition at line 199 of file Object.cpp.

References gmsg, itsAttr, and itsHelp.

Referenced by Help::execute(), and main().

Here is the caller graph for this function:

◆ 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 )
staticprotected

Print multipole components in OPAL-8 format.

Definition at line 362 of file OpalElement.cpp.

References Attribute::getBase(), Attribute::getImage(), Attributes::getReal(), AttributeBase::isExpression(), Physics::pi, and 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 280 of file Object.h.

References print().

Here is the call graph for this function:

◆ registerOwnership() [1/2]

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

Definition at line 189 of file Object.cpp.

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

Referenced by Beam::Beam(), BoolConstant::BoolConstant(), BoundaryGeometry::BoundaryGeometry(), Call::Call(), Distribution::Distribution(), DumpEMFields::DumpEMFields(), DumpFields::DumpFields(), Echo::Echo(), 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:
Here is the caller graph for this function:

◆ registerOwnership() [2/2]

void OpalElement::registerOwnership ( ) const
protected

Definition at line 594 of file OpalElement.cpp.

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

Referenced by OpalCavity::OpalCavity(), OpalDrift::OpalDrift(), OpalOffset::OpalGlobalCartesianOffset::OpalGlobalCartesianOffset(), OpalOffset::OpalGlobalCylindricalOffset::OpalGlobalCylindricalOffset(), OpalOffset::OpalLocalCartesianOffset::OpalLocalCartesianOffset(), OpalOffset::OpalLocalCylindricalOffset::OpalLocalCylindricalOffset(), OpalMonitor::OpalMonitor(), OpalMultipole::OpalMultipole(), OpalMultipoleT::OpalMultipoleT(), OpalProbe::OpalProbe(), OpalRingDefinition::OpalRingDefinition(), OpalSolenoid::OpalSolenoid(), OpalTravelingWave::OpalTravelingWave(), OpalVacuum::OpalVacuum(), and OpalVerticalFFAMagnet::OpalVerticalFFAMagnet().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ registerReference()

void Object::registerReference ( Invalidator * a)
inherited

Register a reference to this object.

Definition at line 180 of file Object.cpp.

References references.

◆ removeReference()

int RCObject::removeReference ( ) const
inlineinherited

Decrement the reference count.

Definition at line 88 of file RCObject.h.

References refCount.

◆ replace()

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

Replace references.

Reimplemented in Line, and Sequence.

Definition at line 256 of file Object.cpp.

References Object().

Here is the call graph for this function:

◆ setDirty()

void Object::setDirty ( bool dirty)
inherited

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

Definition at line 281 of file Object.cpp.

References modified.

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

Here is the caller graph for this function:

◆ setElement()

void Element::setElement ( ElementBase * base)
inlineinherited

Assign new CLASSIC element.

Definition at line 126 of file Element.h.

References itsClassicElement.

Referenced by Line::Line(), Line::Line(), OpalCavity::OpalCavity(), OpalCavity::OpalCavity(), OpalDrift::OpalDrift(), OpalDrift::OpalDrift(), OpalOffset::OpalLocalCartesianOffset::OpalLocalCartesianOffset(), OpalOffset::OpalLocalCartesianOffset::OpalLocalCartesianOffset(), OpalMarker::OpalMarker(), OpalMarker::OpalMarker(), OpalMonitor::OpalMonitor(), OpalMonitor::OpalMonitor(), OpalMultipole::OpalMultipole(), OpalMultipole::OpalMultipole(), OpalMultipoleT::OpalMultipoleT(), OpalMultipoleT::OpalMultipoleT(), OpalProbe::OpalProbe(), OpalProbe::OpalProbe(), OpalRingDefinition::OpalRingDefinition(), OpalRingDefinition::OpalRingDefinition(), OpalSolenoid::OpalSolenoid(), OpalSolenoid::OpalSolenoid(), OpalTravelingWave::OpalTravelingWave(), OpalTravelingWave::OpalTravelingWave(), OpalVacuum::OpalVacuum(), OpalVacuum::OpalVacuum(), OpalVerticalFFAMagnet::OpalVerticalFFAMagnet(), OpalVerticalFFAMagnet::OpalVerticalFFAMagnet(), Sequence::Sequence(), Sequence::Sequence(), OpalMultipoleT::update(), OpalOffset::OpalGlobalCartesianOffset::update(), OpalOffset::OpalGlobalCylindricalOffset::update(), and OpalOffset::OpalLocalCylindricalOffset::update().

Here is the caller graph for this function:

◆ setFlag()

void Object::setFlag ( bool flag)
inherited

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

Definition at line 292 of file Object.cpp.

References flagged.

◆ setOpalName()

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

Set object name.

Definition at line 329 of file Object.cpp.

References itsName.

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

Here is the caller graph for this function:

◆ setParent()

void Object::setParent ( Object * parent)
inherited

Set parent object.

Definition at line 334 of file Object.cpp.

References itsParent, and Object().

Referenced by OpalData::erase().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ setShared()

void Element::setShared ( bool flag)
virtualinherited

Set shared flag.

Reimplemented from Object.

Definition at line 101 of file Element.cpp.

References itsClassicElement, and Object::setShared().

Here is the call graph for this function:

◆ shouldTrace()

bool Element::shouldTrace ( ) const
virtualinherited

Trace flag.

Implements Object.

Definition at line 61 of file Element.cpp.

◆ shouldUpdate()

bool Element::shouldUpdate ( ) const
virtualinherited

Update flag.

Implements Object.

Definition at line 66 of file Element.cpp.

◆ unregisterReference()

void Object::unregisterReference ( Invalidator * a)
inherited

Unegister a reference to this object.

Definition at line 185 of file Object.cpp.

References references.

◆ update()

void OpalElement::update ( )
virtual

Update the embedded CLASSIC element.

Reimplemented from Object.

Reimplemented in OpalCavity, OpalDrift, OpalMarker, OpalMonitor, OpalMultipole, OpalMultipoleT, OpalOffset::OpalGlobalCartesianOffset, OpalOffset::OpalGlobalCylindricalOffset, OpalOffset::OpalLocalCartesianOffset, OpalOffset::OpalLocalCylindricalOffset, OpalProbe, OpalRingDefinition, OpalSolenoid, OpalSource, OpalTravelingWave, OpalVacuum, and OpalVerticalFFAMagnet.

Definition at line 471 of file OpalElement.cpp.

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

Referenced by OpalCavity::update(), OpalDrift::update(), OpalMonitor::update(), OpalMultipole::update(), OpalMultipoleT::update(), OpalProbe::update(), OpalRingDefinition::update(), OpalSolenoid::update(), OpalTravelingWave::update(), and OpalVacuum::update().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ updateUnknown()

void OpalElement::updateUnknown ( ElementBase * base)
virtual

Transmit the ``unknown'' (not known to OPAL) attributes to CLASSIC.

Definition at line 565 of file OpalElement.cpp.

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

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

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ builtin

bool Object::builtin
protectedinherited

Built-in flag.

Definition at line 233 of file Object.h.

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

◆ flagged

bool Object::flagged
protectedinherited

Object flag.

Definition at line 242 of file Object.h.

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

◆ itsAttr

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

The object attributes.

Definition at line 216 of file Object.h.

Referenced by Beam::Beam(), BoolConstant::BoolConstant(), BoundaryGeometry::BoundaryGeometry(), BoundaryGeometry::BoundaryGeometry(), DumpEMFields::buildGrid(), DumpFields::buildGrid(), Call::Call(), copyAttributes(), Distribution::Distribution(), DumpEMFields::DumpEMFields(), DumpFields::DumpFields(), Echo::Echo(), Beam::execute(), Call::execute(), Echo::execute(), Help::execute(), Option::execute(), PSystem::execute(), Select::execute(), System::execute(), Title::execute(), TrackCmd::execute(), TrackRun::execute(), Value::execute(), FieldSolverCmd::FieldSolverCmd(), findAttribute(), findAttribute(), BoundaryGeometry::getA(), OpalElement::getApert(), BoundaryGeometry::getB(), BoolConstant::getBool(), FieldSolverCmd::getBoxIncr(), BoundaryGeometry::getC(), Beam::getCharge(), Beam::getCurrent(), FieldSolverCmd::getDomDec(), TrackCmd::getDT(), TrackCmd::getDTAU(), TrackCmd::getDTSCINIT(), BoundaryGeometry::getFilename(), Beam::getFrequency(), BoundaryGeometry::getL1(), BoundaryGeometry::getL2(), BoundaryGeometry::getLength(), Line::getLength(), OpalElement::getLength(), Sequence::getLength(), Beam::getMass(), TrackCmd::getMaxSteps(), Beam::getNumberOfParticles(), FieldSolverCmd::getNX(), FieldSolverCmd::getNY(), FieldSolverCmd::getNZ(), Beam::getParticleName(), RealConstant::getReal(), RealVariable::getReal(), RealVector::getRealComponent(), Sequence::getReference(), BoundaryGeometry::getS(), TrackCmd::getStepsPerTurn(), StringConstant::getString(), TrackCmd::getT0(), TrackCmd::getTimeIntegrator(), BoundaryGeometry::getTopology(), FieldSolverCmd::getType(), TrackCmd::getZStart(), TrackCmd::getZStop(), Help::Help(), BoundaryGeometry::initialize(), OpalFilter::initOpalFilter(), Line::Line(), Object(), Object(), OpalCavity::OpalCavity(), OpalDrift::OpalDrift(), OpalElement::OpalElement(), OpalFilter::OpalFilter(), OpalOffset::OpalGlobalCartesianOffset::OpalGlobalCartesianOffset(), OpalOffset::OpalGlobalCylindricalOffset::OpalGlobalCylindricalOffset(), OpalOffset::OpalLocalCartesianOffset::OpalLocalCartesianOffset(), OpalOffset::OpalLocalCylindricalOffset::OpalLocalCylindricalOffset(), OpalMultipole::OpalMultipole(), OpalMultipoleT::OpalMultipoleT(), OpalProbe::OpalProbe(), OpalRingDefinition::OpalRingDefinition(), OpalSolenoid::OpalSolenoid(), OpalTravelingWave::OpalTravelingWave(), OpalVacuum::OpalVacuum(), OpalVerticalFFAMagnet::OpalVerticalFFAMagnet(), Option::Option(), Option::Option(), Line::parse(), Sequence::parse(), DumpEMFields::parseCoordinateSystem(), Beam::print(), BoolConstant::print(), DumpEMFields::print(), DumpFields::print(), print(), OpalFilter::print(), RealConstant::print(), RealVariable::print(), RealVector::print(), Sequence::print(), StringConstant::print(), TrackRun::print(), 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(), registerOwnership(), OpalElement::registerOwnership(), Select::Select(), Select::select(), Sequence::Sequence(), Distribution::setDistParametersFlatTop(), Distribution::setDistParametersMultiVariateGauss(), Distribution::setDistType(), FieldSolverCmd::setNX(), FieldSolverCmd::setNY(), FieldSolverCmd::setNZ(), TrackRun::setRunMethod(), Distribution::setSigmaP_m(), Distribution::setSigmaR_m(), TrackRun::setupBoundaryGeometry(), StringConstant::StringConstant(), StringConstant::StringConstant(), System::System(), Title::Title(), TrackCmd::TrackCmd(), TrackRun::TrackRun(), Beam::update(), FieldSolverCmd::update(), OpalCavity::update(), OpalDrift::update(), OpalElement::update(), OpalMonitor::update(), OpalMultipole::update(), OpalMultipoleT::update(), OpalOffset::OpalGlobalCartesianOffset::update(), OpalOffset::OpalGlobalCylindricalOffset::update(), OpalOffset::OpalLocalCartesianOffset::update(), OpalOffset::OpalLocalCylindricalOffset::update(), OpalProbe::update(), OpalRingDefinition::update(), OpalSolenoid::update(), OpalTravelingWave::update(), OpalVacuum::update(), OpalVerticalFFAMagnet::update(), Option::update(), OpalElement::updateUnknown(), Value::Value(), ValueDefinition::value(), and ValueDefinition::value().

◆ itsClassicElement

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

Definition at line 114 of file Element.h.

Referenced by getElement(), setElement(), and setShared().

◆ itsHelp

std::string Object::itsHelp
privateinherited

Definition at line 258 of file Object.h.

Referenced by Object(), Object(), and printHelp().

◆ itsName

std::string Object::itsName
privateinherited

Definition at line 255 of file Object.h.

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

◆ itsParent

Object* Object::itsParent
privateinherited

Definition at line 252 of file Object.h.

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

◆ itsSize

int OpalElement::itsSize
private

Definition at line 139 of file OpalElement.h.

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

◆ modified

bool Object::modified
protectedinherited

Dirty flag.

Definition at line 238 of file Object.h.

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

◆ occurrence

int Object::occurrence
privateinherited

Definition at line 261 of file Object.h.

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

◆ refCount

int RCObject::refCount
mutableprivateinherited

Definition at line 76 of file RCObject.h.

Referenced by addReference(), isShared(), RCObject(), RCObject(), and removeReference().

◆ references

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

Definition at line 268 of file Object.h.

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

◆ sharedFlag

bool Object::sharedFlag
privateinherited

Definition at line 271 of file Object.h.

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

◆ timeStamp

double Object::timeStamp
privateinherited

Definition at line 264 of file Object.h.

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