SolenoidRep.h

Go to the documentation of this file.

#ifndef CLASSIC_SolenoidRep_HH
#define CLASSIC_SolenoidRep_HH

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

#include "AbsBeamline/Solenoid.h"
#include "BeamlineGeometry/StraightGeometry.h"
#include "Fields/ConstBzField.h"


// Class SolenoidRep
// ------------------------------------------------------------------------

class SolenoidRep: public Solenoid {

public:

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

    SolenoidRep();
    SolenoidRep(const SolenoidRep &);
    virtual ~SolenoidRep();

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

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

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

    //  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 solenoid field in Teslas.
    virtual double getBz() const;

    //  Assign the solenoid field in Teslas.
    virtual void setBz(double Bz);

private:

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

    StraightGeometry geometry;

    ConstBzField field;
};

#endif // CLASSIC_SolenoidRep_HH