TravelingWaveRep.h

Go to the documentation of this file.

#ifndef CLASSIC_TravelingWaveRep_HH
#define CLASSIC_TravelingWaveRep_HH

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

#include "AbsBeamline/TravelingWave.h"
#include "BeamlineGeometry/StraightGeometry.h"
#include "Fields/AcceleratingField.h"


// Class TravelingWaveRep
// ------------------------------------------------------------------------

class TravelingWaveRep: public TravelingWave {

public:

    explicit TravelingWaveRep(const std::string &name);

    TravelingWaveRep();
    TravelingWaveRep(const TravelingWaveRep &);
    virtual ~TravelingWaveRep();

    //  Return an identical deep copy of the element.
    virtual ElementBase *clone() const;

    //  This method constructs a Channel permitting read/write access to
    //  the attribute [b]aKey[/b] and returns it.
    //  If the attribute does not exist, it returns NULL.
    virtual Channel *getChannel(const std::string &aKey, bool = false);

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

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

    //  Return the element geometry.
    //  Version for non-constant object.
    virtual StraightGeometry &getGeometry();

    //  Return the element geometry
    //  Version for constant object.
    virtual const StraightGeometry &getGeometry() const;

    //  Return the image of the element, containing the name and type string
    //  of the element, and a copy of the user-defined attributes.
    virtual ElementImage *getImage() const;

    //  Return the RF amplitude in Volts.
    virtual double getAmplitude() const;

    //  Return the RF frequency in Hertz.
    virtual double getFrequency() const;

    //  Return the RF phase in radians.
    virtual double getPhase() const;

    //  Assign the RF amplitude in Volts.
    virtual void setAmplitude(double V);

    //  Assign the RF frequency in Hertz.
    virtual void setFrequency(double f);

    //  Assing the RF phase in radians.
    virtual void setPhase(double phi);

    //  If [b]ignore[/b] is true, cavities are ignored for static calculations.
    static void setIgnore(bool ignore = false);

private:

    // Not implemented.
    void operator=(const TravelingWaveRep &);

    StraightGeometry geometry;

    AcceleratingField field;

    static bool ignoreCavities;
};

#endif // CLASSIC_TravelingWaveRep_HH