DefaultVisitor.h

Go to the documentation of this file.

//
// Class DefaultVisitor
//   The default interface for a BeamlineVisitor.
//   A default implementation for all visitors that can iterate over a
//   beam line representation.
//   This abstract base class implements the default behaviour for the
//   structural classes Beamline and FlaggedElmPtr.
//   It also holds the data required for all visitors in a protected area.
//
// 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_DefaultVisitor_HH
#define CLASSIC_DefaultVisitor_HH
 
#include "AbsBeamline/BeamlineVisitor.h"
 
class ElementBase;
 
class DefaultVisitor: public BeamlineVisitor {
 
public:
 
    //  Arguments:
    //  [ol]
    //  [li]The beamline to be used.
    //  [li]If true, the beam runs backwards through the line.
    //  [li]If true, we track against the beam.
    //  [/ol]
    DefaultVisitor(const Beamline &beamline, bool backBeam, bool backTrack);
 
    virtual ~DefaultVisitor() = 0;
 
    virtual void execute();
 
    virtual void visitBeamline(const Beamline &);
    
    virtual void visitCCollimator(const CCollimator &);
 
    virtual void visitComponent(const Component &);
 
    virtual void visitCorrector(const Corrector &);
 
    virtual void visitCyclotron(const Cyclotron &);
 
    virtual void visitDegrader(const Degrader &);
 
    virtual void visitDrift(const Drift &);
 
    virtual void visitFlaggedElmPtr(const FlaggedElmPtr &);
    
    virtual void visitFlexibleCollimator(const FlexibleCollimator &);
 
    virtual void visitMarker(const Marker &);
 
    virtual void visitMonitor(const Monitor &);
 
    virtual void visitMultipole(const Multipole &);
 
    virtual void visitMultipoleT(const MultipoleT &);
 
    virtual void visitMultipoleTStraight(const MultipoleTStraight &);
 
    virtual void visitMultipoleTCurvedConstRadius(const MultipoleTCurvedConstRadius &);
 
    virtual void visitMultipoleTCurvedVarRadius(const MultipoleTCurvedVarRadius &);
 
    virtual void visitOffset(const Offset &);
 
    virtual void visitProbe(const Probe &prob);
 
    virtual void visitRBend(const RBend &);
 
    virtual void visitRBend3D(const RBend3D &);
 
    virtual void visitRFCavity(const RFCavity &);
 
    virtual void visitRing(const Ring &);
 
    virtual void visitSBend(const SBend &);
 
    virtual void visitSBend3D(const SBend3D &);
 
    virtual void visitScalingFFAMagnet(const ScalingFFAMagnet &);
 
    virtual void visitSeptum(const Septum &);
 
    virtual void visitSolenoid(const Solenoid &);
 
    virtual void visitSource(const Source &);
 
    virtual void visitStripper(const Stripper &);
 
    virtual void visitTravelingWave(const TravelingWave &);
 
#ifdef ENABLE_OPAL_FEL
    virtual void visitUndulator(const Undulator &);
#endif
 
    virtual void visitVacuum(const Vacuum &);
 
    virtual void visitVariableRFCavity(const VariableRFCavity &vcav);
 
    virtual void visitVariableRFCavityFringeField(const VariableRFCavityFringeField &vcav);
 
    virtual void visitVerticalFFAMagnet(const VerticalFFAMagnet &);
 
protected:
 
    // The top level beamline.
    const Beamline &itsLine;
 
    // The direction flags and corresponding factors.
    bool back_beam;   // true, if beam runs from right (s=C) to left (s=0).
    bool back_track;  // true, if tracking opposite to the beam direction.
    bool back_path;   // true, if tracking from right (s=C) to left (s=0).
    // back_path = back_beam && ! back_track || back_track && ! back_beam.
 
    double flip_B;    // set to -1.0 to flip B fields, when back_beam is true.
    double flip_s;    // set to -1.0 to flip direction of s,
    // when back_path is true.
 
private:
 
    // Not implemented.
    DefaultVisitor();
    DefaultVisitor(const DefaultVisitor &);
    void operator=(const DefaultVisitor &);
 
    // Default do-nothing routine.
    virtual void applyDefault(const ElementBase &);
 
    // The element order flag. Initially set to back_path.
    // This flag is reversed locally for reflected beam lines.
    bool local_flip;
};
 
#endif // CLASSIC_DefaultVisitor_HH