Object Class Reference

The base class for all OPAL objects. More...

#include <Object.h>

Inheritance diagram for Object:

Collaboration diagram for Object:

Public Member Functions
virtual	~Object ()
virtual bool	canReplaceBy (Object *object)
	Test if replacement is allowed. More...
virtual Object *	clone (const std::string &name)=0
	Return a clone. 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 const std::string	getCategory () const =0
	Return the object category as a string. More...
virtual bool	shouldTrace () const =0
	Trace flag. More...
virtual bool	shouldUpdate () const =0
	Update flag. 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 &)
	Parser for single-attribute commands. More...
virtual void	print (std::ostream &) const
	Print the object. More...
virtual void	printValue (std::ostream &) const
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
Public Member Functions inherited from RCObject
int	addReference () const
	Increment reference count. More...
int	removeReference () const
	Decrement the reference count. More...
bool	isShared () const
	Test for sharing. More...

Public Attributes
std::vector< Attribute >	itsAttr
	The object attributes (see Attribute.hh). More...

Protected Member Functions
	Object (int size, const char *name, const char *help)
	Constructor for exemplars. More...
	Object (const std::string &name, Object *parent)
	Constructor for clones. More...
Protected Member Functions inherited from RCObject
	RCObject ()
	Default constructor. More...
	RCObject (const RCObject &)
	Copy constructor. More...
virtual	~RCObject ()=0
RCObject &	operator= (const RCObject &right)

Protected Attributes
bool	builtin
	Built-in flag. More...
bool	modified
	Dirty flag. More...
bool	flagged
	Object flag. More...

Private Member Functions
	Object ()
	Object (const Object &object)
void	operator= (const Object &)

Private Attributes
Object *	itsParent
std::string	itsName
std::string	itsHelp
int	occurrence
double	timeStamp
std::set< Invalidator * >	references
bool	sharedFlag

Detailed Description

The base class for all OPAL objects.

Definition at line 48 of file Object.h.

Constructor & Destructor Documentation

Object::~Object ( )

virtual

Definition at line 42 of file Object.cpp.

Object::Object ( int  size, const char *  name, const char *  help  )

protected

Constructor for exemplars.

Definition at line 330 of file Object.cpp.

References builtin, flagged, and modified.

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

protected

Constructor for clones.

Object::Object ( )

private

Object::Object ( const Object &  object )

private

Member Function Documentation

bool Object::canReplaceBy ( Object *  object )

virtual

Test if replacement is allowed.

Reimplemented in Distribution, Table, Element, BoundaryGeometry, Beam, ParticleMatterInteraction, OpalWake, OpalFilter, RealConstant, RealVariable, Action, BoolConstant, RealVector, StringConstant, and OpalTrimCoil.

Definition at line 51 of file Object.cpp.

Referenced by OpalData::define().

void Object::clear

(

)

Clear the occurrence counter.

Definition at line 315 of file Object.cpp.

Referenced by FieldSolver::initSolver().

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

pure virtual

Return a clone.

Implemented in Distribution, Aperture, MSplit, DumpFields, DumpEMFields, OpalCyclotron, Survey, OpalCavity, OpalRingDefinition, OpalVariableRFCavityFringeField, OpalMultipoleT, OpalMultipoleTCurvedConstRadius, OpalMultipoleTCurvedVarRadius, OpalMultipoleTStraight, OpalOffset::OpalLocalCartesianOffset, OpalScalingFFAMagnet, OpalVariableRFCavity, OpalOffset::OpalGlobalCartesianOffset, OpalOffset::OpalLocalCylindricalOffset, OpalTravelingWave, OpalOffset::OpalGlobalCylindricalOffset, Sequence, BoundaryGeometry, OpalPolynomialTimeDependence, OpalSplineTimeDependence, LMDif, OpalSBend3D, FieldSolver, OpalRBend3D, OpalStripper, OpalCCollimator, OpalParallelPlate, OpalPepperPot, OpalProbe, OpalKicker, Migrad, OpalPatch, OpalQuadrupole, OpalSeptum, Line, SequenceTemplate, Macro, Beam, ParticleMatterInteraction, OpalFlexibleCollimator, OpalHKicker, OpalWire, OpalWake, TrackRun, OpalDegrader, OpalDrift, OpalECollimator, OpalMultipole, OpalOctupole, OpalRCollimator, OpalSextupole, OpalSlit, OpalSolenoid, OpalVKicker, LineTemplate, OpalCyclotronValley, OpalFilter, OpalSeparator, OpalSRot, OpalYRot, Simplex, RealConstant, OpalMonitor, Micado, RealVariable, Eigen, Envelope, List, MatrixCmd, Twiss3, OpalBeamStripping, OpalRBend, MatchOption, AttList, TrackEnd, BoolConstant, RealVector, StringConstant, Select, EditInstall, OpalSBend, MatchEnd, ThreadAll, Option, OpalVerticalFFAMagnet, ConstraintCmd, ThreadBpm, Call, Dump, Echo, Help, PSystem, Quit, Save, Show, Stop, System, Title, Value, What, EditCmd, EditCycle, EditEnd, EditFlatten, EditMove, EditReflect, EditRemove, EditReplace, EditSelect, OpalHMonitor, OpalInstrument, OpalMarker, OpalVMonitor, MatchCmd, VaryCmd, Dynamic, MakeSequence, Static, Insertion, Period, TrackCmd, TrackSave, TrackStart, SetIntegrator, OpalTrimCoil, OpalSource, OptimizeCmd, OpalSample, SampleCmd, Constraint, DVar, and Objective.

