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

#include <RealVariable.h>

Inheritance diagram for RealVariable:
Inheritance graph
Collaboration diagram for RealVariable:
Collaboration graph

Public Member Functions

 RealVariable ()
 Exemplar constructor. More...
 
 RealVariable (const std::string &name, RealVariable *parent, double value)
 Constructor for built-in variables. More...
 
virtual ~RealVariable ()
 
virtual bool canReplaceBy (Object *rhs)
 Test for allowed replacement. More...
 
virtual RealVariable * clone (const std::string &name)
 Make clone. More...
 
virtual void print (std::ostream &) const
 Print the variable. More...
 
virtual void printValue (std::ostream &os) const
 Print its value. More...
 
virtual double getReal () const
 Return value. More...
 
virtual const std::string getCategory () const
 Return the object category as a string. More...
 
virtual bool shouldTrace () const
 Trace flag. More...
 
virtual bool shouldUpdate () const
 Update flag. More...
 
virtual bool getBool () const
 Return logical value. More...
 
virtual bool getBoolComponent (int) const
 Return indexed logical value. More...
 
virtual double getRealComponent (int) const
 Return indexed real value. More...
 
virtual std::string getString () const
 Return string value. More...
 
virtual std::string getStringComponent (int) const
 Return indexed string value. More...
 
Attribute & value ()
 Return the attribute representing the value of the definition. More...
 
const Attribute & value () const
 Return the attribute representing the value of the definition. More...
 
void copyAttributes (const Object &)
 Copy attributes from another object. More...
 
virtual void execute ()
 Execute the command. More...
 
virtual Attribute * findAttribute (const std::string &name)
 Find an attribute by name. More...
 
virtual const Attribute * findAttribute (const std::string &name) const
 Find an attribute by name. More...
 
virtual Object * makeTemplate (const std::string &, TokenStream &, Statement &)
 Macro handler function. More...
 
virtual Object * makeInstance (const std::string &name, Statement &, const Parser *)
 Macro handler function. More...
 
virtual void parse (Statement &)
 Parse the object. More...
 
virtual void parseShortcut (Statement &, bool eval=true)
 Parser for single-attribute commands. More...
 
virtual void printHelp (std::ostream &) const
 Print help. More...
 
virtual void replace (Object *oldObject, Object *newObject)
 Replace references. More...
 
virtual void update ()
 Update this object. More...
 
bool isBuiltin () const
 True, if [b]this[/b] is a built-in object. More...
 
virtual bool isShared () const
 Shared flag. More...
 
virtual void setShared (bool)
 Set/reset shared flag. More...
 
void setDirty (bool)
 Set/reset the [b]modified[/b] flag. More...
 
bool isDirty () const
 True, if the [b]modified[/b] flag is set. More...
 
void setFlag (bool)
 Flag/unflag this object, e. g. to control output of objects for. More...
 
bool isFlagged () const
 True, if [b]this[/b] is flagged by setFlag(true). More...
 
const Object * getBaseObject () const
 Return the object's base type object. More...
 
const std::string & getOpalName () const
 Return object name. More...
 
Object * getParent () const
 Return parent pointer. More...
 
bool isTreeMember (const Object *subTree) const
 Test for tree membership. More...
 
void setOpalName (const std::string &name)
 Set object name. More...
 
void setParent (Object *)
 Set parent object. More...
 
void clear ()
 Clear the occurrence counter. More...
 
int increment ()
 Increment and return the occurrence counter. More...
 
int occurrenceCount ()
 Return the occurrence counter. More...
 
void registerReference (Invalidator *a)
 Register a reference to this object. More...
 
void unregisterReference (Invalidator *a)
 Unegister a reference to this object. More...
 
void registerOwnership (const AttributeHandler::OwnerType &itsClass) const
 
int addReference () const
 Increment reference count. More...
 
int removeReference () const
 Decrement the reference count. More...
 

Public Attributes

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

Protected Attributes

