Beamline.h

Go to the documentation of this file.

#ifndef CLASSIC_Beamline_HH
#define CLASSIC_Beamline_HH

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

#include "AbsBeamline/ElementBase.h"
#include "Algorithms/Vektor.h"
#include "Algorithms/Quaternion.h"

class CLRangeError;


// Class Beamline
// ------------------------------------------------------------------------
//  A beam line is built as a list of objects derived from  ElmPtr. Each
//  ElmPtr (``element pointer'') points to a  ElementBase, and may contain
//  additional data describing the position, like lattice functions etc.

class Beamline: public ElementBase {

public:

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

    Beamline();
    Beamline(const Beamline &);
    virtual ~Beamline();

    //  If the parameter [b]reverse[/b] is true, theline is traversed in
    //  reverse direction.  If any error occurs, this method may throw an
    //  exception.
    virtual void iterate(BeamlineVisitor &, bool reverse) const = 0;

    virtual Vector_t getOrigin3D() const;
    virtual Quaternion getInitialDirection() const;
    virtual bool getRelativeFlag() const;
private:

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

#endif // CLASSIC_Beamline_HH