Referenced by EditInstall::parse(), OpalParser::parseAction(), OpalParser::parseAssign(), OpalParser::parseDefine(), SequenceParser::parseMember(), and FlatWriter::visitMapIntegrator().

void Object::copyAttributes

(

const Object &

source

)

Copy attributes from another object.

Definition at line 57 of file Object.cpp.

References itsAttr.

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

void Object::execute ( )

virtual

Execute the command.

Reimplemented in Distribution, Aperture, Twiss, MSplit, DumpFields, DumpEMFields, FieldSolver, Survey, BoundaryGeometry, LMDif, Migrad, Beam, ParticleMatterInteraction, OpalWake, TrackRun, OpalFilter, Simplex, Micado, Eigen, Envelope, List, MatrixCmd, Twiss3, MatchOption, AttList, TrackEnd, Select, EditInstall, MatchEnd, ThreadAll, Option, ConstraintCmd, MacroCmd, ThreadBpm, Call, Dump, Echo, Help, PSystem, Quit, Save, Show, Stop, System, Title, Value, What, EditCmd, EditCycle, EditEnd, EditFlatten, EditMove, EditReflect, EditRemove, EditReplace, EditSelect, MatchCmd, VaryCmd, Dynamic, MakeSequence, Static, TrackCmd, TrackSave, TrackStart, SetIntegrator, OpalTrimCoil, OptimizeCmd, OpalSample, SampleCmd, Constraint, DVar, and Objective.

Definition at line 62 of file Object.cpp.

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

virtual

Find an attribute by name.

Referenced by SequenceParser::findNeighbourPositions(), OpalElement::getParticleMatterInteraction(), OpalElement::getTypeName(), OpalElement::getWakeF(), EditInstall::parse(), Line::parse(), OpalElement::parse(), OpalParser::parseAssign(), SequenceParser::parsePosition(), and FlatWriter::visitMapIntegrator().

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

virtual

Find an attribute by name.

const Object * Object::getBaseObject

(

)

const

Return the object's base type object.

Definition at line 277 of file Object.cpp.

References itsParent.

Referenced by Aperture::calcul(), OpalElement::fillRegisteredAttributes(), and Aperture::run().

virtual const std::string Object::getCategory ( ) const

pure virtual

Return the object category as a string.

Implemented in Table, Element, Macro, BeamSequence, Action, Editor, ValueDefinition, and Definition.

Referenced by OpalData::getAllNames().

const string & Object::getOpalName

(

)

const

Return object name.

Definition at line 284 of file Object.cpp.