const std::string itsPrefix
 The declaration prefix. More...
 
bool builtin
 Built-in flag. More...
 
bool modified
 Dirty flag. More...
 
bool flagged
 Object flag. More...
 

Private Member Functions

 RealVariable (const RealVariable &)
 
void operator= (const RealVariable &)
 
 RealVariable (const std::string &name, RealVariable *parent)
 

Private Attributes

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 24 of file RealVariable.h.

Constructor & Destructor Documentation

◆ RealVariable() [1/4]

RealVariable::RealVariable ( )

Exemplar constructor.

Definition at line 26 of file RealVariable.cpp.

References OpalData::create(), OpalData::getInstance(), Object::itsAttr, Attributes::makeReal(), RealVariable(), Object::registerOwnership(), Object::setDirty(), OpalData::setP0(), and AttributeHandler::STATEMENT.

Referenced by clone(), and RealVariable().

Here is the call graph for this function:

◆ RealVariable() [2/4]

RealVariable::RealVariable ( const std::string &  name,
RealVariable *  parent,
double  value 
)

Constructor for built-in variables.

Definition at line 43 of file RealVariable.cpp.

References Object::itsAttr, Attributes::setReal(), and ValueDefinition::value().

Here is the call graph for this function:

◆ ~RealVariable()

RealVariable::~RealVariable ( )
virtual

Definition at line 55 of file RealVariable.cpp.

◆ RealVariable() [3/4]

RealVariable::RealVariable ( const RealVariable &  )
private

◆ RealVariable() [4/4]

RealVariable::RealVariable ( const std::string &  name,
RealVariable *  parent 
)
private

Definition at line 50 of file RealVariable.cpp.

Member Function Documentation

◆ addReference()

int RCObject::addReference ( ) const
inlineinherited

Increment reference count.

Definition at line 83 of file RCObject.h.

References RCObject::refCount.

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

◆ canReplaceBy()

bool RealVariable::canReplaceBy ( Object *  rhs)
virtual

Test for allowed replacement.

Reimplemented from Object.

Definition at line 59 of file RealVariable.cpp.

◆ clear()

void Object::clear ( )
inherited

Clear the occurrence counter.

Definition at line 341 of file Object.cpp.

References Object::occurrence.

Referenced by FieldSolver::initSolver().

◆ clone()

RealVariable * RealVariable::clone ( const std::string &  name)
virtual

Make clone.

Implements Object.

Definition at line 65 of file RealVariable.cpp.

References name, and RealVariable().

Here is the call 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 Object::itsAttr.

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

◆ execute()

void Object::execute ( )
virtualinherited

Execute the command.

Reimplemented in Call, DumpEMFields, DumpFields, Echo, Help, Option, PSystem, Quit, Select, Stop, System, Title, Value, OpalTrimCoil, Distribution, MacroCmd, Constraint, DVar, Objective, OptimizeCmd, OpalSample, SampleCmd, Beam, BoundaryGeometry, FieldSolver, OpalWake, ParticleMatterInteraction, List, TrackCmd, TrackEnd, TrackRun, and OpalFilter.

Definition at line 59 of file Object.cpp.

◆ 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 Object::itsAttr, and name.

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

◆ findAttribute() [2/2]

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

Find an attribute by name.

Definition at line 74 of file Object.cpp.

References Object::itsAttr, and name.

◆ getBaseObject()

const Object * Object::getBaseObject ( ) const
inherited

Return the object's base type object.

Definition at line 303 of file Object.cpp.

References Object::itsParent.

◆ getBool()

bool ValueDefinition::getBool ( ) const
virtualinherited

Return logical value.

Reimplemented in BoolConstant.

Definition at line 47 of file ValueDefinition.cpp.

References Object::getOpalName().

Here is the call graph for this function:

◆ getBoolComponent()

bool ValueDefinition::getBoolComponent ( int  ) const
virtualinherited

Return indexed logical value.

Definition at line 54 of file ValueDefinition.cpp.

