RawCalorimeterHit.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EICD_RawCalorimeterHit_H
#define EICD_RawCalorimeterHit_H
 
#include "eicd/RawCalorimeterHitConst.h"
#include "eicd/RawCalorimeterHitObj.h"
 
#include "eicd/Index.h"
#include "podio/ObjectID.h"
#include <ostream>
 
 
 
namespace eic {
 
 
/** @class RawCalorimeterHit
 *  Raw (digitized) calorimeter hit
 *  @author: W. Armstrong, S. Joosten
 */
class RawCalorimeterHit {
 
  friend class RawCalorimeterHitCollection;
  friend class RawCalorimeterHitCollectionIterator;
  friend class ConstRawCalorimeterHit;
 
public:
 
  /// default constructor
  RawCalorimeterHit();
  RawCalorimeterHit(eic::Index ID, std::int64_t cellID, std::int64_t amplitude, std::int64_t time);
 
  /// constructor from existing RawCalorimeterHitObj
  RawCalorimeterHit(RawCalorimeterHitObj* obj);
 
  /// copy constructor
  RawCalorimeterHit(const RawCalorimeterHit& other);
 
  /// copy-assignment operator
  RawCalorimeterHit& operator=(const RawCalorimeterHit& other);
 
  /// support cloning (deep-copy)
  RawCalorimeterHit clone() const;
 
  /// destructor
  ~RawCalorimeterHit();
 
  /// conversion to const object
  operator ConstRawCalorimeterHit() const;
 
public:
 
  /// Access the unique ID for this hit
  const eic::Index& ID() const;
 
  /// Access the The detector specific (geometrical) cell id.
  const std::int64_t& cellID() const;
 
  /// Access the The amplitude of the hit in ADC counts.
  const std::int64_t& amplitude() const;
 
  /// Access the Timing in TDC
  const std::int64_t& time() const;
 
 
 
  /// Set the unique ID for this hit
  void ID(eic::Index value);
  /// Get reference to unique ID for this hit
  eic::Index& ID();
 
  /// Set the The detector specific (geometrical) cell id.
  void cellID(std::int64_t value);
 
  /// Set the The amplitude of the hit in ADC counts.
  void amplitude(std::int64_t value);
 
  /// Set the Timing in TDC
  void time(std::int64_t value);
 
 
 
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from RawCalorimeterHitObj instance
  void unlink() { m_obj = nullptr; }
 
  bool operator==(const RawCalorimeterHit& other) const { return m_obj == other.m_obj; }
  bool operator==(const ConstRawCalorimeterHit& other) const;
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const RawCalorimeterHit& other) const { return m_obj < other.m_obj; }
 
  unsigned int id() const { return getObjectID().collectionID * 10000000 + getObjectID().index; }
 
  const podio::ObjectID getObjectID() const;
 
private:
  RawCalorimeterHitObj* m_obj;
};
 
std::ostream& operator<<(std::ostream& o, const ConstRawCalorimeterHit& value);
 
} // namespace eic
 
 
#endif