RingImageConst.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EICD_ConstRingImage_H
#define EICD_ConstRingImage_H
 
#include "eicd/RingImageObj.h"
 
#include "eicd/Index.h"
#include "eicd/VectorXYZ.h"
#include "podio/ObjectID.h"
 
 
 
namespace eic {
 
 
/** @class ConstRingImage
 *  EIC Ring Image Cluster
 *  @author: S. Joosten, C. Peng
 */
class ConstRingImage {
 
  friend class RingImage;
  friend class RingImageCollection;
  friend class RingImageConstCollectionIterator;
 
public:
  /// default constructor
  ConstRingImage();
  ConstRingImage(eic::Index ID, float npe, eic::VectorXYZ position, eic::VectorXYZ positionError, float theta, float thetaError, float radius, float radiusError);
 
  /// constructor from existing RingImageObj
  ConstRingImage(RingImageObj* obj);
 
  /// copy constructor
  ConstRingImage(const ConstRingImage& other);
 
  /// copy-assignment operator
  ConstRingImage& operator=(const ConstRingImage& other);
 
  /// support cloning (deep-copy)
  ConstRingImage clone() const;
 
  /// destructor
  ~ConstRingImage();
 
 
public:
 
  /// Access the Unique cluster ID
  const eic::Index& ID() const;
 
  /// Access the number of photo-electrons [#]
  const float& npe() const;
 
  /// Access the Global position of the cluster [mm]
  const eic::VectorXYZ& position() const;
 
  /// Access the Error on the position
  const eic::VectorXYZ& positionError() const;
 
  /// Access the opening angle of the ring [rad, 0->pi]
  const float& theta() const;
 
  /// Access the error on the opening angle
  const float& thetaError() const;
 
  /// Access the radius of the best fit ring [mm]
  const float& radius() const;
 
  /// Access the estimated error from the fit [mm]
  const float& radiusError() const;
 
 
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from RingImageObj instance
  void unlink() { m_obj = nullptr; }
 
  bool operator==(const ConstRingImage& other) const { return m_obj == other.m_obj; }
  bool operator==(const RingImage& other) const;
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const ConstRingImage& other) const { return m_obj < other.m_obj; }
 
  unsigned int id() const { return getObjectID().collectionID * 10000000 + getObjectID().index; }
 
  const podio::ObjectID getObjectID() const;
 
private:
  RingImageObj* m_obj;
};
 
} // namespace eic
 
 
#endif