Element.h

Go to the documentation of this file.

//
// Class Element
//   The base class for all OPAL elements.
//   It implements the common behaviour of elements, it can also be used via
//   dynamic casting to determine whether an object represents an element.
//
//   Each Element object contains a pointer to an OPALX beam line element,
//   known as the ``ideal'' element.
//
//   If sharable flag is set, all occurrences of the element are supposed to
//   have the same imperfections.  Thus the assembly is shared when it is used
//   more than once in beam lines or sequences.
//
//   If the sharable flag is not set, each occurrence of the element is supposed
//   to have its own imperfections, but the same ideal representation.
//
// 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 OPAL_Element_HH
#define OPAL_Element_HH
 
#include "AbsBeamline/ElementBase.h"
#include "AbstractObjects/Object.h"
 
#include <memory>
#include <utility>
 
class Element : public Object {
public:
    //  Used in the SEQUENCE command.
    enum ReferenceType {
        IS_ENTRY,   // Reference point is at element entrance.
        IS_CENTRE,  // Reference point is at element centre
        IS_EXIT     // Reference point is at element exit.
    };
 
    virtual ~Element();
 
    //  Return true, if the replacement is also an Element.
    virtual bool canReplaceBy(Object* object);
 
    //  If an element with the name [b]name[/b] exists,
    //  return a pointer to that element.
    //  If no such element exists, throw [b]OpalException[/b].
    static Element* find(const std::string& name);
 
    //  Return the string "ELEMENT".
    virtual const std::string getCategory() const;
 
    //  If true, the object's execute() function should be traced.
    //  Always false for elements.
    virtual bool shouldTrace() const;
 
    //  If true, the data structure should be updated before calling execute().
    //  Always false for elements.
    virtual bool shouldUpdate() const;
 
    virtual double getLength() const = 0;
 
    virtual double getEntrance(ReferenceType) const;
 
    virtual double getExit(ReferenceType) const;
 
    //  If true, all references to this name are to the same object.
    virtual void setShared(bool);
 
    //  Return a pointer to the embedded OPALX ElementBase
    inline ElementBase* getElement() const;
 
    inline std::shared_ptr<ElementBase> getElementPtr() const;
 
    inline void setElement(ElementBase*);
    inline void setElement(std::shared_ptr<ElementBase> base);
 
protected:
    Element(int size, const char* name, const char* help);
 
    Element(const std::string& name, Element* parent);
 
private:
    // Not implemented.
    Element();
    Element(const Element&);
    void operator=(const Element&);
 
    // The embedded OPALX element.
    std::shared_ptr<ElementBase> itsOPALXElement;
};
 
// Inline functions.
// ------------------------------------------------------------------------
 
inline ElementBase* Element::getElement() const { return &*itsOPALXElement; }
 
inline std::shared_ptr<ElementBase> Element::getElementPtr() const { return itsOPALXElement; }
 
inline void Element::setElement(ElementBase* base) {
    if (base == itsOPALXElement.get()) {
        return;
    }
    itsOPALXElement.reset(base);
}
 
inline void Element::setElement(std::shared_ptr<ElementBase> base) {
    itsOPALXElement = std::move(base);
}
 
#endif  // OPAL_Element_HH