Represents the result of a prefetch operation. More...

#include <PrefetchTileResult.h>

Inheritance diagram for olp::dataservice::read::PrefetchTileResult:

Collaboration diagram for olp::dataservice::read::PrefetchTileResult:

[legend]

Public Types
using	base_type = client::ApiResponse< PrefetchTileNoError, client::ApiError >
	A parent type of the current `PrefetchTileResult` class.

Public Types inherited from olp::client::ApiResponse< PrefetchTileNoError, client::ApiError >
using	ResultType = PrefetchTileNoError
	The type of result.

using	ErrorType = client::ApiError
	The type of error.

using	PayloadType = void
	The type of additional payload.

Public Member Functions
	PrefetchTileResult (const geo::TileKey &tile, const PrefetchTileNoError &result)
	Creates the `PrefetchTileResult` instance if the corresponding response was successful. More...

	PrefetchTileResult (const geo::TileKey &tile, const client::ApiError &error)
	Creates the `PrefetchTileResult` instance if the corresponding response was not successful. More...

	PrefetchTileResult (const PrefetchTileResult &r)
	Creates the `PrefetchTileResult` instance that is a copy of the `r` parameter. More...

	PrefetchTileResult (const client::ApiError &error)
	Creates the `ApiResponse` instance if the corresponding response was not successful. More...

Public Member Functions inherited from olp::client::ApiResponse< PrefetchTileNoError, client::ApiError >
	ApiResponse (const ApiResponse< R, client::ApiError, void > &other)
	Creates the `ApiResponse` instance from a similar response type without payload. The payload is default initialized. More...

	ApiResponse (ApiResponse< R, client::ApiError, void > &&other)
	Creates the `ApiResponse` instance from a similar response type without payload. The payload is default initialized. More...

	ApiResponse (const ApiResponse< PrefetchTileNoError, client::ApiError, void > &other, P payload)
	Creates the `ApiResponse` instance from a similar response type without payload, and a separate payload. More...

	ApiResponse (const ApiResponse< R, client::ApiError, U > &other)
	Creates the `ApiResponse` instance from a similar request with a payload. More...

	ApiResponse (ApiResponse< R, client::ApiError, U > &&other)
	Creates the `ApiResponse` instance from a similar request with a payload. More...

	ApiResponse (ResultType result)
	Creates the `ApiResponse` instance. More...

	ApiResponse (ResultType result, P payload)
	Creates the `ApiResponse` instance with payload. More...

	ApiResponse (const ErrorType &error)
	Creates the `ApiResponse` instance if the request is not successful. More...

	ApiResponse (const ErrorType &error, P payload)
	Creates the `ApiResponse` instance if the request is not successful. More...

bool	IsSuccessful () const
	Checks the status of the request attempt. More...

const ResultType &	GetResult () const
	Gets the result of the successfully executed request. More...

ResultType &&	MoveResult ()
	Moves the result of the successfully executed request. More...

const ErrorType &	GetError () const
	Gets the error of the unsuccessful request attempt. More...

	operator bool () const
	Operator to check the status of the request attempt. More...

Public Attributes
geo::TileKey	tile_key_
	The `TileKey` instance that addresses a tile in a quadtree. More...

Detailed Description

Represents the result of a prefetch operation.

If successful, contains the geo::TileKey object; otherwise, contains the failure error.

Constructor & Destructor Documentation

◆ PrefetchTileResult() [1/4]

olp::dataservice::read::PrefetchTileResult::PrefetchTileResult	(	const geo::TileKey &	tile,
		const PrefetchTileNoError &	result
	)

inline

Creates the PrefetchTileResult instance if the corresponding response was successful.

Parameters

tile	The `TileKey` instance that addresses a tile in a quadtree.
result	The `PrefetchTileNoError` instance.

◆ PrefetchTileResult() [2/4]

olp::dataservice::read::PrefetchTileResult::PrefetchTileResult	(	const geo::TileKey &	tile,
		const client::ApiError &	error
	)

inline

Creates the PrefetchTileResult instance if the corresponding response was not successful.

Parameters

tile	The `TileKey` instance that addresses a tile in a quadtree.
error	The `ApiError` instance that contains information about the error.

◆ PrefetchTileResult() [3/4]

olp::dataservice::read::PrefetchTileResult::PrefetchTileResult ( const PrefetchTileResult & r )

inline

Creates the PrefetchTileResult instance that is a copy of the r parameter.

Parameters

r	The `PrefetchTileResult` instance that contains a tile key and error information.

◆ PrefetchTileResult() [4/4]

olp::dataservice::read::PrefetchTileResult::PrefetchTileResult ( const client::ApiError & error )

inlineexplicit

Creates the ApiResponse instance if the corresponding response was not successful.

Parameters

error The ApiError instance that contains information about the error.

Member Data Documentation

◆ tile_key_

geo::TileKey olp::dataservice::read::PrefetchTileResult::tile_key_

The TileKey instance that addresses a tile in a quadtree.

Parameters

tile_key_ The prefetched tile key.

The documentation for this class was generated from the following file:

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

Public Types

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PrefetchTileResult() [1/4]

◆ PrefetchTileResult() [2/4]

◆ PrefetchTileResult() [3/4]

◆ PrefetchTileResult() [4/4]

Member Data Documentation

◆ tile_key_