MutableTrackSeed.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_MutableTrackSeed_H
#define EDM4EIC_MutableTrackSeed_H
 
#include "edm4eic/TrackSeedObj.h"
// Make the immutable class available from its mutable version but not vice versa
#include "edm4eic/TrackSeed.h"
 
#include "edm4eic/TrackerHit.h"
#include "edm4hep/Vector3f.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
 
// forward declarations
namespace edm4eic {
class TrackSeedCollection;
class TrackParameters;
class MutableTrackParameters;
}
 
 
namespace edm4eic {
 
 
/** @class MutableTrackSeed
 *  Seed info from the realistic seed finder
 *  @author: S. Li, B. Schmookler, J. Osborn
 */
class MutableTrackSeed {
 
  friend class TrackSeedCollection;
  friend class TrackSeedMutableCollectionIterator;
  friend class TrackSeed;
 
public:
  using object_type = TrackSeed;
  using collection_type = TrackSeedCollection;
 
  /// default constructor
  MutableTrackSeed() = default;
 
  /// Constructor initializing all members
  MutableTrackSeed(const edm4hep::Vector3f& perigee, const float quality);
 
  /// copy constructor
  MutableTrackSeed(const MutableTrackSeed& other) = default;
 
  /// copy-assignment operator
  MutableTrackSeed& operator=(MutableTrackSeed other) &; // Rebind this to other's internal object
  MutableTrackSeed& operator=(MutableTrackSeed other) && = delete; // Prevent rebinding temporary as the changes wouldn't persist
 
  /// create a mutable deep-copy of the object with identical relations
  /// if cloneRelations=false, the relations are not cloned and will be empty
  MutableTrackSeed clone(bool cloneRelations=true) const;
 
  /// destructor
  ~MutableTrackSeed() = default;
 
 
public:
 
  /// Access the Vector for the perigee (line surface)
  const edm4hep::Vector3f& getPerigee() const;
 
  /// Access the Seed quality reported by finder
  float getQuality() const;
 
 
  /// Access the Initial track parameters
  const edm4eic::TrackParameters getParams() const;
 
  /// Set the Vector for the perigee (line surface)
  void setPerigee(const edm4hep::Vector3f& perigee);
  /// Get mutable reference to Vector for the perigee (line surface)
  edm4hep::Vector3f& getPerigee();
  /// Get reference to Vector for the perigee (line surface)
  [[deprecated("use getPerigee instead")]]
  edm4hep::Vector3f& perigee();
 
  /// Set the Seed quality reported by finder
  void setQuality(const float quality);
  /// Get mutable reference to Seed quality reported by finder
  float& getQuality();
  /// Get reference to Seed quality reported by finder
  [[deprecated("use getQuality instead")]]
  float& quality();
 
 
  /// Set the Initial track parameters
  void setParams(const edm4eic::TrackParameters& value);
 
  void addToHits(const edm4eic::TrackerHit&);
  std::size_t hits_size() const;
  edm4eic::TrackerHit getHits(std::size_t) const;
  std::vector<edm4eic::TrackerHit>::const_iterator hits_begin() const;
  std::vector<edm4eic::TrackerHit>::const_iterator hits_end() const;
  podio::RelationRange<edm4eic::TrackerHit> getHits() const;
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from TrackSeedObj instance
  void unlink() { m_obj = podio::utils::MaybeSharedPtr<TrackSeedObj>{nullptr}; }
 
  bool operator==(const MutableTrackSeed& other) const { return m_obj == other.m_obj; }
  bool operator==(const TrackSeed& other) const;
 
  bool operator!=(const MutableTrackSeed& other) const { return !(*this == other); }
  bool operator!=(const TrackSeed& other) const { return !(*this == other); }
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const MutableTrackSeed& other) const { return podio::detail::getOrderKey(*this) < podio::detail::getOrderKey(other); }
 
  podio::ObjectID id() const { return getObjectID(); }
 
  const podio::ObjectID getObjectID() const;
 
  friend std::hash<MutableTrackSeed>;
 
  friend void swap(MutableTrackSeed& a, MutableTrackSeed& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  /// constructor from existing TrackSeedObj
  explicit MutableTrackSeed(podio::utils::MaybeSharedPtr<TrackSeedObj> obj);
 
  podio::utils::MaybeSharedPtr<TrackSeedObj> m_obj{new TrackSeedObj{}, podio::utils::MarkOwned};
};
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const MutableTrackSeed& value);
#endif
 
 
} // namespace edm4eic
 
 
 
template<>
struct std::hash<edm4eic::MutableTrackSeed> {
  std::size_t operator()(const edm4eic::MutableTrackSeed& obj) const {
    return std::hash<edm4eic::TrackSeedObj*>{}(obj.m_obj.get());
  }
};
 
 
#endif