Referenced by Aperture::calcul(), Macro::clone(), OpalVariableRFCavity::clone(), OpalOffset::OpalLocalCartesianOffset::clone(), OpalVariableRFCavityFringeField::clone(), OpalData::create(), OpalData::define(), Edit::Edit(), EditEnd::execute(), Survey::execute(), Twiss::execute(), Aperture::execute(), Insertion::fill(), Survey::fill(), OpalElement::fillRegisteredAttributes(), Sequence::findDriftLength(), SequenceParser::findNeighbourPositions(), MSplit::findRow(), Survey::findRow(), Aperture::findRow(), Twiss::findRow(), Edit::finish(), ValueDefinition::getBool(), ValueDefinition::getBoolComponent(), ValueDefinition::getReal(), ValueDefinition::getRealComponent(), ValueDefinition::getString(), ValueDefinition::getStringComponent(), ParticleMatterInteraction::initParticleMatterInteractionHandler(), OpalWake::initWakefunction(), List::list(), LineTemplate::makeInstance(), MakeSequenceNS::ElementWriter::operator()(), SaveNS::ElementWriter::operator()(), EditInstall::parse(), SequenceParser::parseMember(), SequenceParser::parsePosition(), OpalTrimCoil::print(), BoolConstant::print(), RealVector::print(), StringConstant::print(), RealVariable::print(), RealConstant::print(), ConstraintCmd::print(), OpalFilter::print(), OpalWake::print(), ParticleMatterInteraction::print(), Line::print(), Sequence::print(), Beam::print(), OpalElement::print(), print(), FieldSolver::printInfo(), BoundaryGeometry::printInfo(), OpalElement::registerOwnership(), Line::replace(), Sequence::replace(), MSplit::run(), Aperture::run(), TrackRun::setupCyclotronTracker(), TrackRun::setupThickTracker(), TrackRun::setupTTracker(), OpalTrimCoil::update(), OpalSBend::update(), OpalRBend::update(), OpalBeamStripping::update(), OpalRCollimator::update(), OpalDegrader::update(), OpalECollimator::update(), OpalSlit::update(), OpalFlexibleCollimator::update(), OpalDrift::update(), OpalWire::update(), OpalFilter::update(), OpalSeptum::update(), OpalWake::update(), OpalPepperPot::update(), OpalProbe::update(), OpalCCollimator::update(), OpalParallelPlate::update(), OpalRBend3D::update(), ParticleMatterInteraction::update(), OpalQuadrupole::update(), OpalPolynomialTimeDependence::update(), OpalSplineTimeDependence::update(), OpalOffset::OpalGlobalCylindricalOffset::update(), OpalTravelingWave::update(), BoundaryGeometry::update(), OpalOffset::OpalLocalCylindricalOffset::update(), OpalOffset::OpalGlobalCartesianOffset::update(), OpalOffset::OpalLocalCartesianOffset::update(), OpalCavity::update(), Beam::update(), Distribution::writeOutFileEmission(), Distribution::writeOutFileHeader(), and Distribution::writeOutFileInjection().

Object * Object::getParent

(

)

const

Return parent pointer.

Definition at line 289 of file Object.cpp.

Referenced by OpalData::erase(), OpalElement::fillRegisteredAttributes(), MakeSequenceNS::ObjectFlagger::operator()(), SaveNS::ObjectFlagger::operator()(), ConstraintCmd::print(), OpalElement::print(), and OpalElement::registerOwnership().

int Object::increment

(

)

Increment and return the occurrence counter.

Definition at line 320 of file Object.cpp.

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

bool Object::isBuiltin

(

)

const

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

Definition at line 242 of file Object.cpp.

Referenced by OpalData::define(), OpalData::getAllNames(), MakeSequenceNS::ObjectFlagger::operator()(), and SaveNS::ObjectFlagger::operator()().

bool Object::isDirty

(

)

const

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

Definition at line 263 of file Object.cpp.

bool Object::isFlagged

(

)

const

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

Definition at line 273 of file Object.cpp.

Referenced by MakeSequenceNS::ElementWriter::operator()(), SaveNS::ElementWriter::operator()(), MakeSequenceNS::VariableWriter::operator()(), SaveNS::ParameterWriter::operator()(), and SaveNS::SpecialWriter::operator()().

bool Object::isShared ( ) const

virtual

Shared flag.

Definition at line 247 of file Object.cpp.

Referenced by Sequence::print().

bool Object::isTreeMember

(

const Object *

subTree

)

const

Test for tree membership.

Definition at line 294 of file Object.cpp.

References itsParent.

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

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

virtual

Macro handler function.

Reimplemented in SequenceTemplate, LineTemplate, and MacroCmd.

Definition at line 94 of file Object.cpp.

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

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

virtual

Macro handler function.

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

Definition at line 88 of file Object.cpp.

Referenced by OpalParser::parseMacro().

int Object::occurrenceCount

(

)

Return the occurrence counter.

Definition at line 325 of file Object.cpp.

void Object::operator= ( const Object &  )

private

void Object::parse ( Statement &  stat )

virtual

Parse the object.

Reimplemented in OpalElement, Sequence, Line, EditInstall, ConstraintCmd, Call, Echo, Help, PSystem, Save, Show, System, Title, Value, and What.

Definition at line 100 of file Object.cpp.

References Statement::delimiter(), Expressions::parseDelimiter(), Expressions::parseRealConst(), Expressions::parseString(), and Round().

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

Here is the call graph for this function:

void Object::parseShortcut ( Statement &  stat )

virtual

Parser for single-attribute commands.

Definition at line 132 of file Object.cpp.

References Statement::delimiter(), Statement::mark(), name, Statement::restore(), and Statement::word().

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

Here is the call graph for this function:

void Object::print ( std::ostream &  msg ) const

virtual

Print the object.

