class PyramidFileCacheOptions in Tinman.Terrain.Pyramids

sealed class	PyramidFileCacheOptions	implements	IConfigurable
			IEquatable<PyramidFileCacheOptions>

Configuration

Config

The configurator object for this type.

public static property	Config { get }
type	IConfigurator<PyramidFileCacheOptions>
value	[not-null]	The configurator object.

Public / Attributes

SizeMegabytes

The maximum size of the pyramid file cache.

public property	SizeMegabytes { get set }
type	int32
value	[>=0]	The maximum file size, in megabytes. Set to 0 to disable this limit.

SizePercent

The maximum size of the pyramid file cache.

public property	SizePercent { get set }
type	int32
value	[0..100]	The maximum size, given as a percentage of available storage space in the directory that holds the pyramid cache file (see DirectoryFreeSpace). Set to 0 to disable this limit.

TileAge

The maximum age of tiles in the pyramid file cache.

public property	TileAge { get set }
type	int32
value	[>=0]	The maximum tile age, in seconds. Set to 0 to disable this limit.

Remarks:

Defaults to 0.

Public / Constructors

PyramidFileCacheOptions

Creates a new instance of PyramidFileCacheOptions.

public constructor	PyramidFileCacheOptions (int32 sizeMegabytes = 1024, int32 sizePercent = 25, int32 tileAge = 0)
params	sizeMegabytes	[>=0]	Initial value for SizeMegabytes. Defaults to 1024.
	sizePercent	[0..100]	Initial value for SizePercent. Defaults to 25.
	tileAge	[>=0]	Initial value for TileAge. Defaults to 0.

Public / Methods

Equals

Compares this object with the given one.

[Pure]
public method	Equals (PyramidFileCacheOptions other)
type	bool
params	other		The object to compare to.
returns			true if this object is equal to other, false if not.
implements	IEquatable.Equals

ToConfig

Returns the configuration value that describes this object.

public method	ToConfig ()
type	ConfigValue
returns		[not-null]	The configuration value.
implements	IConfigurable.ToConfig

Remarks:

All configurable objects need to implement this interface. For simple types, it is preferable to delegate to ToValue.

The returned value may be of type Invalid, which means that this object in its current state cannot be described with the configuration API.

Before returning the resulting configuration value, Cache must be called on it, passing this IConfigurable object as parameter.