RBendWrapper.h

Go to the documentation of this file.

#ifndef CLASSIC_RBendWrapper_HH
#define CLASSIC_RBendWrapper_HH

// ------------------------------------------------------------------------
// $RCSfile: RBendWrapper.h,v $
// ------------------------------------------------------------------------
// $Revision: 1.1.1.1.2.1 $
// ------------------------------------------------------------------------
// Copyright: see Copyright.readme
// ------------------------------------------------------------------------
//
// Class: RBendWrapper
//
// ------------------------------------------------------------------------
// Class category: ComponentWrappers
// ------------------------------------------------------------------------
//
// $Date: 2004/11/12 18:57:54 $
// $Author: adelmann $
//
// ------------------------------------------------------------------------

#include "AbsBeamline/RBend.h"
#include "Fields/BMultipoleField.h"
#include "MemoryManagement/Pointer.h"

class BMultipoleField;


// Class RBendWrapper
// ------------------------------------------------------------------------
//  A RBendWrapper represents a unique instance of a bend magnet
//  in the accelerator model. It defines imperfections of the field,
//  related to an ``ideal'' magnet contained in the wrapper.

class RBendWrapper: public RBend {

public:

    //  Constructs a wrapper for its argument.
    //  The wrapper is not sharable by default.
    explicit RBendWrapper(RBend *);

    RBendWrapper(const RBendWrapper &right);
    virtual ~RBendWrapper();


    virtual void accept(BeamlineVisitor &) const;

    virtual ElementBase *clone() const;

    virtual ElementBase *copyStructure();

    //  This method can be used to get or set the error field. The error field
    //  offset is mutable, so as to allow changing it in a constant structure.
    virtual BMultipoleField &errorField() const;

    //  The whole structure depending on [b]this[/b] is marked as sharable.
    //  After this call a [b]copyStructure()[/b] call reuses the element.
    virtual void makeSharable();

    //  Return the perturbed field.
    //  Version for non-constant object.
    virtual BMultipoleField &getField();

    //  Return the perturbed field.
    //  Version for constant object.
    virtual const BMultipoleField &getField() const;

    //  Version for non-constant object.
    virtual RBendGeometry &getGeometry();

    //  Version for constant object.
    virtual const RBendGeometry &getGeometry() const;

    virtual double getB() const;

    //  Return the rotation of the entry pole face with respect to the x-axis.
    //  A positive angle rotates the pole face normal away from the centre
    //  of the machine.
    virtual double getEntryFaceRotation() const;

    //  Return the rotation of the exit pole face with respect to the x-axis.
    //  A positive angle rotates the pole face normal away from the centre
    //  of the machine.
    virtual double getExitFaceRotation() const;

    //  Return the curvature of the entry pole face.
    //  A positive curvature creates a convex pole face.
    virtual double getEntryFaceCurvature() const;

    //  Return the curvature of the exit pole face.
    //  A positive curvature creates a convex pole face.
    virtual double getExitFaceCurvature() const;

    virtual double getSlices() const;

    virtual double getStepsize() const;

    virtual ElementBase::ElementType getType() const;

    //  Version for constant object.
    virtual const RBend &getDesign() const;

    //  Version for non-constant object.
    virtual RBend &getDesign();

    //  Return [b]this[/b], since this is already a field wrapper.
    virtual ElementBase *makeFieldWrapper();

    virtual ElementBase *removeFieldWrapper();

    virtual const ElementBase *removeFieldWrapper() const;

    virtual ElementBase *removeWrappers();

    virtual const ElementBase *removeWrappers() const;

private:

    // Not implemented.
    RBendWrapper();
    void operator=(const RBendWrapper &);

    // The ``design'' magnet.
    Pointer<RBend> itsDesign;

    mutable BMultipoleField itsError;

    // The magnetic field after application of all modifiers.
    mutable BMultipoleField tempField;
};

#endif // CLASSIC_RBendWrapper_HH