PrefetchTilesRequest.h

/*
 * Copyright (C) 2019-2020 HERE Europe B.V.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 * License-Filename: LICENSE
 */
 
#pragma once
 
#include <sstream>
#include <string>
#include <utility>
#include <vector>
 
#include <olp/core/geo/tiling/TileKey.h>
#include <olp/core/porting/optional.h>
#include <olp/core/thread/TaskScheduler.h>
#include <olp/dataservice/read/DataServiceReadApi.h>
 
namespace olp {
namespace dataservice {
namespace read {
 
class DATASERVICE_READ_API PrefetchTilesRequest final {
 public:
  const std::vector<geo::TileKey>& GetTileKeys() const { return tile_keys_; }
 
  PrefetchTilesRequest& WithTileKeys(std::vector<geo::TileKey> tile_keys) {
    tile_keys_ = std::move(tile_keys);
    return *this;
  }
 
  unsigned int GetMinLevel() const { return min_level_; }
 
  PrefetchTilesRequest& WithMinLevel(unsigned int min_level) {
    min_level_ = min_level;
    return *this;
  }
 
  unsigned int GetMaxLevel() const { return max_level_; }
 
  PrefetchTilesRequest& WithMaxLevel(unsigned int max_level) {
    max_level_ = max_level;
    return *this;
  }
 
  const porting::optional<std::string>& GetBillingTag() const {
    return billing_tag_;
  }
 
  template <class T = porting::optional<std::string>>
  PrefetchTilesRequest& WithBillingTag(T&& tag) {
    billing_tag_ = std::forward<T>(tag);
    return *this;
  }
 
  PrefetchTilesRequest& WithDataAggregationEnabled(
      const bool data_aggregation_enabled) {
    data_aggregation_enabled_ = data_aggregation_enabled;
    return *this;
  }
 
  bool GetDataAggregationEnabled() const { return data_aggregation_enabled_; }
 
  uint32_t GetPriority() const { return priority_; }
 
  PrefetchTilesRequest& WithPriority(uint32_t priority) {
    priority_ = priority;
    return *this;
  }
 
  std::string CreateKey(const std::string& layer_id) const {
    std::stringstream out;
    out << layer_id << "[" << GetMinLevel() << "/" << GetMaxLevel() << "]"
        << "(" << GetTileKeys().size() << ")";
    if (GetBillingTag()) {
      out << "$" << *GetBillingTag();
    }
    return out.str();
  }
 
 private:
  std::string layer_id_;
  std::vector<geo::TileKey> tile_keys_;
  unsigned int min_level_{geo::TileKey::LevelCount};
  unsigned int max_level_{geo::TileKey::LevelCount};
  porting::optional<std::string> billing_tag_;
  bool data_aggregation_enabled_{false};
  uint32_t priority_{thread::LOW};
};
 
}  // namespace read
}  // namespace dataservice
}  // namespace olp