Reimplemented in OpalElement, Beam, Sequence, OpalMultipoleT, OpalMultipoleTCurvedConstRadius, OpalMultipoleTCurvedVarRadius, OpalRingDefinition, OpalMultipoleTStraight, OpalOffset::OpalLocalCartesianOffset, OpalOffset::OpalGlobalCartesianOffset, OpalOffset::OpalLocalCylindricalOffset, Line, OpalOffset::OpalGlobalCylindricalOffset, OpalPolynomialTimeDependence, OpalSplineTimeDependence, OpalBend, OpalRBend3D, ParticleMatterInteraction, OpalWake, OpalFilter, OpalQuadrupole, OpalMultipole, OpalOctupole, OpalSextupole, ConstraintCmd, RealConstant, RealVariable, BoolConstant, RealVector, StringConstant, and OpalMarker.

Definition at line 164 of file Object.cpp.

References endl(), and getOpalName().

Referenced by printValue().

Here is the call graph for this function:

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

virtual

Print help.

Reimplemented in ConstraintCmd.

Definition at line 204 of file Object.cpp.

References endl(), gmsg, and max().

Referenced by Help::execute(), What::execute(), and Show::execute().

Here is the call graph for this function:

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

inlinevirtual

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

Definition at line 278 of file Object.h.

References print().

Here is the call graph for this function:

void Object::registerOwnership

(

const AttributeHandler::OwnerType &

itsClass

)

const

Definition at line 194 of file Object.cpp.

References AttributeHandler::addAttributeOwner().

Referenced by Aperture::Aperture(), AttList::AttList(), Beam::Beam(), BoolConstant::BoolConstant(), BoundaryGeometry::BoundaryGeometry(), Call::Call(), Constraint::Constraint(), ConstraintCmd::ConstraintCmd(), DumpFields::DumpFields(), DVar::DVar(), Dynamic::Dynamic(), Echo::Echo(), EditCmd::EditCmd(), EditCycle::EditCycle(), EditEnd::EditEnd(), EditInstall::EditInstall(), EditMove::EditMove(), EditRemove::EditRemove(), EditReplace::EditReplace(), EditSelect::EditSelect(), Eigen::Eigen(), Envelope::Envelope(), FieldSolver::FieldSolver(), Help::Help(), Insertion::Insertion(), Line::Line(), List::List(), LMDif::LMDif(), MakeSequence::MakeSequence(), MatchOption::MatchOption(), MatrixCmd::MatrixCmd(), Micado::Micado(), Migrad::Migrad(), MSplit::MSplit(), Objective::Objective(), OpalFilter::OpalFilter(), OpalSample::OpalSample(), OpalTrimCoil::OpalTrimCoil(), OpalWake::OpalWake(), OptimizeCmd::OptimizeCmd(), Option::Option(), ParticleMatterInteraction::ParticleMatterInteraction(), Period::Period(), PSystem::PSystem(), RealConstant::RealConstant(), RealVariable::RealVariable(), RealVector::RealVector(), SampleCmd::SampleCmd(), Save::Save(), Select::Select(), Sequence::Sequence(), Distribution::setAttributes(), SetIntegrator::SetIntegrator(), Show::Show(), Simplex::Simplex(), Static::Static(), StringConstant::StringConstant(), Survey::Survey(), System::System(), ThreadAll::ThreadAll(), ThreadBpm::ThreadBpm(), Title::Title(), TrackCmd::TrackCmd(), TrackRun::TrackRun(), TrackSave::TrackSave(), TrackStart::TrackStart(), Twiss3::Twiss3(), Value::Value(), VaryCmd::VaryCmd(), and What::What().

Here is the call graph for this function:

void Object::registerReference

(

Invalidator *

a

)

Register a reference to this object.

Definition at line 185 of file Object.cpp.

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

virtual

Replace references.

Reimplemented in Sequence, and Line.

Definition at line 232 of file Object.cpp.

void Object::setDirty

(

bool

dirty

)

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

Definition at line 257 of file Object.cpp.

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

void Object::setFlag

(

bool

flag

)

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

Definition at line 268 of file Object.cpp.

Referenced by MakeSequenceNS::ElementWriter::operator()(), SaveNS::ElementWriter::operator()(), MakeSequenceNS::VariableWriter::operator()(), SaveNS::ParameterWriter::operator()(), and SaveNS::SpecialWriter::operator()().

void Object::setOpalName

(

const std::string &

name

)

Set object name.

Definition at line 305 of file Object.cpp.

References name.

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

void Object::setParent

(

Object *

parent

)

Set parent object.

Definition at line 310 of file Object.cpp.

Referenced by OpalData::erase().

void Object::setShared ( bool  flag )

virtual

Set/reset shared flag.

Reimplemented in Element.

Definition at line 252 of file Object.cpp.

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

virtual bool Object::shouldTrace ( ) const

