include/edm4eic/HadronicFinalState.h

0001 // AUTOMATICALLY GENERATED FILE - DO NOT EDIT
0002
0003 #ifndef EDM4EIC_HadronicFinalState_H
0004 #define EDM4EIC_HadronicFinalState_H
0005
0006 #include "edm4eic/HadronicFinalStateObj.h"
0007
0008 #include "edm4eic/ReconstructedParticle.h"
0009 #include "podio/RelationRange.h"
0010 #include <vector>
0011
0012 #include "podio/utilities/MaybeSharedPtr.h"
0013 #include "podio/detail/OrderKey.h"
0014
0015 #include <ostream>
0016 #include <cstdint>
0017
0018 #if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
0019 #include "nlohmann/json_fwd.hpp"
0020 #endif
0021
0022 // forward declarations
0023 namespace edm4eic {
0024 class HadronicFinalStateCollection;
0025 }
0026
0027
0028 namespace podio::detail {
0029 // Internal function used in less comparison operators of the datatypes and interface types
0030 OrderKey getOrderKey(const edm4eic::HadronicFinalState& obj);
0031 };
0032
0033 namespace edm4eic {
0034
0035 class MutableHadronicFinalState;
0036 class HadronicFinalStateCollection;
0037 class HadronicFinalStateCollectionData;
0038
0039 /** @class HadronicFinalState
0040  *  Summed quantities of the hadronic final state
0041  *  @author: T. Kutz
0042  */
0043 class HadronicFinalState {
0044
0045   friend class MutableHadronicFinalState;
0046   friend class HadronicFinalStateCollection;
0047   friend class edm4eic::HadronicFinalStateCollectionData;
0048   friend class HadronicFinalStateCollectionIterator;
0049   friend podio::detail::OrderKey podio::detail::getOrderKey(const HadronicFinalState & obj);
0050
0051 public:
0052   using mutable_type = MutableHadronicFinalState;
0053   using collection_type = HadronicFinalStateCollection;
0054
0055   /// default constructor
0056   HadronicFinalState();
0057
0058   /// Constructor initializing all members
0059   HadronicFinalState(float sigma, float pT, float gamma);
0060
0061   /// copy constructor
0062   HadronicFinalState(const HadronicFinalState& other) = default;
0063
0064   /// copy-assignment operator
0065   HadronicFinalState& operator=(HadronicFinalState other);
0066
0067   /// create a mutable deep-copy of the object with identical relations
0068   /// if cloneRelations=false, the relations are not cloned and will be empty
0069   MutableHadronicFinalState clone(bool cloneRelations=true) const;
0070
0071   /// destructor
0072   ~HadronicFinalState() = default;
0073
0074   /// converting constructor from mutable object
0075   HadronicFinalState(const MutableHadronicFinalState& other);
0076
0077   static HadronicFinalState makeEmpty();
0078
0079 public:
0080
0081   static constexpr auto typeName = "edm4eic::HadronicFinalState";
0082
0083   /// Access the Longitudinal energy-momentum balance (aka E - pz)
0084   float getSigma() const;
0085
0086   /// Access the Transverse momentum
0087   float getPT() const;
0088
0089   /// Access the Hadronic angle
0090   float getGamma() const;
0091
0092
0093
0094   std::size_t hadrons_size() const;
0095   edm4eic::ReconstructedParticle getHadrons(std::size_t) const;
0096   std::vector<edm4eic::ReconstructedParticle>::const_iterator hadrons_begin() const;
0097   std::vector<edm4eic::ReconstructedParticle>::const_iterator hadrons_end() const;
0098   podio::RelationRange<edm4eic::ReconstructedParticle> getHadrons() const;
0099
0100
0101   /// check whether the object is actually available
0102   bool isAvailable() const;
0103   /// disconnect from HadronicFinalStateObj instance
0104   void unlink() { m_obj = podio::utils::MaybeSharedPtr<HadronicFinalStateObj>{nullptr}; }
0105
0106   bool operator==(const HadronicFinalState& other) const { return m_obj == other.m_obj; }
0107   bool operator==(const MutableHadronicFinalState& other) const;
0108
0109   bool operator!=(const HadronicFinalState& other) const { return !(*this == other); }
0110   bool operator!=(const MutableHadronicFinalState& other) const { return !(*this == other); }
0111
0112   // less comparison operator, so that objects can be e.g. stored in sets.
0113   bool operator<(const HadronicFinalState& other) const { return podio::detail::getOrderKey(*this) < podio::detail::getOrderKey(other); }
0114
0115   podio::ObjectID id() const { return getObjectID(); }
0116
0117   const podio::ObjectID getObjectID() const;
0118
0119   friend void swap(HadronicFinalState& a, HadronicFinalState& b) {
0120     using std::swap;
0121     swap(a.m_obj, b.m_obj); // swap out the internal pointers
0122   }
0123
0124 private:
0125   /// constructor from existing HadronicFinalStateObj
0126   explicit HadronicFinalState(podio::utils::MaybeSharedPtr<HadronicFinalStateObj> obj);
0127   HadronicFinalState(HadronicFinalStateObj* obj);
0128
0129   podio::utils::MaybeSharedPtr<HadronicFinalStateObj> m_obj{nullptr};
0130 };
0131
0132 std::ostream& operator<<(std::ostream& o, const HadronicFinalState& value);
0133
0134 #if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
0135 void to_json(nlohmann::json& j, const HadronicFinalState& value);
0136 #endif
0137
0138
0139 } // namespace edm4eic
0140
0141
0142 #endif