References Object::getOpalName().

Here is the call graph for this function:

◆ getCategory()

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

Return the object category as a string.

Implements Object.

Definition at line 32 of file ValueDefinition.cpp.

◆ getOpalName()

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

Return object name.

Definition at line 310 of file Object.cpp.

References Object::itsName.

Referenced by OpalOffset::OpalLocalCartesianOffset::clone(), OpalVariableRFCavity::clone(), OpalVariableRFCavityFringeField::clone(), Macro::clone(), OpalData::create(), OpalData::define(), ParallelCyclotronTracker::execute(), Sequence::findDriftLength(), SequenceParser::findNeighbourPositions(), ValueDefinition::getBool(), ValueDefinition::getBoolComponent(), ValueDefinition::getReal(), ValueDefinition::getRealComponent(), ValueDefinition::getString(), ValueDefinition::getStringComponent(), ParticleMatterInteraction::initParticleMatterInteractionHandler(), OpalWake::initWakefunction(), List::list(), Object::makeInstance(), SequenceTemplate::makeInstance(), LineTemplate::makeInstance(), Object::parse(), SequenceParser::parseMember(), SequenceParser::parsePosition(), OpalTrimCoil::print(), Object::print(), OpalElement::print(), Sequence::print(), BoolConstant::print(), RealConstant::print(), print(), RealVector::print(), StringConstant::print(), Beam::print(), OpalWake::print(), ParticleMatterInteraction::print(), OpalFilter::print(), Line::print(), BoundaryGeometry::printInfo(), FieldSolver::printInfo(), OpalElement::registerOwnership(), Object::registerOwnership(), Line::replace(), Sequence::replace(), OpalScalingFFAMagnet::setupDefaultEndField(), OpalTrimCoil::update(), OpalAsymmetricEnge::update(), OpalCavity::update(), OpalDrift::update(), OpalECollimator::update(), OpalEnge::update(), OpalFlexibleCollimator::update(), OpalOffset::OpalGlobalCartesianOffset::update(), OpalOffset::OpalGlobalCylindricalOffset::update(), OpalOffset::OpalLocalCartesianOffset::update(), OpalOffset::OpalLocalCylindricalOffset::update(), OpalPepperPot::update(), OpalPolynomialTimeDependence::update(), OpalProbe::update(), OpalRBend::update(), OpalRBend3D::update(), OpalRCollimator::update(), OpalSBend::update(), OpalSeptum::update(), OpalSlit::update(), OpalTravelingWave::update(), Beam::update(), BoundaryGeometry::update(), OpalWake::update(), ParticleMatterInteraction::update(), OpalFilter::update(), OpalSinusoidalTimeDependence::update(), OpalSplineTimeDependence::update(), and Distribution::writeOutFileHeader().

◆ getParent()

Object * Object::getParent ( ) const
inherited

Return parent pointer.

Definition at line 315 of file Object.cpp.

References Object::itsParent.

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

◆ getReal()

double RealVariable::getReal ( ) const
virtual

Return value.

Reimplemented from ValueDefinition.

Definition at line 70 of file RealVariable.cpp.

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

Referenced by OpalData::getVariableData(), and ParallelTTracker::setOptionalVariables().

Here is the call graph for this function:

◆ getRealComponent()

double ValueDefinition::getRealComponent ( int  ) const
virtualinherited

Return indexed real value.

Reimplemented in RealVector.

Definition at line 68 of file ValueDefinition.cpp.

References Object::getOpalName().

Here is the call graph for this function:

◆ getString()

std::string ValueDefinition::getString ( ) const
virtualinherited

Return string value.

Reimplemented in StringConstant.

Definition at line 75 of file ValueDefinition.cpp.

References Object::getOpalName().

Here is the call graph for this function:

◆ getStringComponent()

std::string ValueDefinition::getStringComponent ( int  ) const
virtualinherited

Return indexed string value.

Definition at line 82 of file ValueDefinition.cpp.

