PMTHit.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EICD_PMTHit_H
#define EICD_PMTHit_H
 
#include "eicd/PMTHitConst.h"
#include "eicd/PMTHitObj.h"
 
#include "eicd/Index.h"
#include "eicd/VectorXYZ.h"
#include "podio/ObjectID.h"
#include <ostream>
 
 
 
namespace eic {
 
 
/** @class PMTHit
 *  EIC PMT hit
 *  @author: S. Joosten, C. Peng
 */
class PMTHit {
 
  friend class PMTHitCollection;
  friend class PMTHitCollectionIterator;
  friend class ConstPMTHit;
 
public:
 
  /// default constructor
  PMTHit();
  PMTHit(eic::Index ID, std::int64_t cellID, float npe, float time, float timeError, eic::VectorXYZ position, eic::VectorXYZ local, eic::VectorXYZ dimension);
 
  /// constructor from existing PMTHitObj
  PMTHit(PMTHitObj* obj);
 
  /// copy constructor
  PMTHit(const PMTHit& other);
 
  /// copy-assignment operator
  PMTHit& operator=(const PMTHit& other);
 
  /// support cloning (deep-copy)
  PMTHit clone() const;
 
  /// destructor
  ~PMTHit();
 
  /// conversion to const object
  operator ConstPMTHit() const;
 
public:
 
  /// Access the Unique hit ID
  const eic::Index& ID() const;
 
  /// Access the The detector specific (geometrical) cell id.
  const std::int64_t& cellID() const;
 
  /// Access the estimated number of photo-electrons [#]
  const float& npe() const;
 
  /// Access the Time [ns]
  const float& time() const;
 
  /// Access the Error on the time [ns]
  const float& timeError() const;
 
  /// Access the PMT hit position [mm]
  const eic::VectorXYZ& position() const;
 
  /// Access the The local position of the hit in detector coordinates [mm]
  const eic::VectorXYZ& local() const;
 
  /// Access the The dimension information of the pixel [mm].
  const eic::VectorXYZ& dimension() const;
 
 
 
  /// Set the Unique hit ID
  void ID(eic::Index value);
  /// Get reference to Unique hit ID
  eic::Index& ID();
 
  /// Set the The detector specific (geometrical) cell id.
  void cellID(std::int64_t value);
 
  /// Set the estimated number of photo-electrons [#]
  void npe(float value);
 
  /// Set the Time [ns]
  void time(float value);
 
  /// Set the Error on the time [ns]
  void timeError(float value);
 
  /// Set the PMT hit position [mm]
  void position(eic::VectorXYZ value);
  /// Get reference to PMT hit position [mm]
  eic::VectorXYZ& position();
 
  /// Set the The local position of the hit in detector coordinates [mm]
  void local(eic::VectorXYZ value);
  /// Get reference to The local position of the hit in detector coordinates [mm]
  eic::VectorXYZ& local();
 
  /// Set the The dimension information of the pixel [mm].
  void dimension(eic::VectorXYZ value);
  /// Get reference to The dimension information of the pixel [mm].
  eic::VectorXYZ& dimension();
 
 
 
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from PMTHitObj instance
  void unlink() { m_obj = nullptr; }
 
  bool operator==(const PMTHit& other) const { return m_obj == other.m_obj; }
  bool operator==(const ConstPMTHit& other) const;
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const PMTHit& other) const { return m_obj < other.m_obj; }
 
  unsigned int id() const { return getObjectID().collectionID * 10000000 + getObjectID().index; }
 
  const podio::ObjectID getObjectID() const;
 
private:
  PMTHitObj* m_obj;
};
 
std::ostream& operator<<(std::ostream& o, const ConstPMTHit& value);
 
} // namespace eic
 
 
#endif