Vertex.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_Vertex_H
#define EDM4EIC_Vertex_H
 
#include "edm4eic/VertexObj.h"
 
#include "edm4eic/Cov4f.h"
#include "edm4eic/ReconstructedParticle.h"
#include "edm4hep/Vector4f.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 VertexCollection;
}
 
 
namespace podio::detail {
// Internal function used in less comparison operators of the datatypes and interface types
OrderKey getOrderKey(const edm4eic::Vertex& obj);
};
 
namespace edm4eic {
 
class MutableVertex;
class VertexCollection;
class VertexCollectionData;
 
/** @class Vertex
 *  EIC vertex
 *  @author: J. Osborn
 */
class Vertex {
 
  friend class MutableVertex;
  friend class VertexCollection;
  friend class edm4eic::VertexCollectionData;
  friend class VertexCollectionIterator;
  friend podio::detail::OrderKey podio::detail::getOrderKey(const Vertex & obj);
 
public:
  using mutable_type = MutableVertex;
  using collection_type = VertexCollection;
 
  /// default constructor
  Vertex();
 
  /// Constructor initializing all members
  Vertex(std::int32_t type, float chi2, int ndf, edm4hep::Vector4f position, edm4eic::Cov4f positionError);
 
  /// copy constructor
  Vertex(const Vertex& other) = default;
 
  /// copy-assignment operator
  Vertex& operator=(Vertex other);
 
  /// create a mutable deep-copy of the object with identical relations
  /// if cloneRelations=false, the relations are not cloned and will be empty
  MutableVertex clone(bool cloneRelations=true) const;
 
  /// destructor
  ~Vertex() = default;
 
  /// converting constructor from mutable object
  Vertex(const MutableVertex& other);
 
  static Vertex makeEmpty();
 
public:
 
  static constexpr auto typeName = "edm4eic::Vertex";
 
  /// Access the Type flag, to identify what type of vertex it is (e.g. primary, secondary, generated, etc.)
  std::int32_t getType() const;
 
  /// Access the Chi-squared of the vertex fit
  float getChi2() const;
 
  /// Access the NDF of the vertex fit
  int getNdf() const;
 
  /// Access the position [mm] + time t0 [ns] of the vertex. Time is 4th component in vector
  const edm4hep::Vector4f& getPosition() const;
 
  /// Access the Covariance matrix of the position+time. Time is 4th component, similarly to 4vector
  const edm4eic::Cov4f& getPositionError() const;
 
 
 
  std::size_t associatedParticles_size() const;
  edm4eic::ReconstructedParticle getAssociatedParticles(std::size_t) const;
  std::vector<edm4eic::ReconstructedParticle>::const_iterator associatedParticles_begin() const;
  std::vector<edm4eic::ReconstructedParticle>::const_iterator associatedParticles_end() const;
  podio::RelationRange<edm4eic::ReconstructedParticle> getAssociatedParticles() const;
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from VertexObj instance
  void unlink() { m_obj = podio::utils::MaybeSharedPtr<VertexObj>{nullptr}; }
 
  bool operator==(const Vertex& other) const { return m_obj == other.m_obj; }
  bool operator==(const MutableVertex& other) const;
 
  bool operator!=(const Vertex& other) const { return !(*this == other); }
  bool operator!=(const MutableVertex& other) const { return !(*this == other); }
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const Vertex& 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(Vertex& a, Vertex& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  /// constructor from existing VertexObj
  explicit Vertex(podio::utils::MaybeSharedPtr<VertexObj> obj);
  Vertex(VertexObj* obj);
 
  podio::utils::MaybeSharedPtr<VertexObj> m_obj{nullptr};
};
 
std::ostream& operator<<(std::ostream& o, const Vertex& value);
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const Vertex& value);
#endif
 
 
} // namespace edm4eic
 
 
#endif