Line.h

Go to the documentation of this file.

//
// Class Line
//   The LINE definition.
//   A Line contains an OPALX TBeamline<FlaggedElmPtr> which represents the
//   sequence of elements in the line.  The line is always flat in the sense
//   that nested anonymous lines are flattened.
//
// 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_Line_HH
#define OPAL_Line_HH
 
#include "AbsBeamline/ElementBase.h"
#include "AbstractObjects/BeamSequence.h"
#include "Beamlines/FlaggedBeamline.h"
 
class TokenStream;
 
class Line : public BeamSequence {
    friend class LineTemplate;
 
public:
    Line();
 
    virtual ~Line();
 
    //  The new object is an empty line, it will be filled by the parser.
    virtual Line* clone(const std::string& name);
 
    //  Copy also the line list.
    virtual Line* copy(const std::string& name);
 
    virtual double getLength() const;
 
    //  The template gets the name [b]name[/b], [b]is[/b] is ignored,
    //  and the formals and the line list are read from [b]stat[/b].
    virtual Object* makeTemplate(const std::string& name, TokenStream& is, Statement& stat);
 
    //  Read the definition from [b]stat[/b].
    virtual void parse(Statement& stat);
 
    virtual void print(std::ostream& stream) const;
 
private:
    // Not implemented.
    Line(const Line&);
    void operator=(const Line&);
 
    // Clone constructor.
    Line(const std::string& name, Line* parent);
 
    // Return the embedded OPALX beam line.
    // The result it the ideal line.
    virtual FlaggedBeamline* fetchLine() const;
 
    // Parse sub-list.
    void parseList(Statement&);
 
    // Replace references to elements.
    virtual void replace(Object* oldObject, Object* newObject);
};
 
#endif  // OPAL_Line_HH