ProtoCluster.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_ProtoCluster_H
#define EDM4EIC_ProtoCluster_H
 
#include "edm4eic/ProtoClusterObj.h"
 
#include "edm4eic/CalorimeterHit.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 ProtoClusterCollection;
}
 
 
namespace podio::detail {
// Internal function used in less comparison operators of the datatypes and interface types
OrderKey getOrderKey(const edm4eic::ProtoCluster& obj);
};
 
namespace edm4eic {
 
class MutableProtoCluster;
class ProtoClusterCollection;
class ProtoClusterCollectionData;
 
/** @class ProtoCluster
 *  Collection of hits identified by the clustering algorithm to belong together
 *  @author: S. Joosten
 */
class ProtoCluster {
 
  friend class MutableProtoCluster;
  friend class ProtoClusterCollection;
  friend class edm4eic::ProtoClusterCollectionData;
  friend class ProtoClusterCollectionIterator;
  friend podio::detail::OrderKey podio::detail::getOrderKey(const ProtoCluster & obj);
 
public:
  using mutable_type = MutableProtoCluster;
  using collection_type = ProtoClusterCollection;
 
  /// default constructor
  ProtoCluster();
 
 
  /// copy constructor
  ProtoCluster(const ProtoCluster& other) = default;
 
  /// copy-assignment operator
  ProtoCluster& operator=(ProtoCluster other);
 
  /// create a mutable deep-copy of the object with identical relations
  /// if cloneRelations=false, the relations are not cloned and will be empty
  MutableProtoCluster clone(bool cloneRelations=true) const;
 
  /// destructor
  ~ProtoCluster() = default;
 
  /// converting constructor from mutable object
  ProtoCluster(const MutableProtoCluster& other);
 
  static ProtoCluster makeEmpty();
 
public:
 
  static constexpr auto typeName = "edm4eic::ProtoCluster";
 
 
 
  std::size_t hits_size() const;
  edm4eic::CalorimeterHit getHits(std::size_t) const;
  std::vector<edm4eic::CalorimeterHit>::const_iterator hits_begin() const;
  std::vector<edm4eic::CalorimeterHit>::const_iterator hits_end() const;
  podio::RelationRange<edm4eic::CalorimeterHit> getHits() const;
  std::size_t weights_size() const;
  float getWeights(std::size_t) const;
  std::vector<float>::const_iterator weights_begin() const;
  std::vector<float>::const_iterator weights_end() const;
  podio::RelationRange<float> getWeights() const;
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from ProtoClusterObj instance
  void unlink() { m_obj = podio::utils::MaybeSharedPtr<ProtoClusterObj>{nullptr}; }
 
  bool operator==(const ProtoCluster& other) const { return m_obj == other.m_obj; }
  bool operator==(const MutableProtoCluster& other) const;
 
  bool operator!=(const ProtoCluster& other) const { return !(*this == other); }
  bool operator!=(const MutableProtoCluster& other) const { return !(*this == other); }
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const ProtoCluster& 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(ProtoCluster& a, ProtoCluster& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  /// constructor from existing ProtoClusterObj
  explicit ProtoCluster(podio::utils::MaybeSharedPtr<ProtoClusterObj> obj);
  ProtoCluster(ProtoClusterObj* obj);
 
  podio::utils::MaybeSharedPtr<ProtoClusterObj> m_obj{nullptr};
};
 
std::ostream& operator<<(std::ostream& o, const ProtoCluster& value);
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const ProtoCluster& value);
#endif
 
 
} // namespace edm4eic
 
 
#endif