CorrectorWrapper.h

Go to the documentation of this file.

#ifndef CLASSIC_CorrectorWrapper_HH
#define CLASSIC_CorrectorWrapper_HH

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

#include "AbsBeamline/Corrector.h"
#include "Fields/BDipoleField.h"
#include "MemoryManagement/Pointer.h"

class BDipoleField;


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

class CorrectorWrapper: public Corrector {

public:

    //  Construct a wrapper for the argument.
    //  The wrapper is not sharable by default.
    CorrectorWrapper(Corrector *);

    CorrectorWrapper(const CorrectorWrapper &);
    virtual ~CorrectorWrapper();


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

    //  Version for non-constant object.
    virtual BDipoleField &getField();

    //  Version for constant object.
    virtual const BDipoleField &getField() const;

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

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

    virtual Plane getPlane() const;

    virtual ElementBase::ElementType getType() const;

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

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

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

    mutable BDipoleField itsError;

    // The magnetic field after application of error.
    mutable BDipoleField tempField;
};

#endif // CLASSIC_CorrectorWrapper_HH