MutableRingImage.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_MutableRingImage_H
#define EDM4EIC_MutableRingImage_H
 
#include "edm4eic/RingImageObj.h"
// Make the immutable class available from its mutable version but not vice versa
#include "edm4eic/RingImage.h"
 
#include "edm4hep/Vector3f.h"
 
#include "podio/utilities/MaybeSharedPtr.h"
 
#include <cstdint>
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
#include "nlohmann/json_fwd.hpp"
#endif
 
 
 
namespace edm4eic {
 
 
/** @class MutableRingImage
 *  EIC Ring Image Cluster
 *  @author: S. Joosten, C. Peng
 */
class MutableRingImage {
 
  friend class RingImageCollection;
  friend class RingImageMutableCollectionIterator;
  friend class RingImage;
 
public:
  using object_type = RingImage;
  using collection_type = RingImageCollection;
 
  /// default constructor
  MutableRingImage();
 
  /// Constructor initializing all members
  MutableRingImage(float npe, edm4hep::Vector3f position, edm4hep::Vector3f positionError, float theta, float thetaError, float radius, float radiusError);
 
  /// copy constructor
  MutableRingImage(const MutableRingImage& other) = default;
 
  /// copy-assignment operator
  MutableRingImage& operator=(MutableRingImage other);
 
  /// create a mutable deep-copy of the object with identical relations
  /// if cloneRelations=false, the relations are not cloned and will be empty
  MutableRingImage clone(bool cloneRelations=true) const;
 
  /// destructor
  ~MutableRingImage() = default;
 
 
public:
 
  /// Access the Number of photo-electrons [#]
  float getNpe() const;
 
  /// Access the Global position of the cluster [mm]
  const edm4hep::Vector3f& getPosition() const;
 
  /// Access the Error on the position
  const edm4hep::Vector3f& getPositionError() const;
 
  /// Access the Opening angle of the ring [rad, 0->pi]
  float getTheta() const;
 
  /// Access the Error on the opening angle
  float getThetaError() const;
 
  /// Access the Radius of the best fit ring [mm]
  float getRadius() const;
 
  /// Access the Estimated error from the fit [mm]
  float getRadiusError() const;
 
 
 
  /// Set the Number of photo-electrons [#]
  void setNpe(float value);
  /// Get mutable reference to Number of photo-electrons [#]
  float& getNpe();
  /// Get reference to Number of photo-electrons [#]
  [[deprecated("use getNpe instead")]]
  float& npe();
 
  /// Set the Global position of the cluster [mm]
  void setPosition(edm4hep::Vector3f value);
  /// Get mutable reference to Global position of the cluster [mm]
  edm4hep::Vector3f& getPosition();
  /// Get reference to Global position of the cluster [mm]
  [[deprecated("use getPosition instead")]]
  edm4hep::Vector3f& position();
 
  /// Set the Error on the position
  void setPositionError(edm4hep::Vector3f value);
  /// Get mutable reference to Error on the position
  edm4hep::Vector3f& getPositionError();
  /// Get reference to Error on the position
  [[deprecated("use getPositionError instead")]]
  edm4hep::Vector3f& positionError();
 
  /// Set the Opening angle of the ring [rad, 0->pi]
  void setTheta(float value);
  /// Get mutable reference to Opening angle of the ring [rad, 0->pi]
  float& getTheta();
  /// Get reference to Opening angle of the ring [rad, 0->pi]
  [[deprecated("use getTheta instead")]]
  float& theta();
 
  /// Set the Error on the opening angle
  void setThetaError(float value);
  /// Get mutable reference to Error on the opening angle
  float& getThetaError();
  /// Get reference to Error on the opening angle
  [[deprecated("use getThetaError instead")]]
  float& thetaError();
 
  /// Set the Radius of the best fit ring [mm]
  void setRadius(float value);
  /// Get mutable reference to Radius of the best fit ring [mm]
  float& getRadius();
  /// Get reference to Radius of the best fit ring [mm]
  [[deprecated("use getRadius instead")]]
  float& radius();
 
  /// Set the Estimated error from the fit [mm]
  void setRadiusError(float value);
  /// Get mutable reference to Estimated error from the fit [mm]
  float& getRadiusError();
  /// Get reference to Estimated error from the fit [mm]
  [[deprecated("use getRadiusError instead")]]
  float& radiusError();
 
 
 
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from RingImageObj instance
  void unlink() { m_obj = podio::utils::MaybeSharedPtr<RingImageObj>{nullptr}; }
 
  bool operator==(const MutableRingImage& other) const { return m_obj == other.m_obj; }
  bool operator==(const RingImage& other) const;
 
  bool operator!=(const MutableRingImage& other) const { return !(*this == other); }
  bool operator!=(const RingImage& other) const { return !(*this == other); }
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const MutableRingImage& other) const { return m_obj < other.m_obj; }
 
  podio::ObjectID id() const { return getObjectID(); }
 
  const podio::ObjectID getObjectID() const;
 
  friend void swap(MutableRingImage& a, MutableRingImage& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  /// constructor from existing RingImageObj
  explicit MutableRingImage(podio::utils::MaybeSharedPtr<RingImageObj> obj);
 
  podio::utils::MaybeSharedPtr<RingImageObj> m_obj{nullptr};
};
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const MutableRingImage& value);
#endif
 
 
} // namespace edm4eic
 
 
#endif