pure virtual

Trace flag.

Implemented in Table, Element, Macro, Action, Editor, ValueDefinition, and Definition.

Referenced by OpalParser::execute().

virtual bool Object::shouldUpdate ( ) const

pure virtual

Update flag.

Implemented in Table, Element, Macro, Action, Editor, ValueDefinition, and Definition.

Referenced by OpalParser::execute().

void Object::unregisterReference

(

Invalidator *

a

)

Unegister a reference to this object.

Definition at line 190 of file Object.cpp.

void Object::update ( )

virtual

Update this object.

Reimplemented in Distribution, OpalElement, Beam, Sequence, OpalCyclotron, OpalVariableRFCavityFringeField, FieldSolver, OpalMultipoleT, OpalMultipoleTCurvedConstRadius, OpalMultipoleTCurvedVarRadius, OpalCavity, OpalVariableRFCavity, OpalMultipoleTStraight, OpalRingDefinition, OpalScalingFFAMagnet, OpalOffset::OpalLocalCartesianOffset, OpalOffset::OpalGlobalCartesianOffset, OpalOffset::OpalLocalCylindricalOffset, OpalTravelingWave, BoundaryGeometry, OpalOffset::OpalGlobalCylindricalOffset, OpalKicker, OpalPolynomialTimeDependence, OpalSBend3D, OpalSplineTimeDependence, OpalVKicker, OpalQuadrupole, OpalRBend3D, OpalStripper, ParticleMatterInteraction, OpalCCollimator, OpalMultipole, OpalOctupole, OpalParallelPlate, OpalPepperPot, OpalProbe, OpalSextupole, OpalWake, OpalPatch, OpalSeptum, OpalFilter, OpalDrift, OpalFlexibleCollimator, OpalHKicker, OpalWire, OpalDegrader, OpalECollimator, OpalRCollimator, OpalSlit, OpalSolenoid, OpalCyclotronValley, OpalSeparator, OpalSRot, OpalYRot, OpalVerticalFFAMagnet, OpalBeamStripping, OpalRBend, OpalMonitor, OpalSBend, OpalMarker, OpalHMonitor, OpalInstrument, OpalVMonitor, OpalTrimCoil, and OpalSource.

Definition at line 237 of file Object.cpp.

Referenced by CorrectionBase::addKick().

Member Data Documentation

bool Object::builtin

protected

Built-in flag.

Definition at line 231 of file Object.h.

Referenced by Beam::Beam(), BoundaryGeometry::BoundaryGeometry(), Distribution::Distribution(), Object(), OpalFilter::OpalFilter(), OpalMarker::OpalMarker(), OpalTrimCoil::OpalTrimCoil(), OpalWake::OpalWake(), ParticleMatterInteraction::ParticleMatterInteraction(), RealConstant::RealConstant(), StringConstant::StringConstant(), and Table::~Table().

bool Object::flagged

protected

Object flag.

Definition at line 240 of file Object.h.

Referenced by Object().

std::vector<Attribute> Object::itsAttr

The object attributes (see Attribute.hh).

Definition at line 214 of file Object.h.

