/* This file is part of MAUS: http://  micewww.pp.rl.ac.uk:8080/projects/maus
 * 
 * MAUS 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.
 * 
 * MAUS is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with MAUS.  If not, see <http://  www.gnu.org/licenses/>.
 */

/* Author: Peter Lane
 */

#ifndef SRC_COMMON_CPP_OPTICS_OPTICS_MODEL_HH
#define SRC_COMMON_CPP_OPTICS_OPTICS_MODEL_HH

#include "src/common_cpp/Optics/TransferMap.hh"

namespace Json {
  class Value;
}

namespace MAUS {

class OpticsModel {
 public:
  OpticsModel() : configuration_(NULL), primary_plane_(0.) { }
  explicit OpticsModel(Json::Value const * const configuration)
      : configuration_(configuration), primary_plane_(0.) { }
  OpticsModel(Json::Value const * const configuration,
              const double primary_plane)
      : configuration_(configuration), primary_plane_(primary_plane) { }
  virtual ~OpticsModel() { }

  virtual void Build() = 0;

  /* @brief transports a beam envelope (covariance matrix) between the first
   *        simulation plane and the specified end plane.
   *
   * @params covariances the matrix of second moments of the phase space
   *                    variables {t, E, x, Px, y, Py} to be transported
   * @params start_plane the z plane to transport from
   * @params end_plane the z plane to transport to
   */
  virtual CovarianceMatrix Transport(const CovarianceMatrix & covariances,
                                     const double end_plane)
      const = 0;

  /* @brief transports a beam envelope (covariance matrix) between two z planes.
   *
   * @params covariances the matrix of second moments of the phase space
   *                    variables {t, E, x, Px, y, Py} to be transported
   * @params start_plane the z plane to transport from
   * @params end_plane the z plane to transport to
   */
  virtual CovarianceMatrix Transport(const CovarianceMatrix & covariances,
                                     const double start_plane,
                                     const double end_plane)
      const = 0;

  /* @brief transports a phase space vector ({t, E, x, Px, y, Py}) between the first
   *        simulation plane and the specified end plane.
   *
   * @params vector the phase space vector to be transported
   * @params start_plane the z plane to transport from
   * @params end_plane the z plane to transport to
   */
  virtual PhaseSpaceVector Transport(const PhaseSpaceVector & vector,
                                     const double end_plane)
      const = 0;

  /* @brief transports a phase space vector ({t, E, x, Px, y, Py}) between two
   *  z planes.
   *
   * @params vector the phase space vector to be transported
   * @params start_plane the z plane to transport from
   * @params end_plane the z plane to transport to
   */
  virtual PhaseSpaceVector Transport(const PhaseSpaceVector & vector,
                                     const double start_plane,
                                     const double end_plane)
      const = 0;

  Json::Value const * configuration() const {return configuration_;}

  const double primary_plane() const {return primary_plane_;}
  void set_primary_plane(const double primary_plane) {
    primary_plane_ = primary_plane;
  }
 protected:
  Json::Value const * configuration_;
  double primary_plane_;
};
}

#endif