TileRequest.h

/*
 * Copyright (C) 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 <olp/core/geo/tiling/TileKey.h>
#include <olp/core/thread/TaskScheduler.h>
#include <olp/dataservice/read/FetchOptions.h>
#include <boost/optional.hpp>
 
namespace olp {
namespace dataservice {
namespace read {
 
class DATASERVICE_READ_API TileRequest final {
 public:
  inline const boost::optional<std::string>& GetBillingTag() const {
    return billing_tag_;
  }
 
  inline TileRequest& WithBillingTag(boost::optional<std::string> tag) {
    billing_tag_ = std::move(tag);
    return *this;
  }
 
  inline TileRequest& WithBillingTag(std::string tag) {
    billing_tag_ = std::move(tag);
    return *this;
  }
 
  inline TileRequest& WithTileKey(geo::TileKey tile_key) {
    tile_key_ = std::move(tile_key);
    return *this;
  }
 
  inline const geo::TileKey& GetTileKey() const { return tile_key_; }
 
  inline FetchOptions GetFetchOption() const { return fetch_option_; }
 
  inline TileRequest& WithFetchOption(FetchOptions fetch_option) {
    fetch_option_ = fetch_option;
    return *this;
  }
 
  inline uint32_t GetPriority() const { return priority_; }
 
  inline TileRequest& WithPriority(uint32_t priority) {
    priority_ = priority;
    return *this;
  }
 
  inline std::string CreateKey(const std::string& layer_id) const {
    std::stringstream out;
    out << layer_id << "[" << GetTileKey().ToHereTile() << "]";
    if (GetBillingTag()) {
      out << "$" << GetBillingTag().get();
    }
    out << "^" << GetFetchOption();
    return out.str();
  }
 
 private:
  boost::optional<std::string> billing_tag_;
  geo::TileKey tile_key_;
  FetchOptions fetch_option_{OnlineIfNotFound};
  uint32_t priority_{thread::NORMAL};
};
 
}  // namespace read
}  // namespace dataservice
}  // namespace olp