References Object::getOpalName().

Here is the call graph for this function:

◆ increment()

int Object::increment ( )
inherited

Increment and return the occurrence counter.

Definition at line 346 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 268 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 289 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 299 of file Object.cpp.

References Object::flagged.

◆ isShared()

bool Object::isShared ( ) const
virtualinherited

Shared flag.

Definition at line 273 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 320 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 91 of file Object.cpp.

References Object::getOpalName().

Referenced by OpalParser::parseDefine(), Line::parseList(), OpalParser::parseMacro(), and SequenceParser::parseMember().

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 84 of file Object.cpp.

References name.

Referenced by OpalParser::parseMacro().

◆ occurrenceCount()

int Object::occurrenceCount ( )
inherited

Return the occurrence counter.

Definition at line 351 of file Object.cpp.

References Object::occurrence.

◆ operator=()

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

◆ parse()

void Object::parse ( Statement &  stat)
virtualinherited

Parse the object.

Reimplemented in Call, Echo, Help, PSystem, System, Title, Value, OpalElement, Sequence, and Line.

Definition at line 97 of file Object.cpp.

References Statement::delimiter(), Object::findAttribute(), Object::getOpalName(), name, Expressions::parseDelimiter(), Expressions::parseRealConst(), and Expressions::parseString().

Referenced by Sequence::parse(), OpalParser::parseAction(), OpalParser::parseDefine(), and SequenceTemplate::parseTemplate().

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 129 of file Object.cpp.

References Statement::delimiter(), Object::findAttribute(), Statement::mark(), name, 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:

◆ print()

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

Print the variable.

Reimplemented from Object.

Definition at line 75 of file RealVariable.cpp.

References endl(), Object::getOpalName(), and Object::itsAttr.

Here is the call graph for this function:

◆ printHelp()

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

Print help.

Definition at line 201 of file Object.cpp.

References endl(), gmsg, Object::itsAttr, Object::itsHelp, max(), and name.

Referenced by Help::execute().

Here is the call graph for this function:

◆ printValue()

void RealVariable::printValue ( std::ostream &  os) const
virtual

Print its value.

Reimplemented from Object.

Definition at line 81 of file RealVariable.cpp.

References Object::itsAttr.

◆ registerOwnership()

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

Definition at line 191 of file Object.cpp.

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

Referenced by Beam::Beam(), BoolConstant::BoolConstant(), BoundaryGeometry::BoundaryGeometry(), Call::Call(), Constraint::Constraint(), DumpEMFields::DumpEMFields(), DumpFields::DumpFields(), DVar::DVar(), Echo::Echo(), FieldSolver::FieldSolver(), Help::Help(), Line::Line(), List::List(), Objective::Objective(), OpalFilter::OpalFilter(), OpalSample::OpalSample(), OpalTrimCoil::OpalTrimCoil(), OpalWake::OpalWake(), OptimizeCmd::OptimizeCmd(), Option::Option(), ParticleMatterInteraction::ParticleMatterInteraction(), PSystem::PSystem(), RealConstant::RealConstant(), RealVariable(), RealVector::RealVector(), SampleCmd::SampleCmd(), Select::Select(), Sequence::Sequence(), Distribution::setAttributes(), 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 182 of file Object.cpp.

References Hypervolume::ref, and Object::references.

◆ removeReference()

int RCObject::removeReference ( ) const
inlineinherited

Decrement the reference count.

Definition at line 88 of file RCObject.h.

References RCObject::refCount.

◆ replace()

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

Replace references.

Reimplemented in Line, and Sequence.

Definition at line 258 of file Object.cpp.

◆ setDirty()

void Object::setDirty ( bool  dirty)
inherited

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

Definition at line 283 of file Object.cpp.

References Object::modified.

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

◆ setFlag()

void Object::setFlag ( bool  flag)
inherited

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

Definition at line 294 of file Object.cpp.

References Object::flagged.

◆ setOpalName()

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

Set object name.

