CalorimeterHit.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EICD_CalorimeterHit_H
#define EICD_CalorimeterHit_H
 
#include "eicd/CalorimeterHitConst.h"
#include "eicd/CalorimeterHitObj.h"
 
#include "eicd/Index.h"
#include "eicd/VectorXYZ.h"
#include "podio/ObjectID.h"
#include <ostream>
 
 
 
namespace eic {
 
 
/** @class CalorimeterHit
 *  Calorimeter hit
 *  @author: W. Armstrong, S. Joosten
 */
class CalorimeterHit {
 
  friend class CalorimeterHitCollection;
  friend class CalorimeterHitCollectionIterator;
  friend class ConstCalorimeterHit;
 
public:
 
  /// default constructor
  CalorimeterHit();
  CalorimeterHit(eic::Index ID, std::int64_t cellID, std::int32_t layer, std::int32_t sector, float energy, float energyError, float time, eic::VectorXYZ position, eic::VectorXYZ local, eic::VectorXYZ dimension);
 
  /// constructor from existing CalorimeterHitObj
  CalorimeterHit(CalorimeterHitObj* obj);
 
  /// copy constructor
  CalorimeterHit(const CalorimeterHit& other);
 
  /// copy-assignment operator
  CalorimeterHit& operator=(const CalorimeterHit& other);
 
  /// support cloning (deep-copy)
  CalorimeterHit clone() const;
 
  /// destructor
  ~CalorimeterHit();
 
  /// conversion to const object
  operator ConstCalorimeterHit() 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 layer for this hit
  const std::int32_t& layer() const;
 
  /// Access the sector for this hit
  const std::int32_t& sector() const;
 
  /// Access the The energy for this hit in [GeV].
  const float& energy() const;
 
  /// Access the Error on energy [GeV].
  const float& energyError() const;
 
  /// Access the The time of the hit in [ns].
  const float& time() const;
 
  /// Access the The global position of the hit in world coordinates [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 cell [mm].
  const eic::VectorXYZ& dimension() 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 layer for this hit
  void layer(std::int32_t value);
 
  /// Set the sector for this hit
  void sector(std::int32_t value);
 
  /// Set the The energy for this hit in [GeV].
  void energy(float value);
 
  /// Set the Error on energy [GeV].
  void energyError(float value);
 
  /// Set the The time of the hit in [ns].
  void time(float value);
 
  /// Set the The global position of the hit in world coordinates [mm].
  void position(eic::VectorXYZ value);
  /// Get reference to The global position of the hit in world coordinates [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 cell [mm].
  void dimension(eic::VectorXYZ value);
  /// Get reference to The dimension information of the cell [mm].
  eic::VectorXYZ& dimension();
 
 
 
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from CalorimeterHitObj instance
  void unlink() { m_obj = nullptr; }
 
  bool operator==(const CalorimeterHit& other) const { return m_obj == other.m_obj; }
  bool operator==(const ConstCalorimeterHit& other) const;
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const CalorimeterHit& other) const { return m_obj < other.m_obj; }
 
  unsigned int id() const { return getObjectID().collectionID * 10000000 + getObjectID().index; }
 
  const podio::ObjectID getObjectID() const;
 
private:
  CalorimeterHitObj* m_obj;
};
 
std::ostream& operator<<(std::ostream& o, const ConstCalorimeterHit& value);
 
} // namespace eic
 
 
#endif