class ElementBase : public RCObject

(Return to index)

Interface for basic beam line object.

This class defines the abstract interface for all objects which can be contained in a beam line. ElementBase forms the base class for two distinct but related hierarchies of objects:

1. A set of concrete accelerator element classes, which compose the standard accelerator component library (SACL).
2. A second hierarchy which parallels the SACL, acting as container or wrapper-like objects. These latter classes are used to construct beam-lines composed of referenced ``design'' components, together with beam-line position dependent extrinsic state (e. g. errors). These wrapper objects are by default unique.

AlignWrapper --> FieldWrapper --> Element

makeAlignWrapper()

make an align wrapper.

makeFieldWrapper()

make a field wrapper.

makeWrappers()

make both wrappers.

removeAlignWrapper()

remove align wrapper.

removeFieldWrapper()

remove field wrapper.

An ElementBase object can return two lengths, which may be different:

1. The arc length along the geometry.
2. The design length, often measured along a straight line.

The class ElementBase has as base class the abstract class RCObject. Virtual derivation is used to make multiple inheritance possible for derived concrete classes. ElementBase implements three copy modes:

1. Copy by reference: Call RCObject::addReference() and use this.
2. Copy structure: use ElementBase::copyStructure(). During copying of the structure, all sharable items are re-used, while all non-sharable ones are cloned.
3. Copy by cloning: use ElementBase::clone(). This returns a full deep copy.

Type:	Abstract
Superclasses:	public RCObject
Include file:	./AbsBeamline/ElementBase.hh

Inheritance

Synopsis (including inherited members):

• Public members:
  • ElementBase (const string&) ;
  • ElementBase () ;
  • ElementBase (const ElementBase&) ;
  • virtual ~ElementBase () ;
  • virtual const string& getName ()const ;
  • virtual void setName (const string&) ;
  • virtual const string& getType ()const = 0 ;
  • virtual Geometry& getGeometry () = 0 ;
  • virtual const Geometry& getGeometry ()const = 0 ;
  • virtual double getArcLength ()const ;
  • virtual double getElementLength ()const ;
  • virtual void setElementLength (double) ;
  • virtual double getOrigin ()const ;
  • virtual double getEntrance ()const ;
  • virtual double getExit ()const ;
  • virtual Euclid3D getTransform (double,double)const ;
  • virtual Euclid3D getTransform (double)const ;
  • virtual Euclid3D getTotalTransform ()const ;
  • virtual Euclid3D getEntranceFrame ()const ;
  • virtual Euclid3D getExitFrame ()const ;
  • virtual Euclid3D getEntrancePatch ()const ;
  • virtual Euclid3D getExitPatch ()const ;
  • virtual double getAttribute (const string&)const ;
  • virtual bool hasAttribute (const string&)const ;
  • virtual void removeAttribute (const string&) ;
  • virtual void setAttribute (const string&,double) ;
  • virtual Channel* getChannel (const string&) ;
  • virtual const ConstChannel* getConstChannel (const string&)const ;
  • virtual ElementImage* getImage ()const ;
  • virtual void accept (BeamlineVisitor&)const = 0 ;
  • virtual ElementBase* clone ()const = 0 ;
  • virtual ElementBase* copyStructure () ;
  • bool isSharable ()const ;
  • virtual void makeSharable () ;
  • virtual ElementBase* makeAlignWrapper () ;
  • virtual ElementBase* makeFieldWrapper () ;
  • virtual ElementBase* makeWrappers () ;
  • virtual ElementBase* removeAlignWrapper () ;
  • virtual const ElementBase* removeAlignWrapper ()const ;
  • virtual ElementBase* removeFieldWrapper () ;
  • virtual const ElementBase* removeFieldWrapper ()const ;
  • virtual ElementBase* removeWrappers () ;
  • virtual const ElementBase* removeWrappers ()const ;
  • bool update (const AttributeSet&) ;
  • int addReference ()const ;
  • int removeReference ()const ;
  • bool isShared ()const ;
• Protected Members:
  • mutable bool shareFlag ;
  • RCObject& operator= (const RCObject&) ;

Documentation:

