Vertex.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EICD_Vertex_H
#define EICD_Vertex_H
 
#include "eicd/VertexConst.h"
#include "eicd/VertexObj.h"
 
#include "eicd/Index.h"
#include "eicd/VectorXYZ.h"
#include "podio/ObjectID.h"
#include <ostream>
 
 
 
namespace eic {
 
 
/** @class Vertex
 *  EIC vertex
 *  @author: W. Armstrong, S. Joosten
 */
class Vertex {
 
  friend class VertexCollection;
  friend class VertexCollectionIterator;
  friend class ConstVertex;
 
public:
 
  /// default constructor
  Vertex();
  Vertex(eic::Index ID, eic::VectorXYZ position, float time, float chi2, float probability, bool primary);
 
  /// constructor from existing VertexObj
  Vertex(VertexObj* obj);
 
  /// copy constructor
  Vertex(const Vertex& other);
 
  /// copy-assignment operator
  Vertex& operator=(const Vertex& other);
 
  /// support cloning (deep-copy)
  Vertex clone() const;
 
  /// destructor
  ~Vertex();
 
  /// conversion to const object
  operator ConstVertex() const;
 
public:
 
  /// Access the unique vertex ID
  const eic::Index& ID() const;
 
  /// Access the postion of vertex [mm]
  const eic::VectorXYZ& position() const;
 
  /// Access the time of vertex [ns]
  const float& time() const;
 
  /// Access the Chi squared of the vertex fit.
  const float& chi2() const;
 
  /// Access the Probability of the vertex fit
  const float& probability() const;
 
  /// Access the Whether it is the primary vertex of the event
  const bool& primary() const;
 
 
 
  /// Set the unique vertex ID
  void ID(eic::Index value);
  /// Get reference to unique vertex ID
  eic::Index& ID();
 
  /// Set the postion of vertex [mm]
  void position(eic::VectorXYZ value);
  /// Get reference to postion of vertex [mm]
  eic::VectorXYZ& position();
 
  /// Set the time of vertex [ns]
  void time(float value);
 
  /// Set the Chi squared of the vertex fit.
  void chi2(float value);
 
  /// Set the Probability of the vertex fit
  void probability(float value);
 
  /// Set the Whether it is the primary vertex of the event
  void primary(bool value);
 
 
 
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from VertexObj instance
  void unlink() { m_obj = nullptr; }
 
  bool operator==(const Vertex& other) const { return m_obj == other.m_obj; }
  bool operator==(const ConstVertex& other) const;
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const Vertex& other) const { return m_obj < other.m_obj; }
 
  unsigned int id() const { return getObjectID().collectionID * 10000000 + getObjectID().index; }
 
  const podio::ObjectID getObjectID() const;
 
private:
  VertexObj* m_obj;
};
 
std::ostream& operator<<(std::ostream& o, const ConstVertex& value);
 
} // namespace eic
 
 
#endif