RawPMTHit.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EICD_RawPMTHit_H
#define EICD_RawPMTHit_H
 
#include "eicd/RawPMTHitConst.h"
#include "eicd/RawPMTHitObj.h"
 
#include "eicd/Index.h"
#include "podio/ObjectID.h"
#include <ostream>
 
 
 
namespace eic {
 
 
/** @class RawPMTHit
 *  EIC Raw PMT hit
 *  @author: S. Joosten, C. Peng
 */
class RawPMTHit {
 
  friend class RawPMTHitCollection;
  friend class RawPMTHitCollectionIterator;
  friend class ConstRawPMTHit;
 
public:
 
  /// default constructor
  RawPMTHit();
  RawPMTHit(eic::Index ID, std::int64_t cellID, std::uint32_t amplitude, std::uint32_t time);
 
  /// constructor from existing RawPMTHitObj
  RawPMTHit(RawPMTHitObj* obj);
 
  /// copy constructor
  RawPMTHit(const RawPMTHit& other);
 
  /// copy-assignment operator
  RawPMTHit& operator=(const RawPMTHit& other);
 
  /// support cloning (deep-copy)
  RawPMTHit clone() const;
 
  /// destructor
  ~RawPMTHit();
 
  /// conversion to const object
  operator ConstRawPMTHit() 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 PMT signal amplitude [ADC]
  const std::uint32_t& amplitude() const;
 
  /// Access the PMT signal time [TDC]
  const std::uint32_t& time() 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 PMT signal amplitude [ADC]
  void amplitude(std::uint32_t value);
 
  /// Set the PMT signal time [TDC]
  void time(std::uint32_t value);
 
 
 
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from RawPMTHitObj instance
  void unlink() { m_obj = nullptr; }
 
  bool operator==(const RawPMTHit& other) const { return m_obj == other.m_obj; }
  bool operator==(const ConstRawPMTHit& other) const;
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const RawPMTHit& other) const { return m_obj < other.m_obj; }
 
  unsigned int id() const { return getObjectID().collectionID * 10000000 + getObjectID().index; }
 
  const podio::ObjectID getObjectID() const;
 
private:
  RawPMTHitObj* m_obj;
};
 
std::ostream& operator<<(std::ostream& o, const ConstRawPMTHit& value);
 
} // namespace eic
 
 
#endif