Repo created

libs/map/gps_track_collection.hpp

@@ -0,0 +1,74 @@
+#pragma once
+
+#include "platform/location.hpp"
+
+#include "map/elevation_info.hpp"
+#include "map/track_statistics.hpp"
+
+#include <deque>
+#include <limits>
+#include <utility>
+#include <vector>
+
+class GpsTrackCollection final
+{
+public:
+  static size_t const kInvalidId;  // = numeric_limits<size_t>::max();
+
+  using TItem = location::GpsInfo;
+
+  /// Constructor
+  GpsTrackCollection();
+
+  /// Adds set of new points in the collection.
+  /// @param items - set of items to be added.
+  /// @returns range of identifiers of added items or pair(kInvalidId,kInvalidId) if nothing was added
+  /// @note items which does not conform to timestamp sequence, is not added.
+  std::pair<size_t, size_t> Add(std::vector<TItem> const & items);
+
+  /// Removes all points from the collection.
+  /// @param resetIds - if it is set to true, then new identifiers will start from 0,
+  /// otherwise new identifiers will continue from returned value res.second + 1
+  /// @return range of item identifiers, which were removed or
+  /// pair(kInvalidId,kInvalidId) if nothing was removed
+  std::pair<size_t, size_t> Clear(bool resetIds = true);
+
+  /// Returns true if collection is empty, otherwise returns false.
+  bool IsEmpty() const;
+
+  /// Returns number of items in the collection
+  size_t GetSize() const;
+
+  /// Returns track statistics.
+  TrackStatistics const GetTrackStatistics() const { return m_statistics; }
+  /// Updates the elevation info with the missed points and returns a reference.
+  ElevationInfo const & UpdateAndGetElevationInfo();
+
+  /// Enumerates items in the collection.
+  /// @param f - callable object, which is called with params - item and item id,
+  /// if f returns false, then enumeration is stopped.
+  /// @param pos - position index to start enumeration
+  template <typename F>
+  void ForEach(F && f, size_t pos = 0) const
+  {
+    if (pos >= m_items.size())
+      return;
+    auto i = m_items.cbegin() + pos, iend = m_items.cend();
+    size_t id = m_lastId - m_items.size() + pos;
+    for (; i != iend; ++i, ++id)
+    {
+      TItem const & item = *i;
+      size_t const itemId = id;
+      if (!f(item, itemId))
+        break;
+    }
+  }
+
+private:
+  std::deque<TItem> m_items;  // asc. sorted by timestamp
+
+  size_t m_lastId;
+  TrackStatistics m_statistics;
+  ElevationInfo m_elevationInfo;
+  bool m_elevationInfoDirty;
+};