MapLibre Native Core
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Public Attributes | List of all members
mbgl::OfflineRegionStatus Class Reference

#include <offline.hpp>

Public Member Functions

bool complete () const
 

Public Attributes

OfflineRegionDownloadState downloadState = OfflineRegionDownloadState::Inactive
 
uint64_t completedResourceCount = 0
 
uint64_t completedResourceSize = 0
 
uint64_t completedTileCount = 0
 
uint64_t requiredTileCount = 0
 
uint64_t completedTileSize = 0
 
uint64_t requiredResourceCount = 0
 
bool requiredResourceCountIsPrecise = false
 

Detailed Description

Definition at line 108 of file offline.hpp.

Member Function Documentation

◆ complete()

bool mbgl::OfflineRegionStatus::complete ( ) const
inline

Definition at line 159 of file offline.hpp.

Member Data Documentation

◆ completedResourceCount

uint64_t mbgl::OfflineRegionStatus::completedResourceCount = 0

The number of resources that have been fully downloaded and are ready for offline access.

Definition at line 116 of file offline.hpp.

◆ completedResourceSize

uint64_t mbgl::OfflineRegionStatus::completedResourceSize = 0

The cumulative size, in bytes, of all resources (inclusive of tiles) that have been fully downloaded.

Definition at line 122 of file offline.hpp.

◆ completedTileCount

uint64_t mbgl::OfflineRegionStatus::completedTileCount = 0

The number of tiles that are known to be required for this region. This is a subset of completedResourceCount.

Definition at line 128 of file offline.hpp.

◆ completedTileSize

uint64_t mbgl::OfflineRegionStatus::completedTileSize = 0

The cumulative size, in bytes, of all tiles that have been fully downloaded. This is a subset of completedResourceSize.

Definition at line 139 of file offline.hpp.

◆ downloadState

OfflineRegionDownloadState mbgl::OfflineRegionStatus::downloadState = OfflineRegionDownloadState::Inactive

Definition at line 110 of file offline.hpp.

◆ requiredResourceCount

uint64_t mbgl::OfflineRegionStatus::requiredResourceCount = 0

The number of resources that are known to be required for this region. See the documentation for requiredResourceCountIsPrecise for an important caveat about this number.

Definition at line 146 of file offline.hpp.

◆ requiredResourceCountIsPrecise

bool mbgl::OfflineRegionStatus::requiredResourceCountIsPrecise = false

This property is true when the value of requiredResourceCount is a precise count of the number of required resources, and false when it is merely a lower bound.

Specifically, it is false during early phases of an offline download. Once style and tile sources have been downloaded, it is possible to calculate the precise number of required resources, at which point it is set to true.

Definition at line 157 of file offline.hpp.

◆ requiredTileCount

uint64_t mbgl::OfflineRegionStatus::requiredTileCount = 0

The number of tiles that are known to be required for this region.

Definition at line 133 of file offline.hpp.

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