TrackCmd.h

Go to the documentation of this file.

//
// Class TrackCmd
//   The class for the OPAL TRACK command.
//
// Copyright (c) 200x - 2022, 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_TrackCmd_HH
#define OPAL_TrackCmd_HH

#include "AbstractObjects/Action.h"
#include "Steppers/Steppers.h"

#include <map>


class TrackCmd: public Action {

public:
    TrackCmd();

    virtual ~TrackCmd();

    virtual TrackCmd* clone(const std::string& name);

    virtual void execute();

    std::vector<double> getDT() const;

    double getDTSCINIT() const;

    double getDTAU() const;

    double getT0() const;

    std::vector<unsigned long long> getMaxSteps() const;

    int getStepsPerTurn() const;

    double getZStart() const;

    std::vector<double> getZStop() const;

    Steppers::TimeIntegrator getTimeIntegrator();

    void setIsParseable(bool isParseable);
private:
    // Not implemented.
    TrackCmd(const TrackCmd&);
    void operator=(const TrackCmd&);

    // Clone constructor.
    TrackCmd(const std::string& name, TrackCmd* parent);

    // When called from python, the track command can't be parsed in the normal
    // way - this is disabled.
    bool isParseable_m = true;
    static const std::map<std::string, Steppers::TimeIntegrator> stringTimeIntegrator_s;
};

#endif // OPAL_TrackCmd_HH