CyclotronWrapper.h

Go to the documentation of this file.

#ifndef CLASSIC_CyclotronWrapper_HH
#define CLASSIC_CyclotronWrapper_HH

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

#include "AbsBeamline/Cyclotron.h"
#include "BeamlineGeometry/PlanarArcGeometry.h"
#include "Fields/BMultipoleField.h"
#include "MemoryManagement/Pointer.h"

class BMultipoleField;

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

class CyclotronWrapper: public Cyclotron {

public:

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

    CyclotronWrapper(const CyclotronWrapper &);
    virtual ~CyclotronWrapper();


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

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

    virtual double getSlices() const;

    virtual double getStepsize() const;

    virtual ElementBase::ElementType getType() const;

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

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

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

    mutable BMultipoleField itsError;

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

#endif // CLASSIC_CyclotronWrapper_HH