Encapsulates the fields required to prefetch the specified layers, tiles, and levels. More...

#include <PrefetchTilesRequest.h>

Public Member Functions
const std::vector< geo::TileKey > &	GetTileKeys () const
	Get the vector of the root tile keys. More...

PrefetchTilesRequest &	WithTileKeys (std::vector< geo::TileKey > tile_keys)
	Sets the vector of the root tile keys for the request. More...

unsigned int	GetMinLevel () const
	Gets the minimum tiles level to prefetch. More...

PrefetchTilesRequest &	WithMinLevel (unsigned int min_level)
	Sets the minimum tiles level for the request. More...

unsigned int	GetMaxLevel () const
	Gets the maximum tiles level to prefetch. More...

PrefetchTilesRequest &	WithMaxLevel (unsigned int max_level)
	Sets the maximum tile level for the request. More...

const boost::optional< std::string > &	GetBillingTag () const
	Gets the billing tag to group billing records together. More...

PrefetchTilesRequest &	WithBillingTag (boost::optional< std::string > tag)
	Sets the billing tag for the request. More...

PrefetchTilesRequest &	WithBillingTag (std::string &&tag)
	Sets the billing tag for the request. More...

PrefetchTilesRequest &	WithDataAggregationEnabled (bool data_aggregation_enabled)
	Changes the prefetch behavior when prefetching a list of tiles. More...

bool	GetDataAggregationEnabled () const
	Gets the data aggregation flag. More...

uint32_t	GetPriority () const
	Gets the request priority. More...

PrefetchTilesRequest &	WithPriority (uint32_t priority)
	Sets the priority of the prefetch request. More...

std::string	CreateKey (const std::string &layer_id) const
	Creates a readable format for the request. More...

Detailed Description

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.

Member Function Documentation

◆ 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 boost::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 boost::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() [1/2]

PrefetchTilesRequest& olp::dataservice::read::PrefetchTilesRequest::WithBillingTag ( boost::optional< std::string > tag )

inline

Sets the billing tag for the request.

See also: GetBillingTag() for information on usage and format.

Parameters

tag	The `BillingTag` string or `boost::none`.

Returns: A reference to the updated PrefetchTilesRequest instance.

◆ WithBillingTag() [2/2]

PrefetchTilesRequest& olp::dataservice::read::PrefetchTilesRequest::WithBillingTag ( std::string && tag )

inline

Sets the billing tag for the request.

See also: GetBillingTag() for information on usage and format.

Parameters

tag	The rvalue reference to the `BillingTag` string or `boost::none`.

Returns: A reference to the updated PrefetchTilesRequest instance.

◆ WithDataAggregationEnabled()

PrefetchTilesRequest& olp::dataservice::read::PrefetchTilesRequest::WithDataAggregationEnabled ( 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()

PrefetchTilesRequest& olp::dataservice::read::PrefetchTilesRequest::WithTileKeys ( std::vector< geo::TileKey > tile_keys )

inline

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:

olp-cpp-sdk-dataservice-read/include/olp/dataservice/read/PrefetchTilesRequest.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ CreateKey()

◆ GetBillingTag()

◆ GetDataAggregationEnabled()

◆ GetMaxLevel()

◆ GetMinLevel()

◆ GetPriority()

◆ GetTileKeys()

◆ WithBillingTag() [1/2]

◆ WithBillingTag() [2/2]

◆ WithDataAggregationEnabled()

◆ WithMaxLevel()

◆ WithMinLevel()

◆ WithPriority()

◆ WithTileKeys()