MutableInclusiveKinematics.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_MutableInclusiveKinematics_H
#define EDM4EIC_MutableInclusiveKinematics_H
 
#include "edm4eic/InclusiveKinematicsObj.h"
// Make the immutable class available from its mutable version but not vice versa
#include "edm4eic/InclusiveKinematics.h"
 
 
#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 ReconstructedParticle;
class MutableReconstructedParticle;
}
 
 
namespace edm4eic {
 
 
/** @class MutableInclusiveKinematics
 *  Kinematic variables for DIS events
 *  @author: S. Joosten, W. Deconinck
 */
class MutableInclusiveKinematics {
 
  friend class InclusiveKinematicsCollection;
  friend class InclusiveKinematicsMutableCollectionIterator;
  friend class InclusiveKinematics;
 
public:
  using object_type = InclusiveKinematics;
  using collection_type = InclusiveKinematicsCollection;
 
  /// default constructor
  MutableInclusiveKinematics();
 
  /// Constructor initializing all members
  MutableInclusiveKinematics(float x, float Q2, float W, float y, float nu);
 
  /// copy constructor
  MutableInclusiveKinematics(const MutableInclusiveKinematics& other) = default;
 
  /// copy-assignment operator
  MutableInclusiveKinematics& operator=(MutableInclusiveKinematics 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
  ~MutableInclusiveKinematics() = default;
 
 
public:
 
  /// 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;
 
  /// Set the Bjorken x (Q2/2P.q)
  void setX(float value);
  /// Get mutable reference to Bjorken x (Q2/2P.q)
  float& getX();
  /// Get reference to Bjorken x (Q2/2P.q)
  [[deprecated("use getX instead")]]
  float& x();
 
  /// Set the Four-momentum transfer squared [GeV^2]
  void setQ2(float value);
  /// Get mutable reference to Four-momentum transfer squared [GeV^2]
  float& getQ2();
  /// Get reference to Four-momentum transfer squared [GeV^2]
  [[deprecated("use getQ2 instead")]]
  float& Q2();
 
  /// Set the Invariant mass of final state [GeV]
  void setW(float value);
  /// Get mutable reference to Invariant mass of final state [GeV]
  float& getW();
  /// Get reference to Invariant mass of final state [GeV]
  [[deprecated("use getW instead")]]
  float& W();
 
  /// Set the Inelasticity (P.q/P.k)
  void setY(float value);
  /// Get mutable reference to Inelasticity (P.q/P.k)
  float& getY();
  /// Get reference to Inelasticity (P.q/P.k)
  [[deprecated("use getY instead")]]
  float& y();
 
  /// Set the Energy transfer P.q/M [GeV]
  void setNu(float value);
  /// Get mutable reference to Energy transfer P.q/M [GeV]
  float& getNu();
  /// Get reference to Energy transfer P.q/M [GeV]
  [[deprecated("use getNu instead")]]
  float& nu();
 
 
  /// Set the Associated scattered electron (if identified)
  void setScat(const edm4eic::ReconstructedParticle& value);
 
 
 
 
  /// 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 MutableInclusiveKinematics& other) const { return m_obj == other.m_obj; }
  bool operator==(const InclusiveKinematics& other) const;
 
  bool operator!=(const MutableInclusiveKinematics& other) const { return !(*this == other); }
  bool operator!=(const InclusiveKinematics& other) const { return !(*this == other); }
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const MutableInclusiveKinematics& other) const { return m_obj < other.m_obj; }
 
  podio::ObjectID id() const { return getObjectID(); }
 
  const podio::ObjectID getObjectID() const;
 
  friend void swap(MutableInclusiveKinematics& a, MutableInclusiveKinematics& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  /// constructor from existing InclusiveKinematicsObj
  explicit MutableInclusiveKinematics(podio::utils::MaybeSharedPtr<InclusiveKinematicsObj> obj);
 
  podio::utils::MaybeSharedPtr<InclusiveKinematicsObj> m_obj{nullptr};
};
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const MutableInclusiveKinematics& value);
#endif
 
 
} // namespace edm4eic
 
 
#endif