OPAL (Object Oriented Parallel Accelerator Library)  2.2.0
OPAL
Public Member Functions | Private Member Functions | List of all members
Twiss3 Class Reference

The TWISS3 command. More...

#include <Twiss3.h>

Inheritance diagram for Twiss3:
Inheritance graph
[legend]
Collaboration diagram for Twiss3:
Collaboration graph
[legend]

Public Member Functions

 Twiss3 ()
 Exemplar constructor. More...
 
virtual ~Twiss3 ()
 
virtual Twiss3clone (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 AttributefindAttribute (const std::string &name)
 Find an attribute by name. More...
 
virtual const AttributefindAttribute (const std::string &name) const
 Find an attribute by name. More...
 
virtual ObjectmakeTemplate (const std::string &, TokenStream &, Statement &)
 Macro handler function. More...
 
virtual ObjectmakeInstance (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 ObjectgetBaseObject () const
 Return the object's base type object. More...
 
const std::string & getOpalName () const
 Return object name. More...
 
ObjectgetParent () 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

 Twiss3 (const Twiss3 &)
 
void operator= (const Twiss3 &)
 
 Twiss3 (const std::string &name, Twiss3 *parent)
 
void format (std::ostream &, const Twiss *)
 
void formatPrint (std::ostream &, const Twiss *) const
 Print Twiss table in Mais-Ripken representation. More...
 

Additional Inherited Members

- Public Attributes inherited from Object
std::vector< AttributeitsAttr
 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
 
RCObjectoperator= (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

The TWISS3 command.

Definition at line 32 of file Twiss3.h.

Constructor & Destructor Documentation

Twiss3::Twiss3 ( )

Exemplar constructor.

Definition at line 46 of file Twiss3.cpp.

References Attrib::Distribution::FNAME, Object::itsAttr, Attributes::makeString(), Object::registerOwnership(), and AttributeHandler::STATEMENT.

Referenced by clone().

Here is the call graph for this function:

Twiss3::~Twiss3 ( )
virtual

Definition at line 64 of file Twiss3.cpp.

Twiss3::Twiss3 ( const Twiss3 )
private
Twiss3::Twiss3 ( const std::string &  name,
Twiss3 parent 
)
private

Definition at line 59 of file Twiss3.cpp.

Member Function Documentation

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

Make clone.

Implements Object.

Definition at line 68 of file Twiss3.cpp.

References Twiss3().

Here is the call graph for this function:

void Twiss3::execute ( )
virtual

Execute the command.

Reimplemented from Object.

Definition at line 73 of file Twiss3.cpp.

References OpalData::find(), Attrib::Distribution::FNAME, format(), OpalData::getInstance(), Attributes::getString(), and Object::itsAttr.

Here is the call graph for this function:

void Twiss3::format ( std::ostream &  os,
const Twiss table 
)
private

Definition at line 99 of file Twiss3.cpp.

References formatPrint().

Referenced by execute().

Here is the call graph for this function:

void Twiss3::formatPrint ( std::ostream &  os,
const Twiss table 
) const
private

Print Twiss table in Mais-Ripken representation.

Definition at line 104 of file Twiss3.cpp.

References Twiss::begin(), Twiss::end(), endl(), Twiss::getALFik(), Twiss::getBETik(), Twiss::getGAMik(), Twiss::getMUi(), Twiss::getOrbit(), Twiss::getS(), name, Inform::precision(), and Twiss::printTableTitle().

Referenced by format().

Here is the call graph for this function:

void Twiss3::operator= ( const Twiss3 )
private

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