MutableTrackClusterMatch.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_MutableTrackClusterMatch_H
#define EDM4EIC_MutableTrackClusterMatch_H
 
#include "edm4eic/TrackClusterMatchObj.h"
// Make the immutable class available from its mutable version but not vice versa
#include "edm4eic/TrackClusterMatch.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 TrackClusterMatchCollection;
class Cluster;
class MutableCluster;
class Track;
class MutableTrack;
}
 
 
namespace edm4eic {
 
 
/** @class MutableTrackClusterMatch
 *  Match between a Cluster and a Track
 *  @author: D. Anderson, D. Brandenburg, D. Kalinkin, S. Joosten
 */
class MutableTrackClusterMatch {
 
  friend class TrackClusterMatchCollection;
  friend class TrackClusterMatchMutableCollectionIterator;
  friend class TrackClusterMatch;
 
public:
  using object_type = TrackClusterMatch;
  using collection_type = TrackClusterMatchCollection;
 
  /// default constructor
  MutableTrackClusterMatch();
 
  /// Constructor initializing all members
  MutableTrackClusterMatch(float weight);
 
  /// copy constructor
  MutableTrackClusterMatch(const MutableTrackClusterMatch& other) = default;
 
  /// copy-assignment operator
  MutableTrackClusterMatch& operator=(MutableTrackClusterMatch other);
 
  /// create a mutable deep-copy of the object with identical relations
  /// if cloneRelations=false, the relations are not cloned and will be empty
  MutableTrackClusterMatch clone(bool cloneRelations=true) const;
 
  /// destructor
  ~MutableTrackClusterMatch() = default;
 
 
public:
 
  /// Access the weight of this association
  float getWeight() const;
 
 
  /// Access the reference to the cluster
  const edm4eic::Cluster getCluster() const;
  /// Access the reference to the track
  const edm4eic::Track getTrack() const;
 
  /// Set the weight of this association
  void setWeight(float value);
  /// Get mutable reference to weight of this association
  float& getWeight();
  /// Get reference to weight of this association
  [[deprecated("use getWeight instead")]]
  float& weight();
 
 
  /// Set the reference to the cluster
  void setCluster(const edm4eic::Cluster& value);
  /// Set the reference to the track
  void setTrack(const edm4eic::Track& value);
 
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from TrackClusterMatchObj instance
  void unlink() { m_obj = podio::utils::MaybeSharedPtr<TrackClusterMatchObj>{nullptr}; }
 
  bool operator==(const MutableTrackClusterMatch& other) const { return m_obj == other.m_obj; }
  bool operator==(const TrackClusterMatch& other) const;
 
  bool operator!=(const MutableTrackClusterMatch& other) const { return !(*this == other); }
  bool operator!=(const TrackClusterMatch& other) const { return !(*this == other); }
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const MutableTrackClusterMatch& 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(MutableTrackClusterMatch& a, MutableTrackClusterMatch& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  /// constructor from existing TrackClusterMatchObj
  explicit MutableTrackClusterMatch(podio::utils::MaybeSharedPtr<TrackClusterMatchObj> obj);
 
  podio::utils::MaybeSharedPtr<TrackClusterMatchObj> m_obj{nullptr};
};
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const MutableTrackClusterMatch& value);
#endif
 
 
} // namespace edm4eic
 
 
#endif