ClusterLayer.h

Go to the documentation of this file.

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