Definition at line 331 of file Object.cpp.

References Object::itsName, and name.

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

◆ setParent()

void Object::setParent ( Object *  parent)
inherited

Set parent object.

Definition at line 336 of file Object.cpp.

References Object::itsParent.

Referenced by OpalData::erase().

◆ setShared()

void Object::setShared ( bool  flag)
virtualinherited

Set/reset shared flag.

Reimplemented in Element.

Definition at line 278 of file Object.cpp.

References Object::sharedFlag.

Referenced by OpalParser::parseDefine(), and Element::setShared().

◆ shouldTrace()

bool ValueDefinition::shouldTrace ( ) const
virtualinherited

Trace flag.

Implements Object.

Definition at line 37 of file ValueDefinition.cpp.

◆ shouldUpdate()

bool ValueDefinition::shouldUpdate ( ) const
virtualinherited

Update flag.

Implements Object.

Definition at line 42 of file ValueDefinition.cpp.

◆ unregisterReference()

void Object::unregisterReference ( Invalidator *  a)
inherited

Unegister a reference to this object.

Definition at line 187 of file Object.cpp.

References Hypervolume::ref, and Object::references.

◆ update()

void Object::update ( )
virtualinherited

Update this object.

Reimplemented in Option, OpalTrimCoil, Distribution, OpalAsymmetricEnge, OpalCavity, OpalCCollimator, OpalCyclotron, OpalDegrader, OpalDrift, OpalECollimator, OpalElement, OpalEnge, OpalFlexibleCollimator, OpalHKicker, OpalKicker, OpalMarker, OpalMonitor, OpalMultipole, OpalOctupole, OpalOffset::OpalGlobalCartesianOffset, OpalOffset::OpalGlobalCylindricalOffset, OpalOffset::OpalLocalCartesianOffset, OpalOffset::OpalLocalCylindricalOffset, OpalOutputPlane, OpalPepperPot, OpalPolynomialTimeDependence, OpalProbe, OpalQuadrupole, OpalRBend, OpalRBend3D, OpalRCollimator, OpalRingDefinition, OpalSBend, OpalSBend3D, OpalScalingFFAMagnet, OpalSeptum, OpalSextupole, OpalSlit, OpalSolenoid, OpalSource, OpalStripper, OpalTravelingWave, OpalUndulator, OpalVacuum, OpalVariableRFCavity, OpalVariableRFCavityFringeField, OpalVerticalFFAMagnet, OpalVKicker, Sequence, Beam, BoundaryGeometry, FieldSolver, OpalWake, ParticleMatterInteraction, OpalFilter, OpalMultipoleT, OpalSinusoidalTimeDependence, and OpalSplineTimeDependence.

Definition at line 263 of file Object.cpp.

Referenced by PyOpal::PyDistributionNS::registerDistribution().

◆ value() [1/2]

Attribute & ValueDefinition::value ( )
inherited

Return the attribute representing the value of the definition.

Definition at line 89 of file ValueDefinition.cpp.

References Object::itsAttr.

Referenced by RealConstant::RealConstant(), RealVariable(), and StringConstant::StringConstant().

◆ value() [2/2]

const Attribute & ValueDefinition::value ( ) const
inherited

Return the attribute representing the value of the definition.

Definition at line 94 of file ValueDefinition.cpp.

References Object::itsAttr.

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(), Distribution::Distribution(), Object::isBuiltin(), Object::Object(), OpalFilter::OpalFilter(), OpalMarker::OpalMarker(), OpalTrimCoil::OpalTrimCoil(), OpalWake::OpalWake(), ParticleMatterInteraction::ParticleMatterInteraction(), RealConstant::RealConstant(), StringConstant::StringConstant(), and Table::~Table().

◆ flagged

bool Object::flagged
protectedinherited

Object flag.

Definition at line 242 of file Object.h.

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

◆ itsAttr

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

The object attributes.

Definition at line 216 of file Object.h.

