The OPTION command. More...
#include <Option.h>
Public Member Functions | |
| Option () | |
| Exemplar constructor. More... | |
| virtual | ~Option () |
| virtual Option * | clone (const std::string &name) |
| Make clone. More... | |
| virtual void | execute () |
| Execute the command. More... | |
 Public Member Functions inherited from Action | |
| virtual | ~Action () |
| virtual bool | canReplaceBy (Object *object) |
| Test if replacement is allowed. 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... | |
| Public Member Functions inherited from Object | |
| virtual | ~Object () |
| void | copyAttributes (const Object &) |
| Copy attributes from another object. 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 &) |
| 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... | |
Private Member Functions | |
| void | handlePsDumpFrame (const std::string &dumpFrame) |
| Option (const Option &) | |
| void | operator= (const Option &) |
| Option (const std::string &name, Option *parent) | |
Additional Inherited Members | |
| Public Attributes inherited from Object | |
| std::vector< Attribute > | itsAttr |
| The object attributes (see Attribute.hh). More... | |
| Protected Member Functions inherited from Action | |
| Action (int size, const char *name, const char *help) | |
| Constructor for exemplars. More... | |
| Action (const std::string &name, Action *parent) | |
| Constructor for cloning. More... | |
| Protected Member Functions inherited from Object | |
| 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 inherited from Object | |
| bool | builtin |
| Built-in flag. More... | |
| bool | modified |
| Dirty flag. More... | |
| bool | flagged |
| Object flag. More... | |
Detailed Description
Constructor & Destructor Documentation
| Option::Option | ( | ) |
Exemplar constructor.
Definition at line 99 of file Option.cpp.
References Options::amr, Options::amrRegridFreq, Options::amrYtDumpFreq, Options::autoPhase, Options::cloTuneOnly, Options::csrDump, Options::cZero, Options::delPartFreq, Options::ebDump, Options::echo, Options::enableHDF5, Options::haloShift, Options::info, Object::itsAttr, Attributes::makeBool(), Attributes::makeReal(), Attributes::makeString(), Options::memoryDump, Options::minBinEmitted, Options::minStepForRebin, Options::mtrace, Options::ppdebug, Options::psDumpEachTurn, Options::psDumpFreq, Options::rebinFreq, Object::registerOwnership(), Options::repartFreq, Options::rhoDump, Options::rngtype, FileStream::setEcho(), Options::statDumpFreq, AttributeHandler::STATEMENT, Options::surfDumpFreq, and Options::warn.
Referenced by clone().
|
virtual |
Definition at line 330 of file Option.cpp.
|
private |
|
private |
Definition at line 283 of file Option.cpp.
References Options::amr, Options::amrRegridFreq, Options::amrYtDumpFreq, Options::asciidump, Options::autoPhase, Options::beamHaloBoundary, Options::boundpDestroyFreq, Options::cloTuneOnly, Options::csrDump, Options::cZero, Options::delPartFreq, DumpFrameToString(), Options::ebDump, Options::echo, Options::enableHDF5, Options::haloShift, Options::idealized, Options::info, Object::itsAttr, Options::memoryDump, Options::mtrace, Options::mtsSubsteps, Options::nLHS, Options::numBlocks, Options::ppdebug, Options::psDumpEachTurn, Options::psDumpFrame, Options::psDumpFreq, Options::rebinFreq, Options::recycleBlocks, Options::remotePartDel, Options::repartFreq, Options::rhoDump, Options::rngtype, Options::scSolveFreq, Options::seed, Attributes::setBool(), Attributes::setReal(), Attributes::setString(), Options::sptDumpFreq, Options::statDumpFreq, Options::surfDumpFreq, Options::version, Options::warn, and Options::writeBendTrajectories.
Member Function Documentation
|
virtual |
Make clone.
Implements Object.
Definition at line 334 of file Option.cpp.
References Option().
|
virtual |
Execute the command.
note: rangen is used only for the random number generator in the OPAL language not for the distributions
note: rangen is used only for the random number generator in the OPAL language not for the distributions
Reimplemented from Object.
Definition at line 339 of file Option.cpp.
References Options::amr, Options::amrRegridFreq, Options::amrYtDumpFreq, Options::asciidump, Options::autoPhase, Options::beamHaloBoundary, Options::cloTuneOnly, Options::csrDump, Options::cZero, Options::delPartFreq, Options::ebDump, Options::echo, Options::enableHDF5, endl(), Attributes::getBool(), IpplMemoryUsage::getInstance(), Attributes::getReal(), Attributes::getString(), Options::haloShift, handlePsDumpFrame(), Options::idealized, Options::info, IpplInfo::Info, Random::init55(), Object::itsAttr, max(), Options::memoryDump, Options::mtrace, Options::mtsSubsteps, Options::nLHS, Options::numBlocks, Inform::on(), Options::ppdebug, Options::psDumpEachTurn, Options::psDumpFreq, Options::rangen, Options::rebinFreq, Options::recycleBlocks, Options::remotePartDel, Options::repartFreq, Options::rhoDump, Options::rngtype, IpplMemoryUsage::sample(), Options::scSolveFreq, Options::seed, FileStream::setEcho(), Options::sptDumpFreq, Options::statDumpFreq, Options::surfDumpFreq, Util::toUpper(), Options::version, Options::warn, IpplInfo::Warn, and Options::writeBendTrajectories.
|
private |
Definition at line 496 of file Option.cpp.
References Options::BUNCH_MEAN, Options::GLOBAL, Options::psDumpFrame, and Options::REFERENCE.
Referenced by execute().
|
private |
The documentation for this class was generated from the following files:
- src/BasicActions/Option.h
- src/BasicActions/Option.cpp
