InclusiveKinematics.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_InclusiveKinematics_H
#define EDM4EIC_InclusiveKinematics_H
 
#include "edm4eic/InclusiveKinematicsObj.h"
 
 
#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 InclusiveKinematicsCollection;
class ReconstructedParticle;
class MutableReconstructedParticle;
}
 
 
namespace podio::detail {
// Internal function used in less comparison operators of the datatypes and interface types
OrderKey getOrderKey(const edm4eic::InclusiveKinematics& obj);
};
 
namespace edm4eic {
 
class MutableInclusiveKinematics;
class InclusiveKinematicsCollection;
class InclusiveKinematicsCollectionData;
 
/** @class InclusiveKinematics
 *  Kinematic variables for DIS events
 *  @author: S. Joosten, W. Deconinck
 */
class InclusiveKinematics {
 
  friend class MutableInclusiveKinematics;
  friend class InclusiveKinematicsCollection;
  friend class edm4eic::InclusiveKinematicsCollectionData;
  friend class InclusiveKinematicsCollectionIterator;
  friend podio::detail::OrderKey podio::detail::getOrderKey(const InclusiveKinematics & obj);
 
public:
  using mutable_type = MutableInclusiveKinematics;
  using collection_type = InclusiveKinematicsCollection;
 
  /// default constructor
  InclusiveKinematics();
 
  /// Constructor initializing all members
  InclusiveKinematics(float x, float Q2, float W, float y, float nu);
 
  /// copy constructor
  InclusiveKinematics(const InclusiveKinematics& other) = default;
 
  /// copy-assignment operator
  InclusiveKinematics& operator=(InclusiveKinematics other);
 
  /// create a mutable deep-copy of the object with identical relations
  /// if cloneRelations=false, the relations are not cloned and will be empty
  MutableInclusiveKinematics clone(bool cloneRelations=true) const;
 
  /// destructor
  ~InclusiveKinematics() = default;
 
  /// converting constructor from mutable object
  InclusiveKinematics(const MutableInclusiveKinematics& other);
 
  static InclusiveKinematics makeEmpty();
 
public:
 
  static constexpr auto typeName = "edm4eic::InclusiveKinematics";
 
  /// Access the Bjorken x (Q2/2P.q)
  float getX() const;
 
  /// Access the Four-momentum transfer squared [GeV^2]
  float getQ2() const;
 
  /// Access the Invariant mass of final state [GeV]
  float getW() const;
 
  /// Access the Inelasticity (P.q/P.k)
  float getY() const;
 
  /// Access the Energy transfer P.q/M [GeV]
  float getNu() const;
 
 
  /// Access the Associated scattered electron (if identified)
  const edm4eic::ReconstructedParticle getScat() const;
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from InclusiveKinematicsObj instance
  void unlink() { m_obj = podio::utils::MaybeSharedPtr<InclusiveKinematicsObj>{nullptr}; }
 
  bool operator==(const InclusiveKinematics& other) const { return m_obj == other.m_obj; }
  bool operator==(const MutableInclusiveKinematics& other) const;
 
  bool operator!=(const InclusiveKinematics& other) const { return !(*this == other); }
  bool operator!=(const MutableInclusiveKinematics& other) const { return !(*this == other); }
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const InclusiveKinematics& 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(InclusiveKinematics& a, InclusiveKinematics& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  /// constructor from existing InclusiveKinematicsObj
  explicit InclusiveKinematics(podio::utils::MaybeSharedPtr<InclusiveKinematicsObj> obj);
  InclusiveKinematics(InclusiveKinematicsObj* obj);
 
  podio::utils::MaybeSharedPtr<InclusiveKinematicsObj> m_obj{nullptr};
};
 
std::ostream& operator<<(std::ostream& o, const InclusiveKinematics& value);
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const InclusiveKinematics& value);
#endif
 
 
} // namespace edm4eic
 
 
#endif