TSLSeamlessLayerConfig Class Reference

Detailed Description

Contains configuration attributes that are passed to the TSLSeamlessLayerManager on initialisation.

Note : this class has a private destructor, to destroy instances of this class call the public function destroy().

Public Member Functions
	TSLSeamlessLayerConfig ()
TSLSeamlessLayerConfig *	clone () const
void	compressed (bool value)
bool	compressed () const
bool	destroy ()
void	directory (const char *value)
const char *	directory () const
void	gridOriginX (double value)
double	gridOriginX () const
void	gridOriginY (double value)
double	gridOriginY () const
bool	initialiseFromConfig (const char *config)
void	layerTopRight (double x, double y)
void	layerTopRight (double *x, double *y) const
void	layerExtentFromData (bool definedByData)
bool	layerExtentFromData () const
void	layerName (const char *value)
const char *	layerName () const
void	maxZoomResolution (double highValue)
double	maxZoomResolution () const
void	minZoomResolution (double lowValue)
double	minZoomResolution () const
bool	operator!= (const TSLSeamlessLayerConfig &config) const
bool	operator== (const TSLSeamlessLayerConfig &config) const
void	stripSize (int value)
int	stripSize () const
void	tileExtentX (double value)
double	tileExtentX () const
void	tileExtentY (double value)
double	tileExtentY () const
void	TMCperMU (double value)
double	TMCperMU () const
void *	operator new (size_t size) TSL_NO_THROW
void *	operator new (size_t size, char *filename, int line)

Constructor & Destructor Documentation

TSLSeamlessLayerConfig()

TSLSeamlessLayerConfig::TSLSeamlessLayerConfig

(

)

Default Constructor.

Member Function Documentation

clone()

TSLSeamlessLayerConfig * TSLSeamlessLayerConfig::clone

(

)

const

Clone a TSLSeamlessLayerConfig.

compressed() [1/2]

bool TSLSeamlessLayerConfig::compressed

(

)

const

Returns the compressed flag, if set to true the seamless layer manager will save the TMSTile files in compressed format.

compressed() [2/2]

void TSLSeamlessLayerConfig::compressed

(

bool

value

)

Sets the compressed flag, if set to true the seamless layer manager will save the TMSTile files in compressed format, defaults to false.

Parameters

value

true/false value for the compression flag

destroy()

bool TSLSeamlessLayerConfig::destroy

(

)

Deletes the object from memory, call this function instead of using delete.

directory() [1/2]

const char * TSLSeamlessLayerConfig::directory

(

)

const

Returns the pathname to the location of the directory where the layer is to be updated or created.

directory() [2/2]

void TSLSeamlessLayerConfig::directory

(

const char *

value

)

Sets the pathname to the location of the directory where the layer is to be updated or created.

Parameters

value

full pathname of the layer directory to be created/updated

gridOriginX() [1/2]

double TSLSeamlessLayerConfig::gridOriginX

(

)

const

Returns the X value for the origin of the grid in metres.

gridOriginX() [2/2]

void TSLSeamlessLayerConfig::gridOriginX

(

double

value

)

Sets the X value for the origin of the grid in metres, 0 by default.

Parameters

value

the grid origin X value in metres

gridOriginY() [1/2]

double TSLSeamlessLayerConfig::gridOriginY

(

)

const

Returns the Y value for the origin of the grid in metres.

gridOriginY() [2/2]

void TSLSeamlessLayerConfig::gridOriginY

(

double

value

)

Sets the Y value for the origin of the grid in metres, 0 by default.

Parameters

value

the grid origin Y value in metres

initialiseFromConfig()

bool TSLSeamlessLayerConfig::initialiseFromConfig

(

const char *

config

)

Initialise a TSLSeamlessLayerConfig from a given configuration file.

If the configuration file does not exist, or the initialisation fails, this method returns false.

Parameters

config

full path of configuration file to load - the extension is NOT required

layerExtentFromData() [1/2]

bool TSLSeamlessLayerConfig::layerExtentFromData

(

)

const

Returns whether the top-right corner of the layer is calculated from the data that it holds or explicitly specified by the user.

layerExtentFromData() [2/2]

void TSLSeamlessLayerConfig::layerExtentFromData

(

bool

definedByData

)

Determines whether the top-right corner of the layer is calculated from the data that it holds or explicitly specified by the user.

