MutableVertex.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EICD_MutableVertex_H
#define EICD_MutableVertex_H
 
#include "eicd/VertexObj.h"
// Make the immutable class available from its mutable version but not vice versa
#include "eicd/Vertex.h"
 
#include "eicd/Cov3f.h"
#include "edm4hep/Vector3f.h"
#include "podio/RelationRange.h"
#include <cstdint>
#include <vector>
#include "podio/ObjectID.h"
#include <ostream>
 
#ifdef PODIO_JSON_OUTPUT
#include "nlohmann/json.hpp"
#endif
 
// forward declarations
namespace eicd {
class ReconstructedParticle;
class MutableReconstructedParticle;
}
 
 
namespace eicd {
 
 
/** @class MutableVertex
 *  EIC vertex
 *  @author: W. Armstrong, S. Joosten, based off EDM4hep
 */
class MutableVertex {
 
  friend class VertexCollection;
  friend class VertexMutableCollectionIterator;
  friend class Vertex;
 
public:
 
  /// default constructor
  MutableVertex();
  MutableVertex(std::int32_t primary, float chi2, float probability, edm4hep::Vector3f position, eicd::Cov3f positionError, std::int32_t algorithmType, float time);
 
  /// constructor from existing VertexObj
  MutableVertex(VertexObj* obj);
 
  /// copy constructor
  MutableVertex(const MutableVertex& other);
 
  /// copy-assignment operator
  MutableVertex& operator=(MutableVertex other);
 
  /// create a mutable deep-copy of the object with identical relations
  MutableVertex clone() const;
 
  /// destructor
  ~MutableVertex();
 
  /// conversion to const object
  operator Vertex() const;
 
public:
 
  /// Access the Boolean flag, if vertex is the primary vertex of the event
  const std::int32_t& getPrimary() const;
 
  /// Access the Chi-squared of the vertex fit
  const float& getChi2() const;
 
  /// Access the Probability of the vertex fit
  const float& getProbability() const;
 
  /// Access the [mm] position of the vertex.
  const edm4hep::Vector3f& getPosition() const;
 
  /// Access the Covariance matrix of the position
  const eicd::Cov3f& getPositionError() const;
 
  /// Access the Type code for the algorithm that has been used to create the vertex - check/set the collection parameters AlgorithmName and AlgorithmType.
  const std::int32_t& getAlgorithmType() const;
 
  /// Access the Vertex time
  const float& getTime() const;
 
 
  /// Access the reconstructed particle associated to this vertex.
  const eicd::ReconstructedParticle getAssociatedParticle() const;
 
  /// Set the Boolean flag, if vertex is the primary vertex of the event
  void setPrimary(std::int32_t value);
 
  /// Set the Chi-squared of the vertex fit
  void setChi2(float value);
 
  /// Set the Probability of the vertex fit
  void setProbability(float value);
 
  /// Set the [mm] position of the vertex.
  void setPosition(edm4hep::Vector3f value);
  /// Get reference to [mm] position of the vertex.
  edm4hep::Vector3f& position();
 
  /// Set the Covariance matrix of the position
  void setPositionError(eicd::Cov3f value);
  /// Get reference to Covariance matrix of the position
  eicd::Cov3f& positionError();
 
  /// Set the Type code for the algorithm that has been used to create the vertex - check/set the collection parameters AlgorithmName and AlgorithmType.
  void setAlgorithmType(std::int32_t value);
 
  /// Set the Vertex time
  void setTime(float value);
 
 
  /// Set the reconstructed particle associated to this vertex.
  void setAssociatedParticle(eicd::ReconstructedParticle value);
 
  void addToParameters(float);
  unsigned int parameters_size() const;
  float getParameters(unsigned int) const;
  std::vector<float>::const_iterator parameters_begin() const;
  std::vector<float>::const_iterator parameters_end() const;
  podio::RelationRange<float> getParameters() const;
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from VertexObj instance
  void unlink() { m_obj = nullptr; }
 
  bool operator==(const MutableVertex& other) const { return m_obj == other.m_obj; }
  bool operator==(const Vertex& other) const;
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const MutableVertex& other) const { return m_obj < other.m_obj; }
 
  unsigned int id() const { return getObjectID().collectionID * 10000000 + getObjectID().index; }
 
  const podio::ObjectID getObjectID() const;
 
  friend void swap(MutableVertex& a, MutableVertex& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  VertexObj* m_obj;
};
 
#ifdef PODIO_JSON_OUTPUT
void to_json(nlohmann::json& j, const MutableVertex& value);
#endif
 
 
} // namespace eicd
 
 
#endif