MutableHadronicFinalState.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_MutableHadronicFinalState_H
#define EDM4EIC_MutableHadronicFinalState_H
 
#include "edm4eic/HadronicFinalStateObj.h"
// Make the immutable class available from its mutable version but not vice versa
#include "edm4eic/HadronicFinalState.h"
 
#include "edm4eic/ReconstructedParticle.h"
#include "podio/RelationRange.h"
#include <vector>
 
#include "podio/utilities/MaybeSharedPtr.h"
 
#include <cstdint>
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
#include "nlohmann/json_fwd.hpp"
#endif
 
 
 
namespace edm4eic {
 
 
/** @class MutableHadronicFinalState
 *  Summed quantities of the hadronic final state
 *  @author: T. Kutz
 */
class MutableHadronicFinalState {
 
  friend class HadronicFinalStateCollection;
  friend class HadronicFinalStateMutableCollectionIterator;
  friend class HadronicFinalState;
 
public:
  using object_type = HadronicFinalState;
  using collection_type = HadronicFinalStateCollection;
 
  /// default constructor
  MutableHadronicFinalState();
 
  /// Constructor initializing all members
  MutableHadronicFinalState(float sigma, float pT, float gamma);
 
  /// copy constructor
  MutableHadronicFinalState(const MutableHadronicFinalState& other) = default;
 
  /// copy-assignment operator
  MutableHadronicFinalState& operator=(MutableHadronicFinalState other);
 
  /// create a mutable deep-copy of the object with identical relations
  /// if cloneRelations=false, the relations are not cloned and will be empty
  MutableHadronicFinalState clone(bool cloneRelations=true) const;
 
  /// destructor
  ~MutableHadronicFinalState() = default;
 
 
public:
 
  /// Access the Longitudinal energy-momentum balance (aka E - pz)
  float getSigma() const;
 
  /// Access the Transverse momentum
  float getPT() const;
 
  /// Access the Hadronic angle
  float getGamma() const;
 
 
 
  /// Set the Longitudinal energy-momentum balance (aka E - pz)
  void setSigma(float value);
  /// Get mutable reference to Longitudinal energy-momentum balance (aka E - pz)
  float& getSigma();
  /// Get reference to Longitudinal energy-momentum balance (aka E - pz)
  [[deprecated("use getSigma instead")]]
  float& sigma();
 
  /// Set the Transverse momentum
  void setPT(float value);
  /// Get mutable reference to Transverse momentum
  float& getPT();
  /// Get reference to Transverse momentum
  [[deprecated("use getPT instead")]]
  float& pT();
 
  /// Set the Hadronic angle
  void setGamma(float value);
  /// Get mutable reference to Hadronic angle
  float& getGamma();
  /// Get reference to Hadronic angle
  [[deprecated("use getGamma instead")]]
  float& gamma();
 
 
 
  void addToHadrons(const edm4eic::ReconstructedParticle&);
  std::size_t hadrons_size() const;
  edm4eic::ReconstructedParticle getHadrons(std::size_t) const;
  std::vector<edm4eic::ReconstructedParticle>::const_iterator hadrons_begin() const;
  std::vector<edm4eic::ReconstructedParticle>::const_iterator hadrons_end() const;
  podio::RelationRange<edm4eic::ReconstructedParticle> getHadrons() const;
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from HadronicFinalStateObj instance
  void unlink() { m_obj = podio::utils::MaybeSharedPtr<HadronicFinalStateObj>{nullptr}; }
 
  bool operator==(const MutableHadronicFinalState& other) const { return m_obj == other.m_obj; }
  bool operator==(const HadronicFinalState& other) const;
 
  bool operator!=(const MutableHadronicFinalState& other) const { return !(*this == other); }
  bool operator!=(const HadronicFinalState& other) const { return !(*this == other); }
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const MutableHadronicFinalState& other) const { return m_obj < other.m_obj; }
 
  podio::ObjectID id() const { return getObjectID(); }
 
  const podio::ObjectID getObjectID() const;
 
  friend void swap(MutableHadronicFinalState& a, MutableHadronicFinalState& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  /// constructor from existing HadronicFinalStateObj
  explicit MutableHadronicFinalState(podio::utils::MaybeSharedPtr<HadronicFinalStateObj> obj);
 
  podio::utils::MaybeSharedPtr<HadronicFinalStateObj> m_obj{nullptr};
};
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const MutableHadronicFinalState& value);
#endif
 
 
} // namespace edm4eic
 
 
#endif