Referenced by Distribution::adjustPhaseSpace(), Beam::Beam(), BoolConstant::BoolConstant(), BoundaryGeometry::BoundaryGeometry(), DumpEMFields::buildGrid(), DumpFields::buildGrid(), Distribution::calcPartPerDist(), Call::Call(), Distribution::checkEmissionParameters(), Distribution::checkIfEmitted(), Distribution::chooseInputMomentumUnits(), Constraint::Constraint(), Object::copyAttributes(), Distribution::create(), Distribution::createDistributionFromFile(), Distribution::createDistributionMultiGauss(), Distribution::createMatchedGaussDistribution(), Distribution::createOpalT(), DumpEMFields::DumpEMFields(), DumpFields::DumpFields(), DVar::DVar(), Echo::Echo(), Call::execute(), Echo::execute(), Help::execute(), Option::execute(), PSystem::execute(), Select::execute(), System::execute(), Title::execute(), Value::execute(), OptimizeCmd::execute(), SampleCmd::execute(), Beam::execute(), List::execute(), TrackCmd::execute(), TrackRun::execute(), FieldSolver::FieldSolver(), Object::findAttribute(), Distribution::generateAstraFlattopT(), Distribution::generateBinomial(), Distribution::generateFlattopLaserProfile(), Distribution::generateFlattopT(), Distribution::generateFlattopZ(), Distribution::generateGaussZ(), Distribution::generateLongFlattopT(), Distribution::generateMatchedGauss(), Distribution::generateTransverseGauss(), BoundaryGeometry::getA(), OpalElement::getApert(), BoundaryGeometry::getB(), BoolConstant::getBool(), BoundaryGeometry::getC(), Beam::getCharge(), Beam::getCurrent(), TrackCmd::getDT(), TrackCmd::getDTAU(), TrackCmd::getDTSCINIT(), Distribution::getEmissionTimeShift(), Constraint::getExpression(), Objective::getExpression(), BoundaryGeometry::getFilename(), Beam::getFrequency(), ParticleMatterInteraction::getInteractionType(), BoundaryGeometry::getL1(), BoundaryGeometry::getL2(), BoundaryGeometry::getLength(), OpalElement::getLength(), Line::getLength(), Sequence::getLength(), DVar::getLowerBound(), Beam::getMass(), TrackCmd::getMaxSteps(), FieldSolver::getMT(), FieldSolver::getMX(), FieldSolver::getMY(), OpalWake::getNumberOfBins(), Beam::getNumberOfParticles(), Distribution::getNumberOfParticlesInFile(), Beam::getParticleName(), RealConstant::getReal(), getReal(), RealVector::getRealComponent(), Sequence::getReference(), BoundaryGeometry::getS(), TrackCmd::getStepsPerTurn(), StringConstant::getString(), TrackCmd::getT0(), FieldSolver::getTagging_m(), Distribution::getTEmission(), TrackCmd::getTimeIntegrator(), BoundaryGeometry::getTopology(), OpalTrimCoil::getTrimCoilType(), FieldSolver::getType(), DVar::getUpperBound(), DVar::getVariable(), OpalSample::getVariable(), Distribution::getWeight(), TrackCmd::getZStart(), TrackCmd::getZStop(), FieldSolver::hasPeriodicZ(), Help::Help(), FieldSolver::initAmrObject_m(), FieldSolver::initAmrSolver_m(), FieldSolver::initCartesianFields(), BoundaryGeometry::initialize(), OpalSample::initialize(), OpalFilter::initOpalFilter(), OpalTrimCoil::initOpalTrimCoil(), ParticleMatterInteraction::initParticleMatterInteractionHandler(), FieldSolver::initSolver(), OpalWake::initWakefunction(), Distribution::injectBeam(), Line::Line(), List::List(), List::list(), Objective::Objective(), OpalAsymmetricEnge::OpalAsymmetricEnge(), OpalBend::OpalBend(), OpalCavity::OpalCavity(), OpalCCollimator::OpalCCollimator(), OpalCyclotron::OpalCyclotron(), OpalDegrader::OpalDegrader(), OpalDrift::OpalDrift(), OpalECollimator::OpalECollimator(), OpalElement::OpalElement(), OpalEnge::OpalEnge(), OpalFilter::OpalFilter(), OpalFlexibleCollimator::OpalFlexibleCollimator(), OpalOffset::OpalGlobalCartesianOffset::OpalGlobalCartesianOffset(), OpalOffset::OpalGlobalCylindricalOffset::OpalGlobalCylindricalOffset(), OpalHKicker::OpalHKicker(), OpalKicker::OpalKicker(), OpalOffset::OpalLocalCartesianOffset::OpalLocalCartesianOffset(), OpalOffset::OpalLocalCylindricalOffset::OpalLocalCylindricalOffset(), OpalMultipole::OpalMultipole(), OpalMultipoleT::OpalMultipoleT(), OpalOctupole::OpalOctupole(), OpalOutputPlane::OpalOutputPlane(), OpalPepperPot::OpalPepperPot(), OpalPolynomialTimeDependence::OpalPolynomialTimeDependence(), OpalProbe::OpalProbe(), OpalQuadrupole::OpalQuadrupole(), OpalRBend3D::OpalRBend3D(), OpalRCollimator::OpalRCollimator(), OpalRingDefinition::OpalRingDefinition(), OpalSample::OpalSample(), OpalSBend3D::OpalSBend3D(), OpalScalingFFAMagnet::OpalScalingFFAMagnet(), OpalSeptum::OpalSeptum(), OpalSextupole::OpalSextupole(), OpalSinusoidalTimeDependence::OpalSinusoidalTimeDependence(), OpalSlit::OpalSlit(), OpalSolenoid::OpalSolenoid(), OpalSource::OpalSource(), OpalSplineTimeDependence::OpalSplineTimeDependence(), OpalStripper::OpalStripper(), OpalTravelingWave::OpalTravelingWave(), OpalTrimCoil::OpalTrimCoil(), OpalUndulator::OpalUndulator(), OpalVacuum::OpalVacuum(), OpalVariableRFCavity::OpalVariableRFCavity(), OpalVariableRFCavityFringeField::OpalVariableRFCavityFringeField(), OpalVerticalFFAMagnet::OpalVerticalFFAMagnet(), OpalVKicker::OpalVKicker(), OpalWake::OpalWake(), OptimizeCmd::OptimizeCmd(), Option::Option(), Sequence::parse(), Line::parse(), DumpEMFields::parseCoordinateSystem(), ParticleMatterInteraction::ParticleMatterInteraction(), OpalTrimCoil::print(), TrackRun::print(), Object::print(), Sequence::print(), BoolConstant::print(), RealConstant::print(), print(), RealVector::print(), StringConstant::print(), DumpEMFields::print(), DumpFields::print(), Beam::print(), OpalWake::print(), ParticleMatterInteraction::print(), OpalFilter::print(), Distribution::printDistFlattop(), Distribution::printDistFromFile(), Distribution::printDistGauss(), Distribution::printEmissionModelAstra(), Distribution::printEmissionModelNone(), Object::printHelp(), Distribution::printInfo(), BoundaryGeometry::printInfo(), FieldSolver::printInfo(), BoolConstant::printValue(), RealConstant::printValue(), printValue(), RealVector::printValue(), StringConstant::printValue(), PSystem::PSystem(), RealConstant::RealConstant(), RealVariable(), RealVector::RealVector(), OpalElement::registerOwnership(), Object::registerOwnership(), OptimizeCmd::run(), SampleCmd::SampleCmd(), Distribution::scaleDistCoordinates(), Select::Select(), Select::select(), Sequence::Sequence(), Distribution::setAttributes(), TrackRun::setBoundaryGeometry(), Distribution::setDistParametersBinomial(), Distribution::setDistParametersFlattop(), Distribution::setDistParametersGauss(), Distribution::setDistParametersMultiGauss(), TrackRun::setDistributionParallelT(), Distribution::setDistType(), FieldSolver::setMT(), FieldSolver::setMX(), FieldSolver::setMY(), TrackRun::setRunMethod(), Distribution::setSigmaP_m(), Distribution::setSigmaR_m(), TrackRun::setupCyclotronTracker(), OpalScalingFFAMagnet::setupDefaultEndField(), Distribution::setupEmissionModel(), Distribution::setupEmissionModelAstra(), Distribution::setupEmissionModelNone(), Distribution::setupEmissionModelNonEquil(), TrackRun::setupFieldsolver(), OpalScalingFFAMagnet::setupNamedEndField(), Distribution::setupParticleBins(), TrackRun::setupThickTracker(), TrackRun::setupTTracker(), Distribution::shiftDistCoordinates(), StringConstant::StringConstant(), System::System(), Title::Title(), TrackCmd::TrackCmd(), TrackRun::TrackRun(), OpalAsymmetricEnge::update(), OpalCavity::update(), OpalCCollimator::update(), OpalCyclotron::update(), OpalDegrader::update(), OpalDrift::update(), OpalECollimator::update(), OpalElement::update(), OpalEnge::update(), OpalFlexibleCollimator::update(), OpalHKicker::update(), OpalKicker::update(), OpalMonitor::update(), OpalMultipole::update(), OpalOctupole::update(), OpalOffset::OpalGlobalCartesianOffset::update(), OpalOffset::OpalGlobalCylindricalOffset::update(), OpalOffset::OpalLocalCartesianOffset::update(), OpalOffset::OpalLocalCylindricalOffset::update(), OpalOutputPlane::update(), OpalPepperPot::update(), OpalPolynomialTimeDependence::update(), OpalProbe::update(), OpalQuadrupole::update(), OpalRBend::update(), OpalRBend3D::update(), OpalRCollimator::update(), OpalRingDefinition::update(), OpalSBend::update(), OpalSBend3D::update(), OpalScalingFFAMagnet::update(), OpalSeptum::update(), OpalSextupole::update(), OpalSlit::update(), OpalSolenoid::update(), OpalSource::update(), OpalStripper::update(), OpalTravelingWave::update(), OpalUndulator::update(), OpalVacuum::update(), OpalVariableRFCavity::update(), OpalVariableRFCavityFringeField::update(), OpalVerticalFFAMagnet::update(), OpalVKicker::update(), Beam::update(), OpalMultipoleT::update(), OpalSinusoidalTimeDependence::update(), OpalSplineTimeDependence::update(), Option::update(), OpalElement::updateUnknown(), ValueDefinition::value(), Value::Value(), Distribution::writeOutFileEmission(), Distribution::writeOutFileHeader(), and Distribution::writeOutFileInjection().

◆ itsHelp

std::string Object::itsHelp
privateinherited

Definition at line 258 of file Object.h.

Referenced by Object::printHelp().

◆ itsName

std::string Object::itsName
privateinherited

Definition at line 255 of file Object.h.

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

◆ itsParent

Object* Object::itsParent
privateinherited

Definition at line 252 of file Object.h.

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

◆ itsPrefix

const std::string ValueDefinition::itsPrefix
protectedinherited

The declaration prefix.

Definition at line 95 of file ValueDefinition.h.

◆ modified

bool Object::modified
protectedinherited

Dirty flag.

Definition at line 238 of file Object.h.

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

◆ occurrence

int Object::occurrence
privateinherited

Definition at line 261 of file Object.h.

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

◆ refCount

int RCObject::refCount
mutableprivateinherited

Definition at line 76 of file RCObject.h.

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

◆ references

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

Definition at line 268 of file Object.h.

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

◆ sharedFlag

bool Object::sharedFlag
privateinherited

Definition at line 271 of file Object.h.

Referenced by Object::isShared(), and Object::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: