#include <Sequence.h>

Inheritance diagram for Sequence:

Collaboration diagram for Sequence:

Public Types
typedef TBeamline< SequenceMember >	TLine
	The type of a sequence line. More...

enum	ReferenceType { IS_ENTRY , IS_CENTRE , IS_EXIT }
	Reference for element positioning. More...

Public Member Functions
	Sequence ()
	Exemplar constructor. More...

virtual	~Sequence ()

virtual Sequence *	clone (const std::string &name)
	Make clone. More...

virtual Sequence *	copy (const std::string &name)
	Make copy of the sequence line. More...

virtual double	getLength () const
	Return sequence length. More...

virtual double	getEntrance (ReferenceType) const
	Return the arc length from origin to entrance. More...

virtual double	getExit (ReferenceType) const
	Return the arc length from origin to exit. More...

ReferenceType	getReference () const
	Return the reference type flag. More...

virtual Object *	makeTemplate (const std::string &, TokenStream &, Statement &)
	Make a sequence template. More...

virtual void	parse (Statement &)
	Parse sequence. More...

virtual void	print (std::ostream &) const
	Print sequence. More...

virtual void	replace (Object oldObject, Object newObject)
	Replace references to elements. More...

virtual void	update ()
	Update the embedded CLASSIC beam line. More...

virtual TLine *	fetchLine () const
	Return the embedded CLASSIC beam line. More...

void	storeLine (TLine &line)
	Store sequence line. More...

virtual const std::string	getCategory () const
	Return the object category as a string. More...

virtual bool	canReplaceBy (Object *object)
	Test if replacement is allowed. More...

virtual bool	shouldTrace () const
	Trace flag. More...

virtual bool	shouldUpdate () const
	Update flag. More...

virtual void	setShared (bool)
	Set shared flag. More...

ElementBase *	getElement () const
	Return the embedded CLASSIC element. More...

void	setElement (ElementBase *)
	Assign new CLASSIC element. 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 *	makeInstance (const std::string &name, Statement &, const Parser *)
	Macro handler function. More...

virtual void	parseShortcut (Statement &, bool eval=true)
	Parser for single-attribute commands. More...

virtual void	printValue (std::ostream &) const

virtual void	printHelp (std::ostream &) const
	Print help. More...

bool	isBuiltin () const
	True, if [b]this[/b] is a built-in object. More...

virtual bool	isShared () const
	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...

Static Public Member Functions
static BeamSequence *	find (const std::string &name)
	Find a BeamSequence by name. More...

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

Protected Attributes
bool	builtin
	Built-in flag. More...

bool	modified
	Dirty flag. More...

bool	flagged
	Object flag. More...

Private Member Functions
	Sequence (const Sequence &)

void	operator= (const Sequence &)

	Sequence (const std::string &name, Sequence *parent)

void	addEndMarkers (TLine &line) const

double	findDriftLength (TLine::iterator drift) const

TLine::iterator	findNamedPosition (TLine &, const std::string &) const

void	insertDrifts (TLine &line)

Static Private Member Functions
static void	updateList (Sequence , TLine )

Private Attributes
ReferenceType	itsCode

std::string	itsRefPoint

Pointer< ElementBase >	itsClassicElement

Object *	itsParent

std::string	itsName

std::string	itsHelp

int	occurrence

double	timeStamp

std::set< Invalidator * >	references

bool	sharedFlag

int	refCount

Friends
class	Edit

class	SequenceParser

class	SequenceTemplate

Detailed Description

Definition at line 33 of file Sequence.h.

Member Typedef Documentation

◆ TLine

typedef TBeamline<SequenceMember> Sequence::TLine

The type of a sequence line.

Definition at line 42 of file Sequence.h.

Member Enumeration Documentation

◆ ReferenceType

enum Element::ReferenceType

inherited

Reference for element positioning.

Enumerator
IS_ENTRY
IS_CENTRE
IS_EXIT

Definition at line 44 of file Element.h.

Constructor & Destructor Documentation

◆ Sequence() [1/3]

Sequence::Sequence ( )

Exemplar constructor.

Definition at line 52 of file Sequence.cpp.

References Object::itsAttr, Attributes::makeReal(), Attributes::makeString(), Object::registerOwnership(), Element::setElement(), AttributeHandler::STATEMENT, and Attrib::Distribution::TYPE.

Referenced by clone().

Here is the call graph for this function:

◆ ~Sequence()

Sequence::~Sequence ( )

virtual

Definition at line 93 of file Sequence.cpp.

◆ Sequence() [2/3]

Sequence::Sequence ( const Sequence & )

private

◆ Sequence() [3/3]

Sequence::Sequence	(	const std::string &	name,
		Sequence *	parent
	)

private

Definition at line 83 of file Sequence.cpp.

References name, and Element::setElement().

Here is the call graph for this function:

Member Function Documentation

◆ addEndMarkers()

void Sequence::addEndMarkers ( TLine & line ) const

private

Definition at line 312 of file Sequence.cpp.

References SequenceMember::ABSOLUTE, Element::find(), Element::getElement(), getLength(), SequenceMember::GLOBAL, SequenceMember::itsFlag, SequenceMember::itsPosition, SequenceMember::itsType, and ElmPtr::setElement().

Referenced by SequenceParser::parse().

Here is the call graph for this function:

◆ 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 Element::canReplaceBy ( Object * object )

virtualinherited

Test if replacement is allowed.

Reimplemented from Object.

Definition at line 40 of file Element.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()

Sequence * Sequence::clone ( const std::string & name )

virtual

Make clone.

Implements Object.

Definition at line 97 of file Sequence.cpp.

References name, and Sequence().

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

Here is the call graph for this function:

◆ copy()

Sequence * Sequence::copy ( const std::string & name )

virtual

Make copy of the sequence line.

Implements BeamSequence.

Definition at line 102 of file Sequence.cpp.

References ElementBase::clone(), clone(), ElementBase::copyStructure(), fetchLine(), SequenceMember::GENERATED, ElmPtr::getElement(), name, ElmPtr::setElement(), and storeLine().

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.

◆ fetchLine()

Sequence::TLine * Sequence::fetchLine ( ) const

virtual

Return the embedded CLASSIC beam line.

Implements BeamSequence.

Definition at line 278 of file Sequence.cpp.

References Element::getElement().

Referenced by copy(), getEntrance(), getExit(), print(), replace(), storeLine(), and update().

Here is the call graph for this function:

◆ find()

BeamSequence * BeamSequence::find ( const std::string & name )

staticinherited

Find a BeamSequence by name.

Definition at line 36 of file BeamSequence.cpp.

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

Referenced by Distribution::createMatchedGaussDistribution(), and TrackCmd::execute().

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 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.

◆ findDriftLength()

double Sequence::findDriftLength ( TLine::iterator drift ) const

private

Definition at line 325 of file Sequence.cpp.

References abs(), Element::getEntrance(), Element::getExit(), Object::getOpalName(), and itsCode.

Referenced by updateList().

Here is the call graph for this function:

◆ findNamedPosition()

Sequence::TLine::iterator Sequence::findNamedPosition	(	TLine &	line,
		const std::string &	name
	)		const

private

Definition at line 124 of file Sequence.cpp.

References SequenceMember::GENERATED, and name.

Referenced by SequenceParser::findFromPositions(), getEntrance(), and getExit().

◆ 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.

◆ getCategory()

const std::string BeamSequence::getCategory ( ) const

virtualinherited

Return the object category as a string.

Reimplemented from Element.

Definition at line 31 of file BeamSequence.cpp.

◆ getElement()

ElementBase * Element::getElement ( ) const

inlineinherited

Return the embedded CLASSIC element.

Definition at line 120 of file Element.h.

References Element::itsClassicElement.

Referenced by addEndMarkers(), Line::fetchLine(), fetchLine(), OpalMarker::OpalMarker(), OpalOutputPlane::OpalOutputPlane(), OpalVariableRFCavity::OpalVariableRFCavity(), OpalVariableRFCavityFringeField::OpalVariableRFCavityFringeField(), Line::parse(), Line::replace(), replace(), PyOpal::PyLine_< C >::setElement(), OpalScalingFFAMagnet::setupDefaultEndField(), OpalScalingFFAMagnet::setupNamedEndField(), OpalCavity::update(), OpalCCollimator::update(), OpalCyclotron::update(), OpalDegrader::update(), OpalDrift::update(), OpalECollimator::update(), OpalElement::update(), OpalFlexibleCollimator::update(), OpalHKicker::update(), OpalKicker::update(), OpalMarker::update(), OpalMonitor::update(), OpalMultipole::update(), OpalOctupole::update(), OpalOffset::OpalLocalCartesianOffset::update(), OpalOutputPlane::update(), OpalPepperPot::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(), and OpalMultipoleT::update().

◆ getEntrance()

double Sequence::getEntrance ( ReferenceType ref ) const

virtual

Return the arc length from origin to entrance.

Reimplemented from Element.

Definition at line 155 of file Sequence.cpp.

References fetchLine(), findNamedPosition(), Element::getEntrance(), itsRefPoint, and Hypervolume::ref.

Here is the call graph for this function:

◆ getExit()

double Sequence::getExit ( ReferenceType ref ) const

virtual

Return the arc length from origin to exit.

Reimplemented from Element.

Definition at line 166 of file Sequence.cpp.

References fetchLine(), findNamedPosition(), Element::getExit(), getLength(), itsRefPoint, and Hypervolume::ref.

Here is the call graph for this function:

◆ getLength()

double Sequence::getLength ( ) const

virtual

Return sequence length.

Implements Element.

Definition at line 150 of file Sequence.cpp.

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

Referenced by addEndMarkers(), and getExit().

Here is the call graph for this function:

◆ 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(), 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(), print(), BoolConstant::print(), RealConstant::print(), RealVariable::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(), 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().

◆ getReference()

Sequence::ReferenceType Sequence::getReference ( ) const

Return the reference type flag.

Definition at line 177 of file Sequence.cpp.

References Attributes::getString(), Element::IS_CENTRE, Element::IS_ENTRY, Element::IS_EXIT, Object::itsAttr, and Hypervolume::ref.

Referenced by storeLine().

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 storeLine().

◆ insertDrifts()

void Sequence::insertDrifts ( Sequence::TLine & line )

private

Definition at line 368 of file Sequence.cpp.

References SequenceMember::GENERATED, SequenceMember::itsType, ElmPtr::setElement(), and ElementBase::setName().

Referenced by SequenceParser::parse().

Here is the call graph for this function:

◆ 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 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 * Sequence::makeTemplate	(	const std::string &	name,
		TokenStream &	is,
		Statement &	statement
	)

virtual

Make a sequence template.

Reimplemented from Object.

Definition at line 191 of file Sequence.cpp.

References name, SequenceTemplate::parseTemplate(), and SequenceTemplate.

Here is the call graph for this function:

◆ occurrenceCount()

int Object::occurrenceCount ( )

inherited

Return the occurrence counter.

Definition at line 351 of file Object.cpp.

References Object::occurrence.

◆ operator=()

void Sequence::operator= ( const Sequence & )

private

◆ parse()

void Sequence::parse ( Statement & statement )

virtual

Parse sequence.

Reimplemented from Object.

Definition at line 206 of file Sequence.cpp.

References Attributes::getString(), Object::itsAttr, itsRefPoint, Object::parse(), and OpalParser::run().

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 Sequence::print ( std::ostream & os ) const

virtual

Print sequence.

Reimplemented from Object.

Definition at line 218 of file Sequence.cpp.

References endl(), fetchLine(), SequenceMember::GENERATED, ElmPtr::getElement(), ElementBase::getName(), Object::getOpalName(), FlaggedElmPtr::getReflectionFlag(), Object::isShared(), Object::itsAttr, SequenceMember::itsPosition, SequenceMember::itsType, name, and Inform::precision().

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 Object::printValue ( std::ostream & os ) const

inlinevirtualinherited

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

Definition at line 280 of file Object.h.

References Object::print().

Here is the call graph for this function:

◆ 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::RealVariable(), RealVector::RealVector(), SampleCmd::SampleCmd(), Select::Select(), 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 Sequence::replace	(	Object *	oldObject,
		Object *	newObject
	)

virtual

Replace references to elements.

Reimplemented from Object.

Definition at line 259 of file Sequence.cpp.

References DefaultVisitor::execute(), fetchLine(), Element::getElement(), and Object::getOpalName().

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

References Object::modified.

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

◆ setElement()

void Element::setElement ( ElementBase * base )

inlineinherited

Assign new CLASSIC element.

Definition at line 125 of file Element.h.

References Element::itsClassicElement.

Referenced by Line::Line(), OpalCavity::OpalCavity(), OpalCCollimator::OpalCCollimator(), OpalCyclotron::OpalCyclotron(), OpalDegrader::OpalDegrader(), OpalDrift::OpalDrift(), OpalECollimator::OpalECollimator(), OpalFlexibleCollimator::OpalFlexibleCollimator(), OpalHKicker::OpalHKicker(), OpalKicker::OpalKicker(), OpalOffset::OpalLocalCartesianOffset::OpalLocalCartesianOffset(), OpalMarker::OpalMarker(), OpalMonitor::OpalMonitor(), OpalMultipole::OpalMultipole(), OpalMultipoleT::OpalMultipoleT(), OpalOctupole::OpalOctupole(), OpalOutputPlane::OpalOutputPlane(), OpalPepperPot::OpalPepperPot(), OpalProbe::OpalProbe(), OpalQuadrupole::OpalQuadrupole(), OpalRBend::OpalRBend(), OpalRBend3D::OpalRBend3D(), OpalRCollimator::OpalRCollimator(), OpalRingDefinition::OpalRingDefinition(), OpalSBend::OpalSBend(), OpalSBend3D::OpalSBend3D(), OpalScalingFFAMagnet::OpalScalingFFAMagnet(), OpalSeptum::OpalSeptum(), OpalSextupole::OpalSextupole(), OpalSlit::OpalSlit(), OpalSolenoid::OpalSolenoid(), OpalSource::OpalSource(), OpalStripper::OpalStripper(), OpalTravelingWave::OpalTravelingWave(), OpalUndulator::OpalUndulator(), OpalVacuum::OpalVacuum(), OpalVariableRFCavity::OpalVariableRFCavity(), OpalVariableRFCavityFringeField::OpalVariableRFCavityFringeField(), OpalVerticalFFAMagnet::OpalVerticalFFAMagnet(), OpalVKicker::OpalVKicker(), PyOpal::PyLine_< C >::registerObject(), Sequence(), OpalOffset::OpalGlobalCartesianOffset::update(), OpalOffset::OpalGlobalCylindricalOffset::update(), OpalOffset::OpalLocalCartesianOffset::update(), OpalOffset::OpalLocalCylindricalOffset::update(), OpalRingDefinition::update(), OpalSBend3D::update(), OpalScalingFFAMagnet::update(), OpalVariableRFCavity::update(), OpalVariableRFCavityFringeField::update(), OpalVerticalFFAMagnet::update(), and Replacer::visitFlaggedElmPtr().

◆ 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 Element::setShared ( bool flag )

virtualinherited

Set shared flag.

Reimplemented from Object.

Definition at line 101 of file Element.cpp.

References Element::itsClassicElement, ElementBase::makeSharable(), 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.

◆ storeLine()

void Sequence::storeLine ( TLine & line )

Store sequence line.

Definition at line 283 of file Sequence.cpp.

References OpalData::apply(), fetchLine(), Element::find(), SequenceMember::GENERATED, OpalData::getInstance(), getReference(), Object::increment(), itsCode, and name.

Referenced by copy(), and SequenceParser::parse().

Here is the call graph for this function:

◆ 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 Sequence::update ( )

virtual

Update the embedded CLASSIC beam line.

Reimplemented from Object.

Definition at line 272 of file Sequence.cpp.

References fetchLine(), and updateList().

Here is the call graph for this function:

◆ updateList()

void Sequence::updateList	(	Sequence *	seq,
		TLine *	line
	)

staticprivate

Definition at line 383 of file Sequence.cpp.

References OpalData::find(), findDriftLength(), OpalData::getInstance(), ElementBase::getName(), ElementBase::isSharable(), and updateList().

Referenced by update(), and updateList().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ Edit

friend class Edit

friend

Definition at line 35 of file Sequence.h.

◆ SequenceParser

friend class SequenceParser

friend

Definition at line 36 of file Sequence.h.

◆ SequenceTemplate

friend class SequenceTemplate

friend

Definition at line 37 of file Sequence.h.

Referenced by makeTemplate().

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.

◆ itsClassicElement

Pointer<ElementBase> Element::itsClassicElement

privateinherited

Definition at line 113 of file Element.h.

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

◆ itsCode

ReferenceType Sequence::itsCode

private

Definition at line 124 of file Sequence.h.

Referenced by findDriftLength(), and storeLine().

◆ 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().

◆ itsRefPoint

std::string Sequence::itsRefPoint

private

Definition at line 127 of file Sequence.h.

Referenced by getEntrance(), getExit(), and parse().

◆ 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:

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ TLine

Member Enumeration Documentation

◆ ReferenceType

Constructor & Destructor Documentation

◆ Sequence() [1/3]

◆ ~Sequence()

◆ Sequence() [2/3]

◆ Sequence() [3/3]

Member Function Documentation

◆ addEndMarkers()

◆ addReference()

◆ canReplaceBy()

◆ clear()

◆ clone()

◆ copy()

◆ copyAttributes()

◆ execute()

◆ fetchLine()

◆ find()

◆ findAttribute() [1/2]

◆ findAttribute() [2/2]

◆ findDriftLength()

◆ findNamedPosition()

◆ getBaseObject()

◆ getCategory()

◆ getElement()

◆ getEntrance()

◆ getExit()

◆ getLength()

◆ getOpalName()

◆ getParent()

◆ getReference()

◆ increment()

◆ insertDrifts()

◆ isBuiltin()

◆ isDirty()

◆ isFlagged()

◆ isShared()

◆ isTreeMember()

◆ makeInstance()

◆ makeTemplate()

◆ occurrenceCount()

◆ operator=()

◆ parse()

◆ parseShortcut()

◆ print()

◆ printHelp()

◆ printValue()

◆ registerOwnership()

◆ registerReference()

◆ removeReference()

◆ replace()

◆ setDirty()

◆ setElement()

◆ setFlag()

◆ setOpalName()

◆ setParent()

◆ setShared()

◆ shouldTrace()

◆ shouldUpdate()

◆ storeLine()

◆ unregisterReference()

◆ update()

◆ updateList()

Friends And Related Function Documentation

◆ Edit

◆ SequenceParser

◆ SequenceTemplate

Member Data Documentation