OpalVariableRFCavityFringeField.h

Go to the documentation of this file.

/* 
 *  Copyright (c) 2018, Chris Rogers
 *  All rights reserved.
 *  Redistribution and use in source and binary forms, with or without 
 *  modification, are permitted provided that the following conditions are met: 
 *  1. Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer. 
 *  2. Redistributions in binary form must reproduce the above copyright notice, 
 *     this list of conditions and the following disclaimer in the documentation 
 *     and/or other materials provided with the distribution.
 *  3. Neither the name of STFC nor the names of its contributors may be used to 
 *     endorse or promote products derived from this software without specific 
 *     prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
 *  POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef OPAL_OPALVARIABLERFCAVITYFRINGEFIELD_H
#define OPAL_OPALVARIABLERFCAVITYFRINGEFIELD_H

#include "Elements/OpalElement.h"

class OpalVariableRFCavityFringeField : public OpalElement {
  public:
    enum {
        PHASE_MODEL = COMMON,
        AMPLITUDE_MODEL,
        FREQUENCY_MODEL,
        WIDTH,
        HEIGHT,
        CENTRE_LENGTH,
        END_LENGTH,
        CAVITY_CENTRE,
        MAX_ORDER,
        SIZE // size of the enum
    };

    OpalVariableRFCavityFringeField(const std::string &name,
                                    OpalVariableRFCavityFringeField *parent);

    OpalVariableRFCavityFringeField();

    OpalVariableRFCavityFringeField* clone();

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

    virtual ~OpalVariableRFCavityFringeField();

    virtual void fillRegisteredAttributes(const ElementBase &, ValueFlag);

    virtual void update();
  private:
    // Not implemented.
    OpalVariableRFCavityFringeField(const OpalVariableRFCavityFringeField &);
    void operator=(const OpalVariableRFCavityFringeField &);

    inline static size_t convertToUnsigned(double value, std::string name);

    static const std::string doc_string;
    static constexpr double unsignedTolerance = 1e-9;
};


#endif // OPAL_OPALVARIABLERFCAVITY_H