OpalScalingFFAMagnet.h

Go to the documentation of this file.

//
// Class OpalScalingFFAMagnet
//   The class provides the user interface for the SCALINGFFAMAGNET object.
//
// Copyright (c) 2017 - 2023, Chris Rogers, STFC Rutherford Appleton Laboratory, Didcot, UK
// All rights reserved
//
// This file is part of OPAL.
//
// OPAL is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// You should have received a copy of the GNU General Public License
// along with OPAL. If not, see <https://www.gnu.org/licenses/>.
//
#ifndef OPAL_OPALSCALINGFFAMAGNET_H
#define OPAL_OPALSCALINGFFAMAGNET_H

#include "Elements/OpalBend.h"

class OpalScalingFFAMagnet: public OpalElement {

public:
    enum {
        B0 = COMMON,
        R0,
        FIELD_INDEX,
        TAN_DELTA,
        MAX_Y_POWER,
        END_FIELD_MODEL,
        END_LENGTH,
        CENTRE_LENGTH,
        RADIAL_NEG_EXTENT,
        RADIAL_POS_EXTENT,
        HEIGHT,
        MAGNET_START,
        MAGNET_END,
        AZIMUTHAL_EXTENT,
        SIZE // size of the enum
    };

    OpalScalingFFAMagnet();

    virtual ~OpalScalingFFAMagnet();

    virtual OpalScalingFFAMagnet* clone(const std::string& name);

    virtual void update();

private:
    // Not implemented.
    OpalScalingFFAMagnet(const OpalScalingFFAMagnet& );
    void operator=(const OpalScalingFFAMagnet& );

    // Clone constructor.
    OpalScalingFFAMagnet(const std::string& name, OpalScalingFFAMagnet* parent);

    void setupNamedEndField();
    void setupDefaultEndField();
};

#endif // OPAL_OPALSCALINGFFAMAGNET_H