BasicParticle.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EICD_BasicParticle_H
#define EICD_BasicParticle_H
 
#include "eicd/BasicParticleConst.h"
#include "eicd/BasicParticleObj.h"
 
#include "eicd/Index.h"
#include "eicd/VectorXYZ.h"
#include "eicd/Weight.h"
#include "podio/ObjectID.h"
#include <ostream>
 
 
 
namespace eic {
 
 
/** @class BasicParticle
 *  Basic particle used internally to communicate basic particle properties.
 *  @author: W. Armstrong, S. Joosten
 */
class BasicParticle {
 
  friend class BasicParticleCollection;
  friend class BasicParticleCollectionIterator;
  friend class ConstBasicParticle;
 
public:
 
  /// default constructor
  BasicParticle();
  BasicParticle(eic::Index ID, eic::VectorXYZ p, eic::VectorXYZ v, float time, std::int32_t pid, std::int16_t status, std::int16_t charge, eic::Weight weight);
 
  /// constructor from existing BasicParticleObj
  BasicParticle(BasicParticleObj* obj);
 
  /// copy constructor
  BasicParticle(const BasicParticle& other);
 
  /// copy-assignment operator
  BasicParticle& operator=(const BasicParticle& other);
 
  /// support cloning (deep-copy)
  BasicParticle clone() const;
 
  /// destructor
  ~BasicParticle();
 
  /// conversion to const object
  operator ConstBasicParticle() const;
 
public:
 
  /// Access the Unique particle index
  const eic::Index& ID() const;
 
  /// Access the momentum [GeV]
  const eic::VectorXYZ& p() const;
 
  /// Access the vertex [mm]
  const eic::VectorXYZ& v() const;
 
  /// Access the Time in [ns]
  const float& time() const;
 
  /// Access the particle PDG code
  const std::int32_t& pid() const;
 
  /// Access the Status code
  const std::int16_t& status() const;
 
  /// Access the Particle charge (or sign)
  const std::int16_t& charge() const;
 
  /// Access the Particle weight, e.g. from PID algorithm [0-1]
  const eic::Weight& weight() const;
 
 
 
  /// Set the Unique particle index
  void ID(eic::Index value);
  /// Get reference to Unique particle index
  eic::Index& ID();
 
  /// Set the momentum [GeV]
  void p(eic::VectorXYZ value);
  /// Get reference to momentum [GeV]
  eic::VectorXYZ& p();
 
  /// Set the vertex [mm]
  void v(eic::VectorXYZ value);
  /// Get reference to vertex [mm]
  eic::VectorXYZ& v();
 
  /// Set the Time in [ns]
  void time(float value);
 
  /// Set the particle PDG code
  void pid(std::int32_t value);
 
  /// Set the Status code
  void status(std::int16_t value);
 
  /// Set the Particle charge (or sign)
  void charge(std::int16_t value);
 
  /// Set the Particle weight, e.g. from PID algorithm [0-1]
  void weight(eic::Weight value);
  /// Get reference to Particle weight, e.g. from PID algorithm [0-1]
  eic::Weight& weight();
 
 
 
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from BasicParticleObj instance
  void unlink() { m_obj = nullptr; }
 
  bool operator==(const BasicParticle& other) const { return m_obj == other.m_obj; }
  bool operator==(const ConstBasicParticle& other) const;
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const BasicParticle& other) const { return m_obj < other.m_obj; }
 
  unsigned int id() const { return getObjectID().collectionID * 10000000 + getObjectID().index; }
 
  const podio::ObjectID getObjectID() const;
 
private:
  BasicParticleObj* m_obj;
};
 
std::ostream& operator<<(std::ostream& o, const ConstBasicParticle& value);
 
} // namespace eic
 
 
#endif