PyramidFileCacheOptions

Description

sealed class Tinman.Terrain.Pyramids.PyramidFileCacheOptions

Derived from

IConfigurableNull
IEquatable<PyramidFileCacheOptions>

Defines options for creating a PyramidFileCache.

Public / Constants

Thirty​Days​In​Seconds

public constant ThirtyDaysInSeconds → (30 * 24 * 60 * 60:int32)

Time span of thirty days, measured in seconds.

Commercial providers of satellite imagery usually have a clause in their terms and conditions which depicts the rules for local caching of downloaded data. These rules often require that cached data must be deleted after a given time span.

Public / Constructors

Pyramid​File​Cache​Options

public constructor PyramidFileCacheOptions → (3)

sizeMegabytes opt : int32 = 1024

[>=0]
Initial value for SizeMegabytes.

sizePercent opt : int32 = 0

[0..100]
Initial value for SizePercent.

tileAge opt : int32 = PyramidFileCacheOptions.ThirtyDaysInSeconds

[>=0]
Initial value for TileAge.

Creates a new instance of PyramidFileCacheOptions.

Public / Attributes

Size​Megabytes

public attribute SizeMegabytes → (get,set)

value : int32

[>=0]
The maximum file size, in megabytes. Set to 0 to disable this limit.

The maximum size of the pyramid file cache.

The default value is 1024.

Size​Percent

public attribute SizePercent → (get,set)

value : int32

[0..100]
The maximum size, given as a percentage of available storage space in the directory that holds the pyramid cache file (see IFileSystem.DirectoryFreeSpace). Set to 0 to disable this limit.

The maximum size of the pyramid file cache.

The default value is 0.

Tile​Age

public attribute TileAge → (get,set)

value : int32

[>=0]
The maximum tile age, in seconds. Set to 0 to disable this limit.

The maximum age of tiles in the pyramid file cache.

The default value is ThirtyDaysInSeconds

Configuration

Config

public static attribute Config → (get)

value : IConfigurator<PyramidFileCacheOptions>

[not-null]
The configurator object.

The configurator object for this type.