Encapsulates the fields required to prefetch the specified layers, tiles, and levels.
More...
#include <PrefetchTilesRequest.h>
Encapsulates the fields required to prefetch the specified layers, tiles, and levels.
Tile keys can be at any level. Tile keys below the maximum tile level have the ancestors fetched from the minimum tile level. The children of the tile keys above the minimum tile level are downloaded from the minimum to maximum tile level. The tile keys above the maximum tile level are recursively downloaded down to the maximum tile level.
◆ CreateKey()
| std::string olp::dataservice::read::PrefetchTilesRequest::CreateKey |
( |
const std::string & |
layer_id | ) |
const |
|
inline |
Creates a readable format for the request.
- Parameters
-
| layer_id | The ID of the layer that is used for the request. |
- Returns
- A string representation of the request.
◆ GetBillingTag()
| const porting::optional< std::string > & olp::dataservice::read::PrefetchTilesRequest::GetBillingTag |
( |
| ) |
const |
|
inline |
Gets the billing tag to group billing records together.
The billing tag is an optional free-form tag that is used for grouping billing records together. If supplied, it must be 4–16 characters long and contain only alphanumeric ASCII characters [A-Za-z0-9].
- Returns
- The
BillingTag string or olp::porting::none if the billing tag is not set.
◆ GetDataAggregationEnabled()
| bool olp::dataservice::read::PrefetchTilesRequest::GetDataAggregationEnabled |
( |
| ) |
const |
|
inline |
Gets the data aggregation flag.
- Note
- Experimental. API may change.
- Returns
- The data aggregation flag as a boolean value.
◆ GetMaxLevel()
| unsigned int olp::dataservice::read::PrefetchTilesRequest::GetMaxLevel |
( |
| ) |
const |
|
inline |
Gets the maximum tiles level to prefetch.
- Returns
- The maximum tile level.
◆ GetMinLevel()
| unsigned int olp::dataservice::read::PrefetchTilesRequest::GetMinLevel |
( |
| ) |
const |
|
inline |
Gets the minimum tiles level to prefetch.
- Returns
- The minimum tile level.
◆ GetPriority()
| uint32_t olp::dataservice::read::PrefetchTilesRequest::GetPriority |
( |
| ) |
const |
|
inline |
Gets the request priority.
The default priority is Priority::LOW.
- Returns
- The request priority.
◆ GetTileKeys()
| const std::vector< geo::TileKey > & olp::dataservice::read::PrefetchTilesRequest::GetTileKeys |
( |
| ) |
const |
|
inline |
Get the vector of the root tile keys.
- Returns
- The vector with the tile keys.
◆ WithBillingTag()
template<class T = porting::optional<std::string>>
Sets the billing tag for the request.
- See also
GetBillingTag() for information on usage and format.
- Parameters
-
| tag | The BillingTag string or olp::porting::none. |
- Returns
- A reference to the updated
PrefetchTilesRequest instance.
◆ WithDataAggregationEnabled()
| PrefetchTilesRequest & olp::dataservice::read::PrefetchTilesRequest::WithDataAggregationEnabled |
( |
const bool |
data_aggregation_enabled | ) |
|
|
inline |
Changes the prefetch behavior when prefetching a list of tiles.
In case a tile does not exist, the prefetch algorithm searches for the nearest parent and prefetches it.
- Parameters
-
| data_aggregation_enabled | The boolean parameter that enables or disables the aggregation. |
- Note
- Experimental. API may change.
- Returns
- A reference to the updated
PrefetchTilesRequest instance.
◆ WithMaxLevel()
| PrefetchTilesRequest & olp::dataservice::read::PrefetchTilesRequest::WithMaxLevel |
( |
unsigned int |
max_level | ) |
|
|
inline |
Sets the maximum tile level for the request.
- Parameters
-
| max_level | The maximum tile level to prefetch. |
- Returns
- A reference to the updated
PrefetchTilesRequest instance.
◆ WithMinLevel()
| PrefetchTilesRequest & olp::dataservice::read::PrefetchTilesRequest::WithMinLevel |
( |
unsigned int |
min_level | ) |
|
|
inline |
Sets the minimum tiles level for the request.
- Parameters
-
| min_level | The minimum tiles level to prefetch. |
- Returns
- A reference to the updated
PrefetchTilesRequest instance.
◆ WithPriority()
| PrefetchTilesRequest & olp::dataservice::read::PrefetchTilesRequest::WithPriority |
( |
uint32_t |
priority | ) |
|
|
inline |
Sets the priority of the prefetch request.
- Parameters
-
| priority | The priority of the request. |
- Returns
- A reference to the updated
PrefetchTileRequest instance.
◆ WithTileKeys()
Sets the vector of the root tile keys for the request.
- Parameters
-
| tile_keys | The vector with the root tile keys of the prefetch. |
- Returns
- A reference to the updated
PrefetchTilesRequest instance.
The documentation for this class was generated from the following file:
