MultipoleWrapper.h

Go to the documentation of this file.

#ifndef CLASSIC_MultipoleWrapper_HH
#define CLASSIC_MultipoleWrapper_HH

// ------------------------------------------------------------------------
// $RCSfile: MultipoleWrapper.h,v $
// ------------------------------------------------------------------------
// $Revision: 1.1.1.1 $
// ------------------------------------------------------------------------
// Copyright: see Copyright.readme
// ------------------------------------------------------------------------
//
// Class: MultipoleWrapper
//
// ------------------------------------------------------------------------
// Class category: ComponentWrappers
// ------------------------------------------------------------------------
//
// $Date: 2000/03/27 09:32:35 $
// $Author: fci $
//
// ------------------------------------------------------------------------

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


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

class MultipoleWrapper: public Multipole {

public:

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

    MultipoleWrapper(const MultipoleWrapper &);
    virtual ~MultipoleWrapper();


    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 StraightGeometry &getGeometry();

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

    virtual ElementBase::ElementType getType() const;

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

    //  Version for non-constant object.
    virtual Multipole &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.
    MultipoleWrapper();
    void operator=(const MultipoleWrapper &);

    // The pointer to the ``design'' magnet.
    Pointer<Multipole> itsDesign;

    // The error field.
    mutable BMultipoleField itsError;

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

#endif // CLASSIC_MultipoleWrapper_HH