Parameters

definedByData

If true, then the layer's top-right corner will be defined by the data it holds.

layerName() [1/2]

const char * TSLSeamlessLayerConfig::layerName

(

)

const

Returns the current layer name.

layerName() [2/2]

void TSLSeamlessLayerConfig::layerName

(

const char *

value

)

Sets the layer name.

Parameters

value

the name of the layer to be produced

layerTopRight() [1/2]

void TSLSeamlessLayerConfig::layerTopRight	(	double *	x,
		double *	y ) const

Return the top-right corner of the layer.

Parameters

x,y	The top-right corner (Map units)

layerTopRight() [2/2]

void TSLSeamlessLayerConfig::layerTopRight	(	double	x,
		double	y )

Set the top-right corner of the layer. This will automatically set the 'layerExtentFromData' flag to false.

Parameters

x,y	The top-right corner (Map units)

maxZoomResolution() [1/2]

double TSLSeamlessLayerConfig::maxZoomResolution

(

)

const

Returns the current maximum zoom resolution in metres per pixel.

Default value is 500.

maxZoomResolution() [2/2]

void TSLSeamlessLayerConfig::maxZoomResolution

(

double

highValue

)

Set the current maximum zoom resolution.

Default value is 500.

Parameters

highValue

value to set in metres per pixel.

minZoomResolution() [1/2]

double TSLSeamlessLayerConfig::minZoomResolution

(

)

const

Returns the current minimum zoom resolution in metres per pixel.

Default value is 0.

minZoomResolution() [2/2]

void TSLSeamlessLayerConfig::minZoomResolution

(

double

lowValue

)

Set the minimum zoom resolution.

Default value is 0.

Parameters

lowValue

value to set in metres per pixel.

operator new() [1/2]

void * TSLSeamlessLayerConfig::operator new

(

size_t

size

)

These are here to avoid being documented Allocation redirection for API.

operator new() [2/2]

void * TSLSeamlessLayerConfig::operator new	(	size_t	size,
		char *	filename,
		int	line )

When included in an MFC application in debug mode, the debug new expects this to be here. Override it and return the same as the normal one. The library must include it when compiled in release mode, since the user's application may be in debug mode.

operator!=()

bool TSLSeamlessLayerConfig::operator!=

(

const TSLSeamlessLayerConfig &

config

)

const

Inequality operator.

Parameters

config

TSLSeamlessLayerConfig to compare against

operator==()

bool TSLSeamlessLayerConfig::operator==

(

const TSLSeamlessLayerConfig &

config

)

const

Equality operator.

Parameters

config

the TSLSeamlessLayerConfig to compare against

stripSize() [1/2]

int TSLSeamlessLayerConfig::stripSize

(

)

const

Returns the range of tiles in the X direction to be held in each subdirectory (strip).

Default value is 1.

stripSize() [2/2]

void TSLSeamlessLayerConfig::stripSize

(

int

value

)

Sets the range of tiles in the X direction to be held in each subdirectory. this is essential for storage of map layers with a high number of potential tiles.

Default value is 1.

Parameters

value

number of tiles in each sub-directory (strip)

tileExtentX() [1/2]

double TSLSeamlessLayerConfig::tileExtentX

(

)

const

Returns the extent of a tile in the X direction, in metres.

tileExtentX() [2/2]

void TSLSeamlessLayerConfig::tileExtentX

(

double

value

)

Sets the extent of a tile in the X direction, in metres.

Parameters

value

tile extent in metres

tileExtentY() [1/2]

double TSLSeamlessLayerConfig::tileExtentY

(

)

const

Returns the extent of a tile in the Y direction, in metres.

tileExtentY() [2/2]

void TSLSeamlessLayerConfig::tileExtentY

(

double

value

)

Sets the extent of a tile in the Y direction, in metres.

Parameters

value

tile extent in metres

TMCperMU() [1/2]

double TSLSeamlessLayerConfig::TMCperMU

(

)

const

Returns the number of internal MapLink coordinates (TMC) per Map Unit (MU).

Default value is 1000.

TMCperMU() [2/2]

void TSLSeamlessLayerConfig::TMCperMU

(

double

value

)

Sets the number of internal MapLink coordinates (TMC) per Map Unit (MU),

Default value is 1000.

Parameters

value

the TMC per MU