Beam.h

Go to the documentation of this file.

#ifndef OPAL_Beam_HH
#define OPAL_Beam_HH

// ------------------------------------------------------------------------
// $RCSfile: Beam.h,v $
// ------------------------------------------------------------------------
// $Revision: 1.1.1.1 $
// ------------------------------------------------------------------------
// Copyright: see Copyright.readme
// ------------------------------------------------------------------------
//
// Class: Beam
//
// ------------------------------------------------------------------------
//
// $Date: 2000/03/27 09:33:44 $
// $Author: Andreas Adelmann $
//
// ------------------------------------------------------------------------

#include "AbstractObjects/Definition.h"
#include "Algorithms/PartData.h"

#include <ostream>

class Inform;

// Class Beam
// ------------------------------------------------------------------------
//  A BEAM definition is used by most physics commands to define the
//  particle charge and the reference momentum, together with some other
//  data.

class Beam: public Definition {

public:

    Beam();

    virtual ~Beam();

    //  Can replace only by another BEAM.
    virtual bool canReplaceBy(Object *object);

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

    virtual void execute();

    static Beam *find(const std::string &name);

    double getEX() const;

    double getEY() const;

    double getET() const;

    //ff => get gamma value
    double getGamma() const;

    //ff => get PC value
    double getPC() const;

    size_t getNumberOfParticles();

    size_t getNumberOfSlices();

    const PartData &getReference() const;

    double getCurrent() const;

    double getCharge() const;

    double getFrequency() const;

    std::string getParticleName() const;

    double getMass() const;

    void setEX(double);

    void setEY(double);

    void setET(double);

    virtual void update();

    void print(std::ostream &os) const;

private:

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

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

    // The particle reference data.
    PartData reference;

    // The converstion from GeV to eV.
    static const double energy_scale;
};

inline std::ostream &operator<<(std::ostream &os, const Beam &b) {
    b.print(os);
    return os;
}


#endif // OPAL_Beam_HH