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

The RBEND element. More...

#include <OpalRBend3D.h>

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

Public Types

enum  {
  ANGLE = COMMON, K0, K0S, E1,
  FMAPFN, GAP, HAPERT, DESIGNENERGY,
  SIZE
}
 
- Public Types inherited from OpalElement
enum  {
  TYPE, APERT, LENGTH, ELEMEDGE,
  WAKEF, PARTICLEMATTERINTERACTION, ORIGIN, ORIENTATION,
  X, Y, Z, THETA,
  PHI, PSI, DX, DY,
  DZ, DTHETA, DPHI, DPSI,
  COMMON
}
 The common attributes for all elements. More...
 
enum  ValueFlag { ACTUAL_FLAG, IDEAL_FLAG, ERROR_FLAG }
 Switch for value desired on ATTLIST command. More...
 
- Public Types inherited from Element
enum  ReferenceType { IS_ENTRY, IS_CENTRE, IS_EXIT }
 Reference for element positioning. More...
 

Public Member Functions

 OpalRBend3D ()
 Exemplar constructor. More...
 
virtual ~OpalRBend3D ()
 
virtual OpalRBend3Dclone (const std::string &name)
 Make clone. More...
 
virtual void fillRegisteredAttributes (const ElementBase &, ValueFlag)
 Fill in all registered attributes. More...
 
virtual void update ()
 Update the embedded CLASSIC bend. More...
 
virtual void print (std::ostream &) const
 Print the object. More...
 
- Public Member Functions inherited from OpalElement
virtual ~OpalElement ()
 
virtual double getLength () const
 Return element length. More...
 
const std::string getTypeName () const
 Return the element's type name. More...
 
std::pair
< ElementBase::ApertureType,
std::vector< double > > 
getApert () const
 
const std::string getWakeF () const
 Return the element's type name. More...
 
const std::string getParticleMatterInteraction () const
 
const std::string getWMaterial () const
 
const std::string getWakeGeom () const
 
std::vector< double > getWakeParam () const
 
const std::string getWakeConductivity () const
 
virtual void parse (Statement &)
 Parse the element. More...
 
virtual void updateUnknown (ElementBase *)
 Transmit the ``unknown'' (not known to OPAL) attributes to CLASSIC. More...
 
- Public Member Functions inherited from Element
virtual ~Element ()
 
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...
 
virtual double getEntrance (ReferenceType) const
 Return arc length from origin to entrance (negative !). More...
 
virtual double getExit (ReferenceType) const
 Return arc length from origin to exit (positive !). More...
 
virtual void setShared (bool)
 Set shared flag. More...
 
ElementBasegetElement () const
 Return the embedded CLASSIC element. More...
 
void setElement (ElementBase *)
 Assign new CLASSIC element. More...
 
- Public Member Functions inherited from Object
virtual ~Object ()
 
void copyAttributes (const Object &)
 Copy attributes from another object. More...
 
virtual void execute ()
 Execute the command. 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 parseShortcut (Statement &)
 Parser for single-attribute commands. 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...
 
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 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

 OpalRBend3D (const OpalRBend3D &)
 
void operator= (const OpalRBend3D &)
 
 OpalRBend3D (const std::string &name, OpalRBend3D *parent)
 

Private Attributes

OpalWakeowk_m
 
ParticleMatterInteractionparmatint_m
 

Additional Inherited Members

- Static Public Member Functions inherited from OpalElement
static AttCellfindRegisteredAttribute (const std::string &name)
 Find a registered attribute. More...
 
static void setRegisteredAttribute (const std::string &, double)
 Store a registered real attribute. More...
 
static void setRegisteredAttribute (const std::string &, const std::string &)
 Store a registered string attribute. More...
 
- Static Public Member Functions inherited from Element
static Elementfind (const std::string &name)
 Find named Element. More...
 
- Public Attributes inherited from Object
std::vector< AttributeitsAttr
 The object attributes (see Attribute.hh). More...
 
- Protected Member Functions inherited from OpalElement
 OpalElement (int size, const char *name, const char *help)
 Exemplar constructor. More...
 
 OpalElement (const std::string &name, OpalElement *parent)
 Clone constructor. More...
 
void registerOwnership () const
 
- Protected Member Functions inherited from Element
 Element (int size, const char *name, const char *help)
 Constructor for exemplars. More...
 
 Element (const std::string &name, Element *parent)
 Constructor for clones. 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)
 
- Static Protected Member Functions inherited from OpalElement
static void printMultipoleStrength (std::ostream &os, int order, int &len, const std::string &sName, const std::string &tName, const Attribute &length, const Attribute &vNorm, const Attribute &vSkew)
 Print multipole components in OPAL-8 format. More...
 
static void printAttribute (std::ostream &os, const std::string &name, const std::string &image, int &len)
 Print an attribute with a OPAL-8 name (as an expression). More...
 
static void printAttribute (std::ostream &os, const std::string &name, double value, int &len)
 Print an attribute with a OPAL-8 name (as a constant). More...
 
static AttCellregisterRealAttribute (const std::string &name)
 Register a ``real'' element attribute. More...
 
static AttCellregisterStringAttribute (const std::string &name)
 Register a ``string'' element attribute. More...
 
- Protected Attributes inherited from Object
bool builtin
 Built-in flag. More...
 
bool modified
 Dirty flag. More...
 
bool flagged
 Object flag. More...
 
- Static Protected Attributes inherited from OpalElement
static std::map< std::string,
OwnPtr< AttCell > > 
attributeRegistry
 The registry for named attributes. More...
 

Detailed Description

The RBEND element.

Definition at line 31 of file OpalRBend3D.h.

Member Enumeration Documentation

anonymous enum
Enumerator
ANGLE 
K0 
K0S 
E1 
FMAPFN 
GAP 
HAPERT 
DESIGNENERGY 
SIZE 

Definition at line 35 of file OpalRBend3D.h.

Constructor & Destructor Documentation

OpalRBend3D::OpalRBend3D ( )
OpalRBend3D::~OpalRBend3D ( )
virtual

Definition at line 74 of file OpalRBend3D.cpp.

References owk_m, and parmatint_m.

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

Definition at line 66 of file OpalRBend3D.cpp.

References Element::setElement().

Here is the call graph for this function:

Member Function Documentation

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

Make clone.

Implements Object.

Definition at line 81 of file OpalRBend3D.cpp.

References OpalRBend3D().

Referenced by update().

Here is the call graph for this function:

void OpalRBend3D::fillRegisteredAttributes ( const ElementBase base,
ValueFlag  flag 
)
virtual

Fill in all registered attributes.

Reimplemented from OpalElement.

Definition at line 87 of file OpalRBend3D.cpp.

References OpalElement::fillRegisteredAttributes().

Here is the call graph for this function:

void OpalRBend3D::operator= ( const OpalRBend3D )
private
void OpalRBend3D::print ( std::ostream &  os) const
virtual

Print the object.

Reimplemented from OpalElement.

Definition at line 165 of file OpalRBend3D.cpp.

References OpalElement::print().

Here is the call graph for this function:

void OpalRBend3D::update ( )
virtual

Member Data Documentation

OpalWake* OpalRBend3D::owk_m
private

Definition at line 71 of file OpalRBend3D.h.

Referenced by update(), and ~OpalRBend3D().

ParticleMatterInteraction* OpalRBend3D::parmatint_m
private

Definition at line 72 of file OpalRBend3D.h.

Referenced by update(), and ~OpalRBend3D().


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