SolenoidRep.h

Go to the documentation of this file.

//
// Class SolenoidRep
//   Representation for a solenoid magnet.
//
// Copyright (c) 200x - 2020, Paul Scherrer Institut, Villigen PSI, Switzerland
// All rights reserved
//
// This file is part of OPAL.
//
// OPAL is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// You should have received a copy of the GNU General Public License
// along with OPAL. If not, see <https://www.gnu.org/licenses/>.
//
#ifndef OPALX_SolenoidRep_HH
#define OPALX_SolenoidRep_HH
 
#include "AbsBeamline/Solenoid.h"
#include "BeamlineGeometry/StraightGeometry.h"
#include "Fields/ConstBzField.h"
 
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 nullptr.
    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 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  // OPALX_SolenoidRep_HH