Referenced by CorrectionBase::addKick(), Distribution::adjustPhaseSpace(), Aperture::Aperture(), AttList::AttList(), Beam::Beam(), BoolConstant::BoolConstant(), BoundaryGeometry::BoundaryGeometry(), DumpEMFields::buildGrid(), DumpFields::buildGrid(), Distribution::calcPartPerDist(), Aperture::calcul(), Call::Call(), Distribution::checkEmissionParameters(), Distribution::checkIfEmitted(), Distribution::chooseInputMomentumUnits(), Constraint::Constraint(), ConstraintCmd::ConstraintCmd(), copyAttributes(), CorrectionBase::CorrectionBase(), Distribution::create(), Distribution::createDistributionFromFile(), Distribution::createMatchedGaussDistribution(), Distribution::createOpalE(), Distribution::createOpalT(), DumpEMFields::DumpEMFields(), DumpFields::DumpFields(), DVar::DVar(), Dynamic::Dynamic(), Echo::Echo(), EditCmd::EditCmd(), EditCycle::EditCycle(), EditEnd::EditEnd(), EditInstall::EditInstall(), EditMove::EditMove(), EditRemove::EditRemove(), EditReplace::EditReplace(), EditSelect::EditSelect(), Eigen::Eigen(), Envelope::Envelope(), SampleCmd::execute(), OptimizeCmd::execute(), SetIntegrator::execute(), Save::execute(), EditMove::execute(), EditRemove::execute(), VaryCmd::execute(), EditReplace::execute(), Call::execute(), EditSelect::execute(), Dynamic::execute(), MakeSequence::execute(), Show::execute(), Static::execute(), System::execute(), Title::execute(), Value::execute(), What::execute(), TrackCmd::execute(), Echo::execute(), TrackSave::execute(), Help::execute(), TrackStart::execute(), PSystem::execute(), EditCmd::execute(), EditCycle::execute(), EditEnd::execute(), ConstraintCmd::execute(), ThreadBpm::execute(), Option::execute(), EditInstall::execute(), Select::execute(), ThreadAll::execute(), MatchOption::execute(), AttList::execute(), Eigen::execute(), Envelope::execute(), List::execute(), MatrixCmd::execute(), Twiss3::execute(), Micado::execute(), Simplex::execute(), TrackRun::execute(), Migrad::execute(), LMDif::execute(), Survey::execute(), MSplit::execute(), Twiss::execute(), Aperture::execute(), FieldSolver::FieldSolver(), Insertion::fill(), Period::fill(), Survey::fill(), OpalSRot::fillRegisteredAttributes(), OpalYRot::fillRegisteredAttributes(), Period::findClosedOrbit(), Distribution::generateAstraFlattopT(), Distribution::generateBinomial(), Distribution::generateFlattopLaserProfile(), Distribution::generateFlattopT(), Distribution::generateFlattopZ(), Distribution::generateGaussZ(), Distribution::generateLongFlattopT(), Distribution::generateTransverseGauss(), BoundaryGeometry::getA(), OpalData::getAllNames(), OpalElement::getApert(), Aperture::getAPERTMIN(), BoundaryGeometry::getB(), MSplit::getBETXMAX(), Aperture::getBETXMAX(), MSplit::getBETYMAX(), Aperture::getBETYMAX(), BoolConstant::getBool(), BoundaryGeometry::getC(), Beam::getCharge(), Beam::getCurrent(), Distribution::getDarkCurrentParticlesInwardMargin(), BoundaryGeometry::getDistribution(), BoundaryGeometry::getDistributionArray(), TrackCmd::getDT(), TrackCmd::getDTAU(), TrackCmd::getDTSCINIT(), Distribution::getEInitThreshold(), Distribution::getEkin(), Distribution::getEmissionMode(), Distribution::getEmissionTimeShift(), Beam::getET(), Beam::getEX(), Constraint::getExpression(), Objective::getExpression(), Beam::getEY(), Distribution::getFieldEnhancement(), Distribution::getFieldFNThreshold(), BoundaryGeometry::getFilename(), Distribution::getFNParameterA(), Distribution::getFNParameterB(), Distribution::getFNParameterVYSecond(), Distribution::getFNParameterVYZero(), Distribution::getFNParameterY(), Beam::getFrequency(), Beam::getGamma(), BoundaryGeometry::getL1(), BoundaryGeometry::getL2(), Distribution::getLaserEnergy(), Line::getLength(), Sequence::getLength(), OpalElement::getLength(), BoundaryGeometry::getLength(), DVar::getLowerBound(), Beam::getMass(), Distribution::getMaxFNemissionPartPerTri(), TrackCmd::getMAXSTEPS(), FieldSolver::getMT(), FieldSolver::getMX(), FieldSolver::getMY(), OpalWake::getNumberOfBins(), Distribution::getNumberOfDarkCurrentParticles(), Beam::getNumberOfParticles(), Distribution::getNumberOfParticlesInFile(), Beam::getNumberOfSlices(), Beam::getParticleName(), Beam::getPC(), RealVariable::getReal(), RealConstant::getReal(), RealVector::getRealComponent(), Sequence::getReference(), BoundaryGeometry::getS(), Distribution::getSecondaryEmissionFlag(), TrackCmd::getSTEPSPERTURN(), StringConstant::getString(), Distribution::getSurfMaterial(), TrackCmd::getT0(), FieldSolver::getTagging_m(), Distribution::getTEmission(), TrackCmd::getTIMEINTEGRATOR(), BoundaryGeometry::getTopology(), FieldSolver::getType(), Distribution::getTypeofDistribution(), DVar::getUpperBound(), DVar::getVariable(), OpalSample::getVariable(), Distribution::getvEmax(), Distribution::getvEZero(), Distribution::getvKenergy(), Distribution::getvKtheta(), Distribution::getvSeyMax(), Distribution::getvSeyZero(), Distribution::getvVThermal(), Distribution::getVw(), Distribution::getWeight(), Distribution::getWorkFunction(), Distribution::getWorkFunctionRf(), TrackCmd::getZSTART(), TrackCmd::getZSTOP(), FieldSolver::hasPeriodicZ(), Help::Help(), FieldSolver::initAmrObject_m(), FieldSolver::initAmrSolver_m(), FieldSolver::initCartesianFields(), OpalSample::initialize(), BoundaryGeometry::initialize(), OpalFilter::initOpalFilter(), OpalTrimCoil::initOpalTrimCoil(), ParticleMatterInteraction::initParticleMatterInteractionHandler(), FieldSolver::initSolver(), OpalWake::initWakefunction(), Distribution::injectBeam(), Insertion::Insertion(), Line::Line(), List::List(), List::list(), LMDif::LMDif(), MakeSequence::MakeSequence(), MatchOption::MatchOption(), MatrixCmd::MatrixCmd(), Micado::Micado(), Migrad::Migrad(), MSplit::MSplit(), Objective::Objective(), OpalBeamStripping::OpalBeamStripping(), OpalBend::OpalBend(), OpalCavity::OpalCavity(), OpalCCollimator::OpalCCollimator(), OpalCyclotron::OpalCyclotron(), OpalCyclotronValley::OpalCyclotronValley(), OpalDegrader::OpalDegrader(), OpalDrift::OpalDrift(), OpalECollimator::OpalECollimator(), OpalElement::OpalElement(), OpalFilter::OpalFilter(), OpalFlexibleCollimator::OpalFlexibleCollimator(), OpalOffset::OpalGlobalCartesianOffset::OpalGlobalCartesianOffset(), OpalOffset::OpalGlobalCylindricalOffset::OpalGlobalCylindricalOffset(), OpalHKicker::OpalHKicker(), OpalKicker::OpalKicker(), OpalOffset::OpalLocalCartesianOffset::OpalLocalCartesianOffset(), OpalOffset::OpalLocalCylindricalOffset::OpalLocalCylindricalOffset(), OpalMonitor::OpalMonitor(), OpalMultipole::OpalMultipole(), OpalMultipoleT::OpalMultipoleT(), OpalMultipoleTCurvedConstRadius::OpalMultipoleTCurvedConstRadius(), OpalMultipoleTCurvedVarRadius::OpalMultipoleTCurvedVarRadius(), OpalMultipoleTStraight::OpalMultipoleTStraight(), OpalOctupole::OpalOctupole(), OpalParallelPlate::OpalParallelPlate(), OpalPatch::OpalPatch(), OpalPepperPot::OpalPepperPot(), OpalPolynomialTimeDependence::OpalPolynomialTimeDependence(), OpalProbe::OpalProbe(), OpalQuadrupole::OpalQuadrupole(), OpalRBend3D::OpalRBend3D(), OpalRCollimator::OpalRCollimator(), OpalRingDefinition::OpalRingDefinition(), OpalSample::OpalSample(), OpalSBend3D::OpalSBend3D(), OpalScalingFFAMagnet::OpalScalingFFAMagnet(), OpalSeparator::OpalSeparator(), OpalSeptum::OpalSeptum(), OpalSextupole::OpalSextupole(), OpalSlit::OpalSlit(), OpalSolenoid::OpalSolenoid(), OpalSource::OpalSource(), OpalSplineTimeDependence::OpalSplineTimeDependence(), OpalSRot::OpalSRot(), OpalStripper::OpalStripper(), OpalTravelingWave::OpalTravelingWave(), OpalTrimCoil::OpalTrimCoil(), OpalVariableRFCavity::OpalVariableRFCavity(), OpalVariableRFCavityFringeField::OpalVariableRFCavityFringeField(), OpalVerticalFFAMagnet::OpalVerticalFFAMagnet(), OpalVKicker::OpalVKicker(), OpalWake::OpalWake(), OpalWire::OpalWire(), OpalYRot::OpalYRot(), OptimizeCmd::OptimizeCmd(), Option::Option(), ConstraintCmd::parse(), Line::parse(), Sequence::parse(), DumpEMFields::parseCoordinateSystem(), ParticleMatterInteraction::ParticleMatterInteraction(), Period::Period(), OpalTrimCoil::print(), BoolConstant::print(), StringConstant::print(), RealVector::print(), RealVariable::print(), RealConstant::print(), ConstraintCmd::print(), OpalFilter::print(), OpalWake::print(), ParticleMatterInteraction::print(), Sequence::print(), Beam::print(), Distribution::printDistFlattop(), Distribution::printDistFromFile(), Distribution::printDistGauss(), Distribution::printDistSurfAndCreate(), Distribution::printDistSurfEmission(), Distribution::printEmissionModelAstra(), Distribution::printEmissionModelNone(), FieldSolver::printInfo(), BoundaryGeometry::printInfo(), Insertion::printTable(), Period::printTable(), Survey::printTable(), Twiss::printTableTitle(), StringConstant::printValue(), RealVector::printValue(), BoolConstant::printValue(), RealVariable::printValue(), RealConstant::printValue(), PSystem::PSystem(), Twiss::put(), RealConstant::RealConstant(), RealVariable::RealVariable(), RealVector::RealVector(), OpalElement::registerOwnership(), OptimizeCmd::run(), MSplit::run(), Aperture::run(), SampleCmd::SampleCmd(), Save::Save(), Distribution::scaleDistCoordinates(), Select::Select(), Select::select(), Sequence::Sequence(), Distribution::setAttributes(), Distribution::setDistParametersBinomial(), Distribution::setDistParametersFlattop(), Distribution::setDistParametersGauss(), TrackRun::setDistributionParallelT(), Distribution::setDistType(), Beam::setET(), Beam::setEX(), Beam::setEY(), Distribution::setFieldEmissionParameters(), SetIntegrator::SetIntegrator(), FieldSolver::setMT(), FieldSolver::setMX(), FieldSolver::setMY(), TrackRun::setupCyclotronTracker(), Distribution::setupEmissionModel(), Distribution::setupEmissionModelAstra(), Distribution::setupEmissionModelNone(), Distribution::setupEmissionModelNonEquil(), TrackRun::setupFieldsolver(), Distribution::setupParticleBins(), TrackRun::setupSliceTracker(), TrackRun::setupThickTracker(), TrackRun::setupTTracker(), Distribution::shiftDistCoordinates(), Show::Show(), Simplex::Simplex(), Micado::solve(), Static::Static(), StringConstant::StringConstant(), Survey::Survey(), System::System(), ThreadAll::ThreadAll(), ThreadBpm::ThreadBpm(), Title::Title(), TrackCmd::TrackCmd(), TrackRun::TrackRun(), TrackSave::TrackSave(), TrackStart::TrackStart(), Twiss::Twiss(), Twiss3::Twiss3(), OpalVMonitor::update(), OpalHMonitor::update(), OpalInstrument::update(), OpalMonitor::update(), OpalSBend::update(), OpalRBend::update(), OpalBeamStripping::update(), OpalVerticalFFAMagnet::update(), OpalSRot::update(), OpalYRot::update(), OpalSeparator::update(), OpalCyclotronValley::update(), OpalSlit::update(), OpalECollimator::update(), OpalRCollimator::update(), OpalDegrader::update(), OpalSolenoid::update(), OpalDrift::update(), OpalHKicker::update(), OpalWire::update(), OpalFlexibleCollimator::update(), OpalSeptum::update(), OpalPatch::update(), OpalMultipole::update(), OpalPepperPot::update(), OpalOctupole::update(), OpalProbe::update(), OpalCCollimator::update(), OpalParallelPlate::update(), OpalSextupole::update(), OpalStripper::update(), OpalRBend3D::update(), OpalQuadrupole::update(), OpalVKicker::update(), OpalSplineTimeDependence::update(), OpalPolynomialTimeDependence::update(), OpalSBend3D::update(), OpalKicker::update(), OpalOffset::OpalGlobalCylindricalOffset::update(), OpalTravelingWave::update(), OpalOffset::OpalLocalCylindricalOffset::update(), OpalOffset::OpalGlobalCartesianOffset::update(), OpalOffset::OpalLocalCartesianOffset::update(), OpalScalingFFAMagnet::update(), OpalRingDefinition::update(), OpalMultipoleTStraight::update(), OpalCavity::update(), OpalVariableRFCavity::update(), OpalMultipoleT::update(), OpalMultipoleTCurvedVarRadius::update(), OpalMultipoleTCurvedConstRadius::update(), OpalVariableRFCavityFringeField::update(), OpalCyclotron::update(), Beam::update(), OpalElement::update(), OpalElement::updateUnknown(), Value::Value(), ValueDefinition::value(), VaryCmd::VaryCmd(), What::What(), Distribution::writeOutFileEmission(), Distribution::writeOutFileHeader(), Distribution::writeOutFileInjection(), and AttList::writeTable().

std::string Object::itsHelp

private

Definition at line 256 of file Object.h.

std::string Object::itsName

private

Definition at line 253 of file Object.h.

Object* Object::itsParent

private

Definition at line 250 of file Object.h.

Referenced by getBaseObject(), and isTreeMember().

bool Object::modified

protected

Dirty flag.

Definition at line 236 of file Object.h.

Referenced by Object().

int Object::occurrence

private

Definition at line 259 of file Object.h.

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

private

Definition at line 266 of file Object.h.

bool Object::sharedFlag

private

Definition at line 269 of file Object.h.

double Object::timeStamp

private

Definition at line 262 of file Object.h.

---

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

• src/AbstractObjects/Object.h
• src/AbstractObjects/Object.cpp