Survey.h

Go to the documentation of this file.

#ifndef OPAL_Survey_HH
#define OPAL_Survey_HH

// ------------------------------------------------------------------------
// $RCSfile: Survey.h,v $
// ------------------------------------------------------------------------
// $Revision: 1.2 $
// ------------------------------------------------------------------------
// Copyright: see Copyright.readme
// ------------------------------------------------------------------------
//
// Class: Survey
//
// ------------------------------------------------------------------------
//
// $Date: 2001/08/13 15:25:22 $
// $Author: jowett $
//
// ------------------------------------------------------------------------

#include "AbstractObjects/Table.h"
#include "AbstractObjects/Expressions.h"
#include "BeamlineGeometry/Euclid3D.h"
#include "Beamlines/FlaggedElmPtr.h"
#include "Beamlines/TBeamline.h"
#include <iosfwd>
#include <vector>

class PlaceRep;
class RangeRep;
class Surveyor;


// Class Survey
// ------------------------------------------------------------------------

class Survey: public Table {

public:

    class Row: public FlaggedElmPtr {

        friend class ::Survey;

    public:

        Row(ElementBase *, int);
        explicit Row(const FlaggedElmPtr &);
        ~Row();

        const Euclid3D &getMap() const;

        double getS() const;

    private:

        Euclid3D euclid;

        double s;
    };

    Survey();

    virtual ~Survey();

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

    virtual void execute();

    virtual void fill();

    virtual double getCell(const PlaceRep &row, const std::string &col);

    virtual CellArray getDefault() const;

    virtual std::vector<double>
    getColumn(const RangeRep &range, const std::string &col);

    const Row &getCurrent() const;


    virtual double getLength();

    virtual const Beamline *getLine() const;

    virtual std::vector<double>
    getRow(const PlaceRep &, const std::vector<std::string> &);


    double getS(const Row &, int = 0, int = 0) const;

    const Euclid3D &getMap(const Row &) const;

    double getX(const Row &, int = 0, int = 0) const;

    double getY(const Row &, int = 0, int = 0) const;

    double getZ(const Row &, int = 0, int = 0) const;

    double getPhi(const Row &, int = 0, int = 0) const;

    double getTheta(const Row &, int = 0, int = 0) const;

    double getPsi(const Row &, int = 0, int = 0) const;

    //  First index (1 ... 3) is coordinate, second index (1 ... 3) is vector.
    double getW(const Row &, int i1, int i2) const;


    //  Return true, if this table depends on the named object.
    virtual bool isDependent(const std::string &name) const;

    //  Return an expression which denotes the selected column,
    //  identified by its name.
    virtual Expressions::PtrToScalar<double>
    makeColumnExpression(const std::string &colName) const;

    //  True, if [b]rhs[/b] is a survey table.
    virtual bool matches(Table *rhs) const;

    virtual void printTable(std::ostream &, const CellArray &) const;

private:

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

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


    // Set the current table row for a given place specification.
    const Row &findRow(const PlaceRep &row);

    // The contained beamline type.
    typedef TBeamline<Row> TLine;

    // Access to current table row.
    mutable TLine::const_iterator current;

    // The table contents.
    TLine *itsTable;

    // The algorithm for filling the buffer.
    Surveyor *itsVisitor;

    // Current accumulated design length.
    double s;

    // The name of the surveyed line.
    std::string itsLine;

    static const int numColumns = 7;
};

#endif // OPAL_Survey_HH