OpalVariableRFCavity.h

Go to the documentation of this file.

//
// Class OpalVariableRFCavity
//   The class provides the user interface for the VARIABLE_RF_CAVITY object.
//
// Copyright (c) 2014 - 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_OPALVARIABLERFCAVITY_H
#define OPAL_OPALVARIABLERFCAVITY_H
 
#include "Elements/OpalElement.h"
 
class OpalVariableRFCavity : public OpalElement {
public:
    enum {
        PHASE_MODEL = COMMON,
        AMPLITUDE_MODEL,
        FREQUENCY_MODEL,
        WIDTH,
        HEIGHT,
        SIZE  // size of the enum
    };
 
    OpalVariableRFCavity(const std::string& name, OpalVariableRFCavity* parent);
 
    OpalVariableRFCavity();
 
    OpalVariableRFCavity* clone();
 
    OpalVariableRFCavity* clone(const std::string& name) override;
 
    ~OpalVariableRFCavity() override = default;
 
    void update() override;
 
    // Not implemented.
    OpalVariableRFCavity(const OpalVariableRFCavity&) = delete;
    void operator=(const OpalVariableRFCavity&)       = delete;
 
private:
    static const std::string doc_string;
};
 
#endif  // OPAL_OPALVARIABLERFCAVITY_H