PatchRep.h

Go to the documentation of this file.

#ifndef CLASSIC_PatchRep_HH
#define CLASSIC_PatchRep_HH

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

#include "AbsBeamline/Patch.h"
#include "BeamlineGeometry/Euclid3D.h"
#include "BeamlineGeometry/NullGeometry.h"
#include "Fields/NullField.h"


// Class PatchRep
// ------------------------------------------------------------------------

class PatchRep: public Patch {

public:

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

    PatchRep();
    PatchRep(const PatchRep &);
    virtual ~PatchRep();

    //  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 NullField &getField();

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

    //  Version for non-constant object.
    virtual NullGeometry &getGeometry();

    //  Version for constant object.
    virtual const NullGeometry &getGeometry() const;

    //  Return the geometric patch to transform from input to output.
    virtual const Euclid3D &getPatch() const;

    //  Assign the geometric patch to transform from input to output.
    void setPatch(const Euclid3D &euclid);

    //  Assign the geometric patch to transform from input to output,
    //  using the displacement (x,y,z) and the rotation vector (vx,vy,vz).
    void setPatch(double x, double y, double z,
                  double vx, double vy, double vz);

    //  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 x-displacement.
    double getX() const;

    //  Return the y-displacement.
    double getY() const;

    //  Return the z-displacement.
    double getZ() const;

    //  Return the rotation around the x-axis
    double getVX() const;

    //  Return the rotation around the y-axis
    double getVY() const;

    //  Return the rotation around the z-axis
    double getVZ() const;

    //  Assign the x-displacement.
    void setX(double);

    //  Assign the y-displacement.
    void setY(double);

    //  Assign the z-displacement.
    void setZ(double);

    //  Assign the rotation around the x-axis
    void setVX(double);

    //  Assign the rotation around the y-axis
    void setVY(double);

    //  Assign the rotation around the z-axis
    void setVZ(double);

private:

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

    NullField field;

    NullGeometry geometry;

    Euclid3D patch;
};

#endif // CLASSIC_PatchRep_HH