• Public members:

  ElementBase (const string&) ;

  Constructor with given name.

  virtual void accept (BeamlineVisitor&)const = 0 ;

  Apply visitor.
  This method must be overridden by derived classes. It should call the method of the visitor corresponding to the element class. If any error occurs, this method throws an exception.

  virtual ElementBase* clone ()const = 0 ;

  Return clone.
  Return an identical deep copy of the element.

  virtual ElementBase* copyStructure () ;

  Make a structural copy.
  Return a fresh copy of any beam line structure is made, but sharable elements remain shared.

  virtual double getArcLength ()const ;

  Get arc length.
  Return the entire arc length measured along the design orbit

  virtual double getAttribute (const string&)const ;

  Get attribute value.
  If the attribute does not exist, return zero.

  virtual Channel* getChannel (const string&) ;

  Construct a read/write channel.
  This method constructs a Channel permitting read/write access to the attribute aKey and returns it. If the attribute does not exist, it returns NULL.

  virtual const ConstChannel* getConstChannel (const string&)const ;

  Construct a read-only channel.
  This method constructs a Channel permitting read-only access to the attribute aKey and returns it. If the attribute does not exist, it returns NULL.

  virtual double getElementLength ()const ;

  Get design length.
  Return the design length defined by the geometry. This may be the arc length or the straight length.

  virtual double getEntrance ()const ;

  Get entrance position.
  Return the arc length from the origin to the entrance of the element (entrance <= 0)

  virtual Euclid3D getEntranceFrame ()const ;

  Get transform.
  Equivalent to getTransform(0.0, getEntrance()). Return the transform of the local coordinate system from the origin to the entrance of the element.

  virtual Euclid3D getEntrancePatch ()const ;

  Get patch.
  Returns the entrance patch (transformation) which is used to transform the global geometry to the local geometry for a misaligned element at its entrance. The default behaviour returns identity transformation. This function should be overridden by derived concrete classes which model complex geometries.

  virtual double getExit ()const ;

  Get exit position.
  Return the arc length from the origin to the exit of the element (exit >= 0)

  virtual Euclid3D getExitFrame ()const ;

  Get transform.
  Equivalent to getTransform(0.0, getExit()). Return the transform of the local coordinate system from the origin to the exit of the element.

  virtual Euclid3D getExitPatch ()const ;

  Get patch.
  Returns the entrance patch (transformation) which is used to transform the local geometry to the global geometry for a misaligned element at its exit. The default behaviour returns identity transformation. This function should be overridden by derived concrete classes which model complex geometries.

  virtual Geometry& getGeometry () = 0 ;

  Get geometry.
  Return the element geometry. Version for non-constant object.

  virtual const Geometry& getGeometry ()const = 0 ;

  Get geometry.
  Return the element geometry Version for constant object.

  virtual ElementImage* getImage ()const ;

  Construct an image.
  Return the image of the element, containing the name and type string of the element, and a copy of the user-defined attributes.

  virtual const string& getName ()const ;

  Get element name.

  virtual double getOrigin ()const ;

  Get origin position.
  Return the arc length from the entrance to the origin of the element (origin >= 0)

  virtual Euclid3D getTotalTransform ()const ;

  Get transform.
  Equivalent to getTransform(getEntrance(), getExit()). Return the transform of the local coordinate system from the entrance to the exit of the element.

  virtual Euclid3D getTransform (double,double)const ;

  Get transform.
  Return the transform of the local coordinate system from the position fromS to the position toS.

  virtual Euclid3D getTransform (double)const ;

  Get transform.
  Equivalent to getTransform(0.0, s). Return the transform of the local coordinate system from the origin and s.

  virtual const string& getType ()const = 0 ;

  Get element type string.

  virtual bool hasAttribute (const string&)const ;

  Test for existence of an attribute.
  If the attribute exists, return true, otherwise false.

  bool isSharable ()const ;

  Test if the element can be shared.

  virtual ElementBase* makeAlignWrapper () ;

  Allow misalignment.
  Build an AlignWrapper pointing to the element and return a pointer to that wrapper. If the element cannot be misaligned, or already has an AlignWrapper, return a pointer to the element. Wrappers are non-sharable, unless otherwise defined.

  virtual ElementBase* makeFieldWrapper () ;

  Allow field errors.
  Build a FieldWrapper pointing to the element and return a pointer to that wrapper. If the element cannot have field errors, or already has a FieldWrapper, return a pointer to the element. Wrappers are non-sharable, unless otherwise defined.

  virtual void makeSharable () ;

  Set sharable flag.
  The whole structure depending on this is marked as sharable. After this call a copyStructure() call reuses the element.

  virtual ElementBase* makeWrappers () ;

  Allow errors.
  Equivalent to the calls

  makeFieldWrapper()->makeAlignWrapper()
  

  . Wrappers are non-sharable, unless otherwise defined.

  virtual ElementBase* removeAlignWrapper () ;

  Remove align wrapper.
  Remove the align wrapper.

  virtual const ElementBase* removeAlignWrapper ()const ;

  Remove align wrapper.
  Remove the align wrapper.

  virtual void removeAttribute (const string&) ;

  Remove an existing attribute.

  virtual ElementBase* removeFieldWrapper () ;

  Remove field wrapper.
  Remove the field wrapper.

  virtual const ElementBase* removeFieldWrapper ()const ;

  Remove field wrapper.
  Remove the field wrapper for constant object.

  virtual ElementBase* removeWrappers () ;

  Return the design element.
  Return this, if the element is not wrapped.

  virtual const ElementBase* removeWrappers ()const ;

  Return the design element.
  Return this, if the element is not wrapped.

  virtual void setAttribute (const string&,double) ;

  Set value of an attribute.

  virtual void setElementLength (double) ;

  Set design length.
  Set the design length defined by the geometry. This may be the arc length or the straight length.

  virtual void setName (const string&) ;

  Set element name.

  bool update (const AttributeSet&) ;

  Update element.
  This method stores all attributes contained in the AttributeSet to "*this". The return value true indicates success.

• Protected members: