MutableTrajectory.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EDM4EIC_MutableTrajectory_H
#define EDM4EIC_MutableTrajectory_H
 
#include "edm4eic/TrajectoryObj.h"
// Make the immutable class available from its mutable version but not vice versa
#include "edm4eic/Trajectory.h"
 
#include "edm4eic/Measurement2D.h"
#include "edm4eic/TrackParameters.h"
#include "podio/RelationRange.h"
#include <cstdint>
#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 TrajectoryCollection;
class TrackSeed;
class MutableTrackSeed;
}
 
 
namespace edm4eic {
 
 
/** @class MutableTrajectory
 *  Raw trajectory from the tracking algorithm. What is called hit here is 2d measurement indeed.
 *  @author: S. Joosten, S. Li
 */
class MutableTrajectory {
 
  friend class TrajectoryCollection;
  friend class TrajectoryMutableCollectionIterator;
  friend class Trajectory;
 
public:
  using object_type = Trajectory;
  using collection_type = TrajectoryCollection;
 
  /// default constructor
  MutableTrajectory() = default;
 
  /// Constructor initializing all members
  MutableTrajectory(const std::uint32_t type, const std::uint32_t nStates, const std::uint32_t nMeasurements, const std::uint32_t nOutliers, const std::uint32_t nHoles, const std::uint32_t nSharedHits);
 
  /// copy constructor
  MutableTrajectory(const MutableTrajectory& other) = default;
 
