HadronicFinalState.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_HadronicFinalState_H
#define EDM4EIC_HadronicFinalState_H
 
#include "edm4eic/HadronicFinalStateObj.h"
 
#include "edm4eic/ReconstructedParticle.h"
#include "podio/RelationRange.h"
#include <vector>
 
#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 HadronicFinalStateCollection;
}
 
 
namespace podio::detail {
// Internal function used in less comparison operators of the datatypes and interface types
OrderKey getOrderKey(const edm4eic::HadronicFinalState& obj);
};
 
namespace edm4eic {
 
class MutableHadronicFinalState;
class HadronicFinalStateCollection;
class HadronicFinalStateCollectionData;
 
/** @class HadronicFinalState
 *  Summed quantities of the hadronic final state
 *  @author: T. Kutz
 */
class HadronicFinalState {
 
  friend class MutableHadronicFinalState;
  friend class HadronicFinalStateCollection;
  friend class edm4eic::HadronicFinalStateCollectionData;
  friend class HadronicFinalStateCollectionIterator;
  friend podio::detail::OrderKey podio::detail::getOrderKey(const HadronicFinalState & obj);
 
public:
  using mutable_type = MutableHadronicFinalState;
  using collection_type = HadronicFinalStateCollection;
 
  /// default constructor
  HadronicFinalState();
 
  /// Constructor initializing all members
  HadronicFinalState(float sigma, float pT, float gamma);
 
  /// copy constructor
  HadronicFinalState(const HadronicFinalState& other) = default;
 
  /// copy-assignment operator
  HadronicFinalState& operator=(HadronicFinalState 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
  ~HadronicFinalState() = default;
 
  /// converting constructor from mutable object
  HadronicFinalState(const MutableHadronicFinalState& other);
 
  static HadronicFinalState makeEmpty();
 
public:
 
  static constexpr auto typeName = "edm4eic::HadronicFinalState";
 
  /// 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;
 
 
 
  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 HadronicFinalState& other) const { return m_obj == other.m_obj; }
  bool operator==(const MutableHadronicFinalState& other) const;
 
  bool operator!=(const HadronicFinalState& other) const { return !(*this == other); }
  bool operator!=(const MutableHadronicFinalState& other) const { return !(*this == other); }
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const HadronicFinalState& 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(HadronicFinalState& a, HadronicFinalState& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  /// constructor from existing HadronicFinalStateObj
  explicit HadronicFinalState(podio::utils::MaybeSharedPtr<HadronicFinalStateObj> obj);
  HadronicFinalState(HadronicFinalStateObj* obj);
 
  podio::utils::MaybeSharedPtr<HadronicFinalStateObj> m_obj{nullptr};
};
 
std::ostream& operator<<(std::ostream& o, const HadronicFinalState& value);
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const HadronicFinalState& value);
#endif
 
 
} // namespace edm4eic
 
 
#endif