MutableVertex.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_MutableVertex_H
#define EDM4EIC_MutableVertex_H
 
#include "edm4eic/VertexObj.h"
// Make the immutable class available from its mutable version but not vice versa
#include "edm4eic/Vertex.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 <cstdint>
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
#include "nlohmann/json_fwd.hpp"
#endif
 
// forward declarations
namespace edm4eic {
class VertexCollection;
}
 
 
namespace edm4eic {
 
 
/** @class MutableVertex
 *  EIC vertex
 *  @author: J. Osborn
 */
class MutableVertex {
 
  friend class VertexCollection;
  friend class VertexMutableCollectionIterator;
  friend class Vertex;
 
public:
  using object_type = Vertex;
  using collection_type = VertexCollection;
 
  /// default constructor
  MutableVertex();
 
  /// Constructor initializing all members
  MutableVertex(const std::int32_t type, const float chi2, const int ndf, const edm4hep::Vector4f& position, const edm4eic::Cov4f& positionError);
 
  /// copy constructor
  MutableVertex(const MutableVertex& other) = default;
 
  /// copy-assignment operator
  MutableVertex& operator=(MutableVertex other) &; // Rebind this to other's internal object
  MutableVertex& operator=(MutableVertex other) && = delete; // Prevent rebinding temporary as the changes wouldn't persist
 
  /// 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
  ~MutableVertex() = default;
 
 
public:
 
  /// 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;
 
 
 
  /// Set the Type flag, to identify what type of vertex it is (e.g. primary, secondary, generated, etc.)
  void setType(const std::int32_t type);
  /// Get mutable reference to Type flag, to identify what type of vertex it is (e.g. primary, secondary, generated, etc.)
  std::int32_t& getType();
  /// Get reference to Type flag, to identify what type of vertex it is (e.g. primary, secondary, generated, etc.)
  [[deprecated("use getType instead")]]
  std::int32_t& type();
 
  /// Set the Chi-squared of the vertex fit
  void setChi2(const float chi2);
  /// Get mutable reference to Chi-squared of the vertex fit
  float& getChi2();
  /// Get reference to Chi-squared of the vertex fit
  [[deprecated("use getChi2 instead")]]
  float& chi2();
 
  /// Set the NDF of the vertex fit
  void setNdf(const int ndf);
  /// Get mutable reference to NDF of the vertex fit
  int& getNdf();
  /// Get reference to NDF of the vertex fit
  [[deprecated("use getNdf instead")]]
  int& ndf();
 
  /// Set the position [mm] + time t0 [ns] of the vertex. Time is 4th component in vector
  void setPosition(const edm4hep::Vector4f& position);
  /// Get mutable reference to position [mm] + time t0 [ns] of the vertex. Time is 4th component in vector
  edm4hep::Vector4f& getPosition();
  /// Get reference to position [mm] + time t0 [ns] of the vertex. Time is 4th component in vector
  [[deprecated("use getPosition instead")]]
  edm4hep::Vector4f& position();
 
  /// Set the Covariance matrix of the position+time. Time is 4th component, similarly to 4vector
  void setPositionError(const edm4eic::Cov4f& positionError);
  /// Get mutable reference to Covariance matrix of the position+time. Time is 4th component, similarly to 4vector
  edm4eic::Cov4f& getPositionError();
  /// Get reference to Covariance matrix of the position+time. Time is 4th component, similarly to 4vector
  [[deprecated("use getPositionError instead")]]
  edm4eic::Cov4f& positionError();
 
 
 
  void addToAssociatedParticles(const edm4eic::ReconstructedParticle&);
  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 MutableVertex& other) const { return m_obj == other.m_obj; }
  bool operator==(const Vertex& other) const;
 
  bool operator!=(const MutableVertex& other) const { return !(*this == other); }
  bool operator!=(const Vertex& other) const { return !(*this == other); }
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const MutableVertex& other) const { return podio::detail::getOrderKey(*this) < podio::detail::getOrderKey(other); }
 
  podio::ObjectID id() const { return getObjectID(); }
 
  const podio::ObjectID getObjectID() const;
 
  friend std::hash<MutableVertex>;
 
  friend void swap(MutableVertex& a, MutableVertex& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  /// constructor from existing VertexObj
  explicit MutableVertex(podio::utils::MaybeSharedPtr<VertexObj> obj);
 
  podio::utils::MaybeSharedPtr<VertexObj> m_obj{nullptr};
};
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const MutableVertex& value);
#endif
 
 
} // namespace edm4eic
 
 
 
template<>
struct std::hash<edm4eic::MutableVertex> {
  std::size_t operator()(const edm4eic::MutableVertex& obj) const {
    return std::hash<edm4eic::VertexObj*>{}(obj.m_obj.get());
  }
};
 
 
#endif