SourceRep.h

Go to the documentation of this file.

//
// Class SourceRep
//   Representation for a source.
//
// 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 CLASSIC_SOURCEREP_HH
#define CLASSIC_SOURCEREP_HH

#include "AbsBeamline/Source.h"
#include "BeamlineGeometry/StraightGeometry.h"
#include "Fields/NullField.h"


class SourceRep: public Source {

public:

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

    SourceRep();
    SourceRep(const SourceRep &);
    virtual ~SourceRep();

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

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

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

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

private:

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

    // The zero magnetic field.
    NullField field;

    StraightGeometry geometry;
};

#endif // CLASSIC_SOURCEREP_HH