/* 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/>.
 *
 */

/** @class SciFiSpacePoint
 *
 *
 */

#ifndef _SRC_COMMON_CPP_DATASTRUCTURE_SCIFISPACEPOINT_HH_
#define _SRC_COMMON_CPP_DATASTRUCTURE_SCIFISPACEPOINT_HH_


// C++ headers
#include <string>
#include <vector>

// ROOT headers
#include "TObject.h"
#include "TRefArray.h"

// MAUS headers
#include "src/common_cpp/Utils/VersionNumber.hh"
#include "src/common_cpp/DataStructure/SciFiCluster.hh"
#include "src/common_cpp/DataStructure/ThreeVector.hh"

namespace MAUS {

class SciFiSpacePoint : public TObject {
 public:

  /** Default constructor - initialises to 0/NULL */
  SciFiSpacePoint();

  /** Copy constructor - any pointers are deep copied */
  SciFiSpacePoint(const SciFiSpacePoint &_scifispacepoint);

  /** Two cluster constructor  */
  SciFiSpacePoint(SciFiCluster *clust1, SciFiCluster *clust2);

  /** Three cluster constructor  */
  SciFiSpacePoint(SciFiCluster *clust1, SciFiCluster *clust2, SciFiCluster *clust3);

  /** Destructor  */
  virtual ~SciFiSpacePoint();

  /** Assignment operator - any pointers are deep copied */
  SciFiSpacePoint& operator=(const SciFiSpacePoint &_scifispacepoint);

  /** Getters and setters for Spacepoint ID: spill, event, tracker, station */
  void set_spill(int spill) { _spill = spill; }

  int get_spill()   const { return _spill; }

  void set_event(int event) { _event = event; }

  int get_event() const { return _event; }

  void set_tracker(int tracker) { _tracker = tracker; }

  int get_tracker() const { return _tracker; }

  void set_station(int station) { _station = station; }

  int get_station() const { return _station; }

  /** Getters and setters for Spacepoint properties: npe, time, type... */
  void set_npe(double nPE) { _npe = nPE; }

  double get_npe()     const { return _npe; }

  void set_time(double time) { _time = time; }

  double get_time()    const { return _time; }

  void set_time_error(double time_error) { _time_error = time_error; }

  double get_time_error()    const { return _time_error; }

  void set_time_res(double time_res) { _time_res = time_res; }

  double get_time_res()    const { return _time_res; }

  void set_type(std::string type) { _type = type; }

  std::string get_type()  const { return _type; }

  void set_position(ThreeVector position) { _position = position; }

  ThreeVector get_position() const { return _position; }

  void set_global_position(ThreeVector global_position) { _global_position = global_position; }

  ThreeVector get_global_position() const { return _global_position; }

  void set_chi2(double chi2) { _chi2 = chi2; }

  double get_chi2()    const { return _chi2; }

  void set_used() { _used = true; }

  void set_used(bool used) { _used = used; }

  bool is_used() const { return _used; }

  bool get_used() const { return _used; }

  bool get_add_on() const { return _add_on; }

  void set_add_on(bool add_on) { _add_on = add_on; }

  double get_prxy_pull() const { return _prxy_pull; }

  void set_prxy_pull(double prxy_pull) { _prxy_pull = prxy_pull; }

  void add_channel(SciFiCluster *channel);

  void set_channels(TRefArray* channels) { _channels = channels; }

  TRefArray* get_channels() const { return _channels; }

  void set_channels_pointers(const SciFiClusterPArray &channels);

  SciFiClusterPArray get_channels_pointers() const;

 private:
  bool _used;
  bool _add_on; /** If used, was this spacepoint part of the patrec fit */
  int _spill, _event, _tracker, _station;
  double _time, _time_error, _time_res;
  double _npe, _chi2;
  double _prxy_pull; /** Distance of spoint from patrec circle fit */

  std::string _type;

  ThreeVector _position;
  ThreeVector _global_position;

  TRefArray*  _channels;

  MAUS_VERSIONED_CLASS_DEF(SciFiSpacePoint)
};  // Don't forget this trailing colon!!!!

typedef std::vector<SciFiSpacePoint*> SciFiSpacePointPArray;
typedef std::vector< std::vector<SciFiSpacePoint*> > SpacePoint2dPArray;
typedef std::vector<SciFiSpacePoint> SciFiSpacePointArray;

} // ~namespace MAUS

#endif