ClusterLayerConst.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EICD_ConstClusterLayer_H
#define EICD_ConstClusterLayer_H
 
#include "eicd/ClusterLayerObj.h"
 
#include "eicd/Index.h"
#include "eicd/VectorXYZ.h"
#include "podio/ObjectID.h"
 
 
 
namespace eic {
 
 
/** @class ConstClusterLayer
 *  2D Cluster in a single layer for a multi-layer detector
 *  @author: S. Joosten, C. Peng
 */
class ConstClusterLayer {
 
  friend class ClusterLayer;
  friend class ClusterLayerCollection;
  friend class ClusterLayerConstCollectionIterator;
 
public:
  /// default constructor
  ConstClusterLayer();
  ConstClusterLayer(eic::Index ID, eic::Index clusterID, std::int32_t layer, std::uint32_t nhits, float energy, float energyError, float radius, float skewness, eic::VectorXYZ position);
 
  /// constructor from existing ClusterLayerObj
  ConstClusterLayer(ClusterLayerObj* obj);
 
  /// copy constructor
  ConstClusterLayer(const ConstClusterLayer& other);
 
  /// copy-assignment operator
  ConstClusterLayer& operator=(const ConstClusterLayer& other);
 
  /// support cloning (deep-copy)
  ConstClusterLayer clone() const;
 
  /// destructor
  ~ConstClusterLayer();
 
 
public:
 
  /// Access the unique layer ID
  const eic::Index& ID() const;
 
  /// Access the associated full 3D cluster, -1 if none
  const eic::Index& clusterID() const;
 
  /// Access the layer number for this cluster layer
  const std::int32_t& layer() const;
 
  /// Access the Number of hits
  const std::uint32_t& nhits() const;
 
  /// Access the Energy in this cluster layer [GeV]
  const float& energy() const;
 
  /// Access the Error on energy [GeV]
  const float& energyError() const;
 
  /// Access the Shower radius [mm]
  const float& radius() const;
 
  /// Access the Skewness of hits distribution
  const float& skewness() const;
 
  /// Access the Global center position. [mm]
  const eic::VectorXYZ& position() const;
 
 
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from ClusterLayerObj instance
  void unlink() { m_obj = nullptr; }
 
  bool operator==(const ConstClusterLayer& other) const { return m_obj == other.m_obj; }
  bool operator==(const ClusterLayer& other) const;
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const ConstClusterLayer& other) const { return m_obj < other.m_obj; }
 
  unsigned int id() const { return getObjectID().collectionID * 10000000 + getObjectID().index; }
 
  const podio::ObjectID getObjectID() const;
 
private:
  ClusterLayerObj* m_obj;
};
 
} // namespace eic
 
 
#endif