MutableMeasurement2D.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_MutableMeasurement2D_H
#define EDM4EIC_MutableMeasurement2D_H
 
#include "edm4eic/Measurement2DObj.h"
// Make the immutable class available from its mutable version but not vice versa
#include "edm4eic/Measurement2D.h"
 
#include "edm4eic/Cov3f.h"
#include "edm4eic/TrackerHit.h"
#include "edm4hep/Vector2f.h"
#include "podio/RelationRange.h"
#include <cstdint>
#include <vector>
 
#include "podio/utilities/MaybeSharedPtr.h"
 
#include <cstdint>
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
#include "nlohmann/json_fwd.hpp"
#endif
 
 
 
namespace edm4eic {
 
 
/** @class MutableMeasurement2D
 *  2D measurement (on an arbitrary surface)
 *  @author: W. Deconinck
 */
class MutableMeasurement2D {
 
  friend class Measurement2DCollection;
  friend class Measurement2DMutableCollectionIterator;
  friend class Measurement2D;
 
public:
  using object_type = Measurement2D;
  using collection_type = Measurement2DCollection;
 
  /// default constructor
  MutableMeasurement2D();
 
  /// Constructor initializing all members
  MutableMeasurement2D(std::uint64_t surface, edm4hep::Vector2f loc, float time, edm4eic::Cov3f covariance);
 
  /// copy constructor
  MutableMeasurement2D(const MutableMeasurement2D& other) = default;
 
  /// copy-assignment operator
  MutableMeasurement2D& operator=(MutableMeasurement2D other);
 
  /// create a mutable deep-copy of the object with identical relations
  /// if cloneRelations=false, the relations are not cloned and will be empty
  MutableMeasurement2D clone(bool cloneRelations=true) const;
 
  /// destructor
  ~MutableMeasurement2D() = default;
 
 
public:
 
  /// Access the Surface for bound coordinates (geometryID)
  std::uint64_t getSurface() const;
 
  /// Access the 2D location on surface
  const edm4hep::Vector2f& getLoc() const;
 
  /// Access the Measurement time
  float getTime() const;
 
  /// Access the Covariance on location and time
  const edm4eic::Cov3f& getCovariance() const;
 
 
 
  /// Set the Surface for bound coordinates (geometryID)
  void setSurface(std::uint64_t value);
  /// Get mutable reference to Surface for bound coordinates (geometryID)
  std::uint64_t& getSurface();
  /// Get reference to Surface for bound coordinates (geometryID)
  [[deprecated("use getSurface instead")]]
  std::uint64_t& surface();
 
  /// Set the 2D location on surface
  void setLoc(edm4hep::Vector2f value);
  /// Get mutable reference to 2D location on surface
  edm4hep::Vector2f& getLoc();
  /// Get reference to 2D location on surface
  [[deprecated("use getLoc instead")]]
  edm4hep::Vector2f& loc();
 
  /// Set the Measurement time
  void setTime(float value);
  /// Get mutable reference to Measurement time
  float& getTime();
  /// Get reference to Measurement time
  [[deprecated("use getTime instead")]]
  float& time();
 
  /// Set the Covariance on location and time
  void setCovariance(edm4eic::Cov3f value);
  /// Get mutable reference to Covariance on location and time
  edm4eic::Cov3f& getCovariance();
  /// Get reference to Covariance on location and time
  [[deprecated("use getCovariance instead")]]
  edm4eic::Cov3f& covariance();
 
 
 
  void addToHits(const edm4eic::TrackerHit&);
  std::size_t hits_size() const;
  edm4eic::TrackerHit getHits(std::size_t) const;
  std::vector<edm4eic::TrackerHit>::const_iterator hits_begin() const;
  std::vector<edm4eic::TrackerHit>::const_iterator hits_end() const;
  podio::RelationRange<edm4eic::TrackerHit> getHits() const;
  void addToWeights(const float&);
  std::size_t weights_size() const;
  float getWeights(std::size_t) const;
  std::vector<float>::const_iterator weights_begin() const;
  std::vector<float>::const_iterator weights_end() const;
  podio::RelationRange<float> getWeights() const;
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from Measurement2DObj instance
  void unlink() { m_obj = podio::utils::MaybeSharedPtr<Measurement2DObj>{nullptr}; }
 
  bool operator==(const MutableMeasurement2D& other) const { return m_obj == other.m_obj; }
  bool operator==(const Measurement2D& other) const;
 
  bool operator!=(const MutableMeasurement2D& other) const { return !(*this == other); }
  bool operator!=(const Measurement2D& other) const { return !(*this == other); }
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const MutableMeasurement2D& other) const { return m_obj < other.m_obj; }
 
  podio::ObjectID id() const { return getObjectID(); }
 
  const podio::ObjectID getObjectID() const;
 
  friend void swap(MutableMeasurement2D& a, MutableMeasurement2D& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  /// constructor from existing Measurement2DObj
  explicit MutableMeasurement2D(podio::utils::MaybeSharedPtr<Measurement2DObj> obj);
 
  podio::utils::MaybeSharedPtr<Measurement2DObj> m_obj{nullptr};
};
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const MutableMeasurement2D& value);
#endif
 
 
} // namespace edm4eic
 
 
#endif