Measurement2D.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_Measurement2D_H
#define EDM4EIC_Measurement2D_H
 
#include "edm4eic/Measurement2DObj.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 "podio/detail/OrderKey.h"
 
#include <ostream>
#include <cstdint>
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
#include "nlohmann/json_fwd.hpp"
#endif
 
// forward declarations
namespace edm4eic {
class Measurement2DCollection;
}
 
 
namespace podio::detail {
// Internal function used in less comparison operators of the datatypes and interface types
OrderKey getOrderKey(const edm4eic::Measurement2D& obj);
};
 
namespace edm4eic {
 
class MutableMeasurement2D;
class Measurement2DCollection;
class Measurement2DCollectionData;
 
/** @class Measurement2D
 *  2D measurement (on an arbitrary surface)
 *  @author: W. Deconinck
 */
class Measurement2D {
 
  friend class MutableMeasurement2D;
  friend class Measurement2DCollection;
  friend class edm4eic::Measurement2DCollectionData;
  friend class Measurement2DCollectionIterator;
  friend podio::detail::OrderKey podio::detail::getOrderKey(const Measurement2D & obj);
 
public:
  using mutable_type = MutableMeasurement2D;
  using collection_type = Measurement2DCollection;
 
  /// default constructor
  Measurement2D();
 
  /// Constructor initializing all members
  Measurement2D(std::uint64_t surface, edm4hep::Vector2f loc, float time, edm4eic::Cov3f covariance);
 
  /// copy constructor
  Measurement2D(const Measurement2D& other) = default;
 
  /// copy-assignment operator
  Measurement2D& operator=(Measurement2D 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
  ~Measurement2D() = default;
 
  /// converting constructor from mutable object
  Measurement2D(const MutableMeasurement2D& other);
 
  static Measurement2D makeEmpty();
 
public:
 
  static constexpr auto typeName = "edm4eic::Measurement2D";
 
  /// 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;
 
 
 
  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;
  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 Measurement2D& other) const { return m_obj == other.m_obj; }
  bool operator==(const MutableMeasurement2D& other) const;
 
  bool operator!=(const Measurement2D& other) const { return !(*this == other); }
  bool operator!=(const MutableMeasurement2D& other) const { return !(*this == other); }
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const Measurement2D& other) const { return podio::detail::getOrderKey(*this) < podio::detail::getOrderKey(other); }
 
  podio::ObjectID id() const { return getObjectID(); }
 
  const podio::ObjectID getObjectID() const;
 
  friend void swap(Measurement2D& a, Measurement2D& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  /// constructor from existing Measurement2DObj
  explicit Measurement2D(podio::utils::MaybeSharedPtr<Measurement2DObj> obj);
  Measurement2D(Measurement2DObj* obj);
 
  podio::utils::MaybeSharedPtr<Measurement2DObj> m_obj{nullptr};
};
 
std::ostream& operator<<(std::ostream& o, const Measurement2D& value);
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const Measurement2D& value);
#endif
 
 
} // namespace edm4eic
 
 
#endif