  /// copy-assignment operator
  MutableTrajectory& operator=(MutableTrajectory other) &; // Rebind this to other's internal object
  MutableTrajectory& operator=(MutableTrajectory 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
  MutableTrajectory clone(bool cloneRelations=true) const;
 
  /// destructor
  ~MutableTrajectory() = default;
 
 
public:
 
  /// Access the 0 (does not have good track fit), 1 (has good track fit)
  std::uint32_t getType() const;
 
  /// Access the Number of tracking steps
  std::uint32_t getNStates() const;
 
  /// Access the Number of hits used
  std::uint32_t getNMeasurements() const;
 
  /// Access the Number of hits not considered
  std::uint32_t getNOutliers() const;
 
  /// Access the Number of missing hits
  std::uint32_t getNHoles() const;
 
  /// Access the Number of shared hits with other trajectories
  std::uint32_t getNSharedHits() const;
 
 
  /// Access the Corresponding track seed
  const edm4eic::TrackSeed getSeed() const;
 
  /// Set the 0 (does not have good track fit), 1 (has good track fit)
  void setType(const std::uint32_t type);
  /// Get mutable reference to 0 (does not have good track fit), 1 (has good track fit)
  std::uint32_t& getType();
  /// Get reference to 0 (does not have good track fit), 1 (has good track fit)
  [[deprecated("use getType instead")]]
  std::uint32_t& type();
 
  /// Set the Number of tracking steps
  void setNStates(const std::uint32_t nStates);
  /// Get mutable reference to Number of tracking steps
  std::uint32_t& getNStates();
  /// Get reference to Number of tracking steps
  [[deprecated("use getNStates instead")]]
  std::uint32_t& nStates();
 
  /// Set the Number of hits used
  void setNMeasurements(const std::uint32_t nMeasurements);
  /// Get mutable reference to Number of hits used
  std::uint32_t& getNMeasurements();
  /// Get reference to Number of hits used
  [[deprecated("use getNMeasurements instead")]]
  std::uint32_t& nMeasurements();
 
  /// Set the Number of hits not considered
  void setNOutliers(const std::uint32_t nOutliers);
  /// Get mutable reference to Number of hits not considered
  std::uint32_t& getNOutliers();
  /// Get reference to Number of hits not considered
  [[deprecated("use getNOutliers instead")]]
  std::uint32_t& nOutliers();
 
  /// Set the Number of missing hits
  void setNHoles(const std::uint32_t nHoles);
  /// Get mutable reference to Number of missing hits
  std::uint32_t& getNHoles();
  /// Get reference to Number of missing hits
  [[deprecated("use getNHoles instead")]]
  std::uint32_t& nHoles();
 
  /// Set the Number of shared hits with other trajectories
  void setNSharedHits(const std::uint32_t nSharedHits);
  /// Get mutable reference to Number of shared hits with other trajectories
  std::uint32_t& getNSharedHits();
  /// Get reference to Number of shared hits with other trajectories
  [[deprecated("use getNSharedHits instead")]]
  std::uint32_t& nSharedHits();
 
 
  /// Set the Corresponding track seed
  void setSeed(const edm4eic::TrackSeed& value);
 
  void addToTrackParameters(const edm4eic::TrackParameters&);
  std::size_t trackParameters_size() const;
  edm4eic::TrackParameters getTrackParameters(std::size_t) const;
  std::vector<edm4eic::TrackParameters>::const_iterator trackParameters_begin() const;
  std::vector<edm4eic::TrackParameters>::const_iterator trackParameters_end() const;
  podio::RelationRange<edm4eic::TrackParameters> getTrackParameters() const;
  void addToMeasurements_deprecated(const edm4eic::Measurement2D&);
  std::size_t measurements_deprecated_size() const;
  edm4eic::Measurement2D getMeasurements_deprecated(std::size_t) const;
  std::vector<edm4eic::Measurement2D>::const_iterator measurements_deprecated_begin() const;
  std::vector<edm4eic::Measurement2D>::const_iterator measurements_deprecated_end() const;
  podio::RelationRange<edm4eic::Measurement2D> getMeasurements_deprecated() const;
  void addToOutliers_deprecated(const edm4eic::Measurement2D&);
  std::size_t outliers_deprecated_size() const;
  edm4eic::Measurement2D getOutliers_deprecated(std::size_t) const;
  std::vector<edm4eic::Measurement2D>::const_iterator outliers_deprecated_begin() const;
  std::vector<edm4eic::Measurement2D>::const_iterator outliers_deprecated_end() const;
  podio::RelationRange<edm4eic::Measurement2D> getOutliers_deprecated() const;
  void addToMeasurementChi2(const float&);
  std::size_t measurementChi2_size() const;
  float getMeasurementChi2(std::size_t) const;
  std::vector<float>::const_iterator measurementChi2_begin() const;
  std::vector<float>::const_iterator measurementChi2_end() const;
  podio::RelationRange<float> getMeasurementChi2() const;
  void addToOutlierChi2(const float&);
  std::size_t outlierChi2_size() const;
  float getOutlierChi2(std::size_t) const;
  std::vector<float>::const_iterator outlierChi2_begin() const;
  std::vector<float>::const_iterator outlierChi2_end() const;
  podio::RelationRange<float> getOutlierChi2() const;
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from TrajectoryObj instance
  void unlink() { m_obj = podio::utils::MaybeSharedPtr<TrajectoryObj>{nullptr}; }
 
  bool operator==(const MutableTrajectory& other) const { return m_obj == other.m_obj; }
  bool operator==(const Trajectory& other) const;
 
  bool operator!=(const MutableTrajectory& other) const { return !(*this == other); }
  bool operator!=(const Trajectory& other) const { return !(*this == other); }
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const MutableTrajectory& 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<MutableTrajectory>;
 
  friend void swap(MutableTrajectory& a, MutableTrajectory& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  /// constructor from existing TrajectoryObj
  explicit MutableTrajectory(podio::utils::MaybeSharedPtr<TrajectoryObj> obj);
 
  podio::utils::MaybeSharedPtr<TrajectoryObj> m_obj{new TrajectoryObj{}, podio::utils::MarkOwned};
};
 
#if defined(PODIO_JSON_OUTPUT) && !defined(__CLING__)
void to_json(nlohmann::json& j, const MutableTrajectory& value);
#endif
 
 
} // namespace edm4eic
 
 
 
template<>
struct std::hash<edm4eic::MutableTrajectory> {
  std::size_t operator()(const edm4eic::MutableTrajectory& obj) const {
    return std::hash<edm4eic::TrajectoryObj*>{}(obj.m_obj.get());
  }
};
 
 
#endif