|
OPALX (Object Oriented Parallel Accelerator Library for Exascal) MINIorX
OPALX
|
#include <StringConstant.h>
Public Member Functions | |
| StringConstant () | |
| Exemplar constructor. | |
| virtual | ~StringConstant () |
| virtual bool | canReplaceBy (Object *object) |
| Test if object can be replaced. | |
| virtual StringConstant * | clone (const std::string &name) |
| Make clone. | |
| virtual void | print (std::ostream &) const |
| Print the constant. | |
| virtual void | printValue (std::ostream &os) const |
| Print its value. | |
| virtual std::string | getString () const |
| Return value. | |
| virtual const std::string | getCategory () const |
| Return the object category as a string. | |
| virtual bool | shouldTrace () const |
| Trace flag. | |
| virtual bool | shouldUpdate () const |
| Update flag. | |
| virtual bool | getBool () const |
| Return logical value. | |
| virtual bool | getBoolComponent (int) const |
| Return indexed logical value. | |
| virtual double | getReal () const |
| Return real value. | |
| virtual double | getRealComponent (int) const |
| Return indexed real value. | |
| virtual std::string | getStringComponent (int) const |
| Return indexed string value. | |
| Attribute & | value () |
| Return the attribute representing the value of the definition. | |
| const Attribute & | value () const |
| Return the attribute representing the value of the definition. | |
| void | copyAttributes (const Object &) |
| Copy attributes from another object. | |
| virtual void | execute () |
| Execute the command. | |
| virtual Attribute * | findAttribute (const std::string &name) |
| Find an attribute by name. | |
| virtual const Attribute * | findAttribute (const std::string &name) const |
| Find an attribute by name. | |
| virtual Object * | makeTemplate (const std::string &, TokenStream &, Statement &) |
| Macro handler function. | |
| virtual Object * | makeInstance (const std::string &name, Statement &, const Parser *) |
| Macro handler function. | |
| virtual void | parse (Statement &) |
| Parse the object. | |
| virtual void | parseShortcut (Statement &, bool eval=true) |
| Parser for single-attribute commands. | |
| virtual void | printHelp (std::ostream &) const |
| Print help. | |
| virtual void | replace (Object *oldObject, Object *newObject) |
| Replace references. | |
| virtual void | update () |
| Update this object. | |
| bool | isBuiltin () const |
| True, if [b]this[/b] is a built-in object. | |
| virtual bool | isShared () const |
| Shared flag. | |
| virtual void | setShared (bool) |
| Set/reset shared flag. | |
| void | setDirty (bool) |
| Set/reset the [b]modified[/b] flag. | |
| bool | isDirty () const |
| True, if the [b]modified[/b] flag is set. | |
| void | setFlag (bool) |
| Flag/unflag this object, e. g. to control output of objects for. | |
| bool | isFlagged () const |
| True, if [b]this[/b] is flagged by setFlag(true). | |
| const Object * | getBaseObject () const |
| Return the object's base type object. | |
| const std::string & | getOpalName () const |
| Return object name. | |
| Object * | getParent () const |
| Return parent pointer. | |
| bool | isTreeMember (const Object *subTree) const |
| Test for tree membership. | |
| void | setOpalName (const std::string &name) |
| Set object name. | |
| void | setParent (Object *) |
| Set parent object. | |
| void | clear () |
| Clear the occurrence counter. | |
| int | increment () |
| Increment and return the occurrence counter. | |
| int | occurrenceCount () |
| Return the occurrence counter. | |
| void | registerReference (Invalidator *a) |
| Register a reference to this object. | |
| void | unregisterReference (Invalidator *a) |
| Unegister a reference to this object. | |
| void | registerOwnership (const AttributeHandler::OwnerType &itsClass) const |
| int | addReference () const |
| Increment reference count. | |
| int | removeReference () const |
| Decrement the reference count. | |
Public Attributes | |
| std::vector< Attribute > | itsAttr |
| The object attributes. | |
Protected Attributes | |
| const std::string | itsPrefix |
| The declaration prefix. | |
| bool | builtin |
| Built-in flag. | |
| bool | modified |
| Dirty flag. | |
| bool | flagged |
| Object flag. | |
Private Member Functions | |
| StringConstant (const StringConstant &) | |
| void | operator= (const StringConstant &) |
| StringConstant (const std::string &name, StringConstant *parent) | |
| StringConstant (const std::string &name, StringConstant *parent, const std::string &value) | |
Private Attributes | |
| Object * | itsParent |
| std::string | itsName |
| std::string | itsHelp |
| int | occurrence |
| double | timeStamp |
| std::set< Invalidator * > | references |
| bool | sharedFlag |
| int | refCount |
Definition at line 24 of file StringConstant.h.
| StringConstant::StringConstant | ( | ) |
Exemplar constructor.
Definition at line 28 of file StringConstant.cpp.
References OpalData::create(), CREATE_STRINGCONSTANT, Util::getGitRevision(), OpalData::getInstance(), Object::itsAttr, Attributes::makeString(), Object::registerOwnership(), AttributeHandler::STATEMENT, StringConstant(), and ValueDefinition::ValueDefinition().
Referenced by clone(), operator=(), StringConstant(), StringConstant(), StringConstant(), and StringConstant().
|
virtual |
Definition at line 225 of file StringConstant.cpp.
|
private |
|
private |
Definition at line 213 of file StringConstant.cpp.
References StringConstant(), and ValueDefinition::ValueDefinition().
|
private |
Definition at line 217 of file StringConstant.cpp.
References Object::builtin, Object::itsAttr, Attributes::setString(), StringConstant(), ValueDefinition::value(), and ValueDefinition::ValueDefinition().
|
inlineinherited |
Increment reference count.
Definition at line 83 of file RCObject.h.
References refCount.
Referenced by Pointer< Object >::operator=(), Pointer< Object >::operator=(), and Pointer< Object >::unique().
|
virtual |
Test if object can be replaced.
Reimplemented from Object.
Definition at line 228 of file StringConstant.cpp.
References Object::Object().
|
inherited |
|
virtual |
Make clone.
Implements Object.
Definition at line 232 of file StringConstant.cpp.
References StringConstant().
|
inherited |
Copy attributes from another object.
Definition at line 54 of file Object.cpp.
References itsAttr, and Object().
Referenced by LineTemplate::makeInstance(), and SequenceTemplate::makeInstance().
|
virtualinherited |
Execute the command.
Reimplemented in Beam, BoundaryGeometry, Call, Distribution, DumpEMFields, DumpFields, Echo, FieldSolverCmd, Help, MacroCmd, OpalFilter, Option, PSystem, Quit, Select, Stop, System, Title, TrackCmd, TrackEnd, TrackRun, and Value.
Definition at line 59 of file Object.cpp.
|
virtualinherited |
Find an attribute by name.
Definition at line 64 of file Object.cpp.
References itsAttr.
Referenced by OpalElement::getParticleMatterInteraction(), OpalElement::getTypeName(), OpalElement::getWakeF(), Line::parse(), parse(), OpalElement::parse(), OpalParser::parseAssign(), SequenceParser::parsePosition(), and parseShortcut().
|
virtualinherited |
|
inherited |
Return the object's base type object.
Definition at line 301 of file Object.cpp.
References itsParent, and Object().
|
virtualinherited |
Return logical value.
Reimplemented in BoolConstant.
Definition at line 47 of file ValueDefinition.cpp.
References Object::getOpalName().
|
virtualinherited |
Return indexed logical value.
Definition at line 54 of file ValueDefinition.cpp.
References Object::getOpalName().
|
virtualinherited |
Return the object category as a string.
Implements Object.
Definition at line 32 of file ValueDefinition.cpp.
|
inherited |
Return object name.
Definition at line 308 of file Object.cpp.
References itsName.
Referenced by Macro::clone(), OpalOffset::OpalLocalCartesianOffset::clone(), OpalData::create(), OpalData::define(), Sequence::findDriftLength(), ValueDefinition::getBool(), ValueDefinition::getBoolComponent(), ValueDefinition::getReal(), ValueDefinition::getRealComponent(), ValueDefinition::getString(), ValueDefinition::getStringComponent(), LineTemplate::makeInstance(), makeInstance(), SequenceTemplate::makeInstance(), parse(), SequenceParser::parsePosition(), parseShortcut(), Beam::print(), BoolConstant::print(), Line::print(), print(), OpalElement::print(), OpalFilter::print(), RealConstant::print(), RealVariable::print(), RealVector::print(), Sequence::print(), StringConstant::print(), BoundaryGeometry::printInfo(), FieldSolverCmd::printInfo(), registerOwnership(), OpalElement::registerOwnership(), Line::replace(), Sequence::replace(), Beam::update(), BoundaryGeometry::update(), OpalFilter::update(), OpalOffset::OpalGlobalCartesianOffset::update(), OpalOffset::OpalGlobalCylindricalOffset::update(), OpalOffset::OpalLocalCartesianOffset::update(), and OpalOffset::OpalLocalCylindricalOffset::update().
|
inherited |
Return parent pointer.
Definition at line 313 of file Object.cpp.
References itsParent, and Object().
Referenced by OpalData::erase(), print(), OpalElement::print(), registerOwnership(), and OpalElement::registerOwnership().
|
virtualinherited |
Return real value.
Reimplemented in RealConstant, and RealVariable.
Definition at line 61 of file ValueDefinition.cpp.
References Object::getOpalName().
|
virtualinherited |
Return indexed real value.
Reimplemented in RealVector.
Definition at line 68 of file ValueDefinition.cpp.
References Object::getOpalName().
|
virtual |
Return value.
Reimplemented from ValueDefinition.
Definition at line 236 of file StringConstant.cpp.
References Attributes::getString(), and Object::itsAttr.
Referenced by OpalData::getVariableData(), and Expressions::parseStringValue().
|
virtualinherited |
Return indexed string value.
Definition at line 82 of file ValueDefinition.cpp.
References Object::getOpalName().
|
inherited |
Increment and return the occurrence counter.
Definition at line 344 of file Object.cpp.
References occurrence.
Referenced by Line::parse(), and Sequence::storeLine().
|
inherited |
True, if [b]this[/b] is a built-in object.
Definition at line 266 of file Object.cpp.
References builtin.
Referenced by OpalData::define(), and OpalData::getVariableNames().
|
inherited |
True, if the [b]modified[/b] flag is set.
Definition at line 287 of file Object.cpp.
References modified.
|
inherited |
True, if [b]this[/b] is flagged by setFlag(true).
Definition at line 297 of file Object.cpp.
References flagged.
|
virtualinherited |
Shared flag.
Definition at line 271 of file Object.cpp.
References sharedFlag.
Referenced by Sequence::print().
|
inherited |
Test for tree membership.
Definition at line 318 of file Object.cpp.
References Object().
Referenced by Selector::handleElement(), and OpalParser::parseAssign().
|
virtualinherited |
Macro handler function.
Reimplemented in LineTemplate, MacroCmd, and SequenceTemplate.
Definition at line 89 of file Object.cpp.
References getOpalName(), and Object().
Referenced by OpalParser::parseDefine(), and OpalParser::parseMacro().
|
virtualinherited |
Macro handler function.
Reimplemented in Line, LineTemplate, MacroCmd, Sequence, and SequenceTemplate.
Definition at line 82 of file Object.cpp.
References Object().
Referenced by OpalParser::parseMacro().
|
inherited |
|
private |
References StringConstant(), and ValueDefinition::value().
|
virtualinherited |
Parse the object.
Reimplemented in Call, Echo, Help, Line, OpalElement, PSystem, Sequence, System, Title, and Value.
Definition at line 95 of file Object.cpp.
References Statement::delimiter(), findAttribute(), getOpalName(), Expressions::parseDelimiter(), Expressions::parseRealConst(), and Expressions::parseString().
Referenced by Sequence::parse(), OpalParser::parseAction(), OpalParser::parseDefine(), and SequenceTemplate::parseTemplate().
|
virtualinherited |
Parser for single-attribute commands.
Definition at line 127 of file Object.cpp.
References Statement::delimiter(), findAttribute(), getOpalName(), Statement::mark(), and Statement::word().
Referenced by Call::parse(), Echo::parse(), Help::parse(), PSystem::parse(), System::parse(), Title::parse(), and Value::parse().
|
virtual |
Print the constant.
Reimplemented from Object.
Definition at line 240 of file StringConstant.cpp.
References Object::getOpalName(), and Object::itsAttr.
|
virtualinherited |
Print help.
Definition at line 199 of file Object.cpp.
References gmsg, itsAttr, and itsHelp.
Referenced by Help::execute(), and main().
|
virtual |
Print its value.
Reimplemented from Object.
Definition at line 245 of file StringConstant.cpp.
References Object::itsAttr.
|
inherited |
Definition at line 189 of file Object.cpp.
References AttributeHandler::addAttributeOwner(), end(), getOpalName(), getParent(), and itsAttr.
Referenced by Beam::Beam(), BoolConstant::BoolConstant(), BoundaryGeometry::BoundaryGeometry(), Call::Call(), Distribution::Distribution(), DumpEMFields::DumpEMFields(), DumpFields::DumpFields(), Echo::Echo(), Help::Help(), Line::Line(), OpalFilter::OpalFilter(), Option::Option(), PSystem::PSystem(), RealConstant::RealConstant(), RealVariable::RealVariable(), RealVector::RealVector(), Select::Select(), Sequence::Sequence(), StringConstant::StringConstant(), System::System(), Title::Title(), TrackCmd::TrackCmd(), TrackRun::TrackRun(), and Value::Value().
|
inherited |
Register a reference to this object.
Definition at line 180 of file Object.cpp.
References references.
|
inlineinherited |
Replace references.
Reimplemented in Line, and Sequence.
Definition at line 256 of file Object.cpp.
References Object().
|
inherited |
Set/reset the [b]modified[/b] flag.
Definition at line 281 of file Object.cpp.
References modified.
Referenced by OpalData::define(), OpalData::makeDirty(), and RealVariable::RealVariable().
|
inherited |
Flag/unflag this object, e. g. to control output of objects for.
Definition at line 292 of file Object.cpp.
References flagged.
|
inherited |
Set object name.
Definition at line 329 of file Object.cpp.
References itsName.
Referenced by Beam::update(), BoundaryGeometry::update(), and OpalFilter::update().
|
inherited |
Set parent object.
Definition at line 334 of file Object.cpp.
References itsParent, and Object().
Referenced by OpalData::erase().
|
virtualinherited |
Set/reset shared flag.
Reimplemented in Element.
Definition at line 276 of file Object.cpp.
References sharedFlag.
Referenced by OpalParser::parseDefine(), and Element::setShared().
|
virtualinherited |
|
virtualinherited |
|
inherited |
Unegister a reference to this object.
Definition at line 185 of file Object.cpp.
References references.
|
virtualinherited |
Update this object.
Reimplemented in Beam, BoundaryGeometry, Distribution, FieldSolverCmd, OpalCavity, OpalDrift, OpalElement, OpalFilter, OpalMarker, OpalMonitor, OpalMultipole, OpalMultipoleT, OpalOffset::OpalGlobalCartesianOffset, OpalOffset::OpalGlobalCylindricalOffset, OpalOffset::OpalLocalCartesianOffset, OpalOffset::OpalLocalCylindricalOffset, OpalProbe, OpalRingDefinition, OpalSolenoid, OpalSource, OpalTravelingWave, OpalVacuum, OpalVerticalFFAMagnet, Option, and Sequence.
Definition at line 261 of file Object.cpp.
|
inherited |
Return the attribute representing the value of the definition.
Definition at line 89 of file ValueDefinition.cpp.
References Object::itsAttr.
Referenced by StringConstant::operator=(), RealConstant::RealConstant(), RealVariable::RealVariable(), and StringConstant::StringConstant().
|
inherited |
Return the attribute representing the value of the definition.
Definition at line 94 of file ValueDefinition.cpp.
References Object::itsAttr.
|
protectedinherited |
Built-in flag.
Definition at line 233 of file Object.h.
Referenced by Beam::Beam(), BoundaryGeometry::BoundaryGeometry(), isBuiltin(), Object(), Object(), OpalFilter::OpalFilter(), OpalMarker::OpalMarker(), RealConstant::RealConstant(), StringConstant::StringConstant(), and Table::~Table().
|
protectedinherited |
|
inherited |
The object attributes.
Definition at line 216 of file Object.h.
Referenced by Beam::Beam(), BoolConstant::BoolConstant(), BoundaryGeometry::BoundaryGeometry(), BoundaryGeometry::BoundaryGeometry(), DumpEMFields::buildGrid(), DumpFields::buildGrid(), Call::Call(), copyAttributes(), Distribution::Distribution(), DumpEMFields::DumpEMFields(), DumpFields::DumpFields(), Echo::Echo(), Beam::execute(), Call::execute(), Echo::execute(), Help::execute(), Option::execute(), PSystem::execute(), Select::execute(), System::execute(), Title::execute(), TrackCmd::execute(), TrackRun::execute(), Value::execute(), FieldSolverCmd::FieldSolverCmd(), findAttribute(), findAttribute(), BoundaryGeometry::getA(), OpalElement::getApert(), BoundaryGeometry::getB(), BoolConstant::getBool(), FieldSolverCmd::getBoxIncr(), BoundaryGeometry::getC(), Beam::getCharge(), Beam::getCurrent(), FieldSolverCmd::getDomDec(), TrackCmd::getDT(), TrackCmd::getDTAU(), TrackCmd::getDTSCINIT(), BoundaryGeometry::getFilename(), Beam::getFrequency(), BoundaryGeometry::getL1(), BoundaryGeometry::getL2(), BoundaryGeometry::getLength(), Line::getLength(), OpalElement::getLength(), Sequence::getLength(), Beam::getMass(), TrackCmd::getMaxSteps(), Beam::getNumberOfParticles(), FieldSolverCmd::getNX(), FieldSolverCmd::getNY(), FieldSolverCmd::getNZ(), Beam::getParticleName(), RealConstant::getReal(), RealVariable::getReal(), RealVector::getRealComponent(), Sequence::getReference(), BoundaryGeometry::getS(), TrackCmd::getStepsPerTurn(), StringConstant::getString(), TrackCmd::getT0(), TrackCmd::getTimeIntegrator(), BoundaryGeometry::getTopology(), FieldSolverCmd::getType(), TrackCmd::getZStart(), TrackCmd::getZStop(), Help::Help(), BoundaryGeometry::initialize(), OpalFilter::initOpalFilter(), Line::Line(), Object(), Object(), OpalCavity::OpalCavity(), OpalDrift::OpalDrift(), OpalElement::OpalElement(), OpalFilter::OpalFilter(), OpalOffset::OpalGlobalCartesianOffset::OpalGlobalCartesianOffset(), OpalOffset::OpalGlobalCylindricalOffset::OpalGlobalCylindricalOffset(), OpalOffset::OpalLocalCartesianOffset::OpalLocalCartesianOffset(), OpalOffset::OpalLocalCylindricalOffset::OpalLocalCylindricalOffset(), OpalMultipole::OpalMultipole(), OpalMultipoleT::OpalMultipoleT(), OpalProbe::OpalProbe(), OpalRingDefinition::OpalRingDefinition(), OpalSolenoid::OpalSolenoid(), OpalTravelingWave::OpalTravelingWave(), OpalVacuum::OpalVacuum(), OpalVerticalFFAMagnet::OpalVerticalFFAMagnet(), Option::Option(), Option::Option(), Line::parse(), Sequence::parse(), DumpEMFields::parseCoordinateSystem(), Beam::print(), BoolConstant::print(), DumpEMFields::print(), DumpFields::print(), print(), OpalFilter::print(), RealConstant::print(), RealVariable::print(), RealVector::print(), Sequence::print(), StringConstant::print(), TrackRun::print(), printHelp(), BoundaryGeometry::printInfo(), FieldSolverCmd::printInfo(), BoolConstant::printValue(), RealConstant::printValue(), RealVariable::printValue(), RealVector::printValue(), StringConstant::printValue(), PSystem::PSystem(), RealConstant::RealConstant(), RealConstant::RealConstant(), RealVariable::RealVariable(), RealVariable::RealVariable(), RealVector::RealVector(), registerOwnership(), OpalElement::registerOwnership(), Select::Select(), Select::select(), Sequence::Sequence(), Distribution::setDistParametersFlatTop(), Distribution::setDistParametersMultiVariateGauss(), Distribution::setDistType(), FieldSolverCmd::setNX(), FieldSolverCmd::setNY(), FieldSolverCmd::setNZ(), TrackRun::setRunMethod(), Distribution::setSigmaP_m(), Distribution::setSigmaR_m(), TrackRun::setupBoundaryGeometry(), StringConstant::StringConstant(), StringConstant::StringConstant(), System::System(), Title::Title(), TrackCmd::TrackCmd(), TrackRun::TrackRun(), Beam::update(), FieldSolverCmd::update(), OpalCavity::update(), OpalDrift::update(), OpalElement::update(), OpalMonitor::update(), OpalMultipole::update(), OpalMultipoleT::update(), OpalOffset::OpalGlobalCartesianOffset::update(), OpalOffset::OpalGlobalCylindricalOffset::update(), OpalOffset::OpalLocalCartesianOffset::update(), OpalOffset::OpalLocalCylindricalOffset::update(), OpalProbe::update(), OpalRingDefinition::update(), OpalSolenoid::update(), OpalTravelingWave::update(), OpalVacuum::update(), OpalVerticalFFAMagnet::update(), Option::update(), OpalElement::updateUnknown(), Value::Value(), ValueDefinition::value(), and ValueDefinition::value().
|
privateinherited |
Definition at line 258 of file Object.h.
Referenced by Object(), Object(), and printHelp().
|
privateinherited |
Definition at line 255 of file Object.h.
Referenced by getOpalName(), Object(), Object(), and setOpalName().
|
privateinherited |
Definition at line 252 of file Object.h.
Referenced by getBaseObject(), getParent(), Object(), Object(), and setParent().
|
protectedinherited |
The declaration prefix.
Definition at line 95 of file ValueDefinition.h.
|
protectedinherited |
|
privateinherited |
Definition at line 261 of file Object.h.
Referenced by clear(), increment(), Object(), Object(), and occurrenceCount().
|
mutableprivateinherited |
Definition at line 76 of file RCObject.h.
Referenced by addReference(), isShared(), RCObject(), RCObject(), and removeReference().
|
privateinherited |
Definition at line 268 of file Object.h.
Referenced by registerReference(), unregisterReference(), and ~Object().
|
privateinherited |
Definition at line 271 of file Object.h.
Referenced by isShared(), Object(), Object(), and setShared().