TSLOpenGLDataOptimiserOptions Class Reference

Detailed Description

This class contains general options that provide an application with control over the behaviour of the TSLOpenGLDataOptimiser.

Public Types
enum	RasterCompressionQuality { RasterCompressionBest , RasterCompressionBalanced , RasterCompressionFastest }

Public Member Functions
	TSLOpenGLDataOptimiserOptions ()
	~TSLOpenGLDataOptimiserOptions ()
void	etcPackLocation (const TSLSimpleString &location)
const TSLSimpleString &	etcPackLocation () const
void	numWorkerThreads (unsigned int numThreads)
unsigned int	numWorkerThreads () const
void	rasterCompressionQuality (RasterCompressionQuality quality)
RasterCompressionQuality	rasterCompressionQuality () const
void	saveAsVersion (TSLMapLinkVersion version)
TSLMapLinkVersion	saveAsVersion () const
void	temporaryDirectory (const TSLSimpleString &tempDir)
const TSLSimpleString &	temporaryDirectory () const

Member Enumeration Documentation

RasterCompressionQuality

enum TSLOpenGLDataOptimiserOptions::RasterCompressionQuality

Enumeration defining the quality settings available when converting rasters to compressed formats via the TSLOpenGLDataOptimiser.

Enumerator
RasterCompressionBest	The compressors will use the highest available image quality settings. Compression using this setting can take a significant amount of time for large datasets. This setting is suitable for use with maps or rasters that are used frequently but are infrequently updated.
RasterCompressionBalanced	The compressors will use settings that give a good balance between image quality and compression speed.
RasterCompressionFastest	The compressors will use the settings that result in the fastest compression quality at the expense of image quality. This setting is useful for evaluating the effect of other options on processing or for testing hardware support for the compressed raster formats.

Constructor & Destructor Documentation

TSLOpenGLDataOptimiserOptions()

TSLOpenGLDataOptimiserOptions::TSLOpenGLDataOptimiserOptions

(

)

~TSLOpenGLDataOptimiserOptions()

TSLOpenGLDataOptimiserOptions::~TSLOpenGLDataOptimiserOptions

(

)

Member Function Documentation

etcPackLocation() [1/2]

const TSLSimpleString & TSLOpenGLDataOptimiserOptions::etcPackLocation ( ) const

inline

Returns the full path that the TSLOpenGLDataOptimiser will use to invoke the ETCpack executable for creating ETC1 and ETC2 compressed rasters.

By default this path is empty and the TSLOpenGLDataOptimiser will attempt to automatically locate the ETCpack executable in the following places: 1) The bin64 directory of the MapLink installation as defined by the path returned from TSLUtilityFunctions::getMapLinkHome(). 2) The current process's PATH environment variable.

etcPackLocation() [2/2]

void TSLOpenGLDataOptimiserOptions::etcPackLocation ( const TSLSimpleString & location )

inline

Sets the full path of the ETCpack executable that the TSLOpenGLDataOptimiser will use to create ETC1 and ETC2 compressed rasters.

numWorkerThreads() [1/2]

unsigned int TSLOpenGLDataOptimiserOptions::numWorkerThreads ( ) const

inline

Returns the number of threads that the TSLOpenGLDataOptimiser will use to perform processing.

The default value is 0, which means the TSLOpenGLDataOptimiser will select a suitable number of threads based on the number of processors in the machine.

numWorkerThreads() [2/2]

void TSLOpenGLDataOptimiserOptions::numWorkerThreads ( unsigned int numThreads )

inline

Sets the number of threads that the TSLOpenGLDataOptimiser will use to perform processing.

If set to 0 (the default) the TSLOpenGLDataOptimiser will select a suitable number of threads based on the number of processors in the machine.

rasterCompressionQuality() [1/2]

TSLOpenGLDataOptimiserOptions::RasterCompressionQuality TSLOpenGLDataOptimiserOptions::rasterCompressionQuality ( ) const

inline

Returns the quality factor to use when converting rasters into compressed formats. Higher quality settings results in better image quality at the expense of longer processing times.

The default quality setting is RasterCompressionBalanced.

See the documentation for the RasterCompressionQuality enumeration for more information.

rasterCompressionQuality() [2/2]

void TSLOpenGLDataOptimiserOptions::rasterCompressionQuality ( TSLOpenGLDataOptimiserOptions::RasterCompressionQuality quality )

inline

Sets the quality factor to use when converting rasters into compressed formats. Higher quality settings results in better image quality at the expense of longer processing times.

See the documentation for the RasterCompressionQuality enumeration for more information.

saveAsVersion() [1/2]

TSLMapLinkVersion TSLOpenGLDataOptimiserOptions::saveAsVersion ( ) const

inline

Returns the version that files written by the TSLOpenGLDataOptimiser will be written as.

By default files are written out in the version for the current MapLink release.

saveAsVersion() [2/2]

void TSLOpenGLDataOptimiserOptions::saveAsVersion ( TSLMapLinkVersion version )

inline

Sets the version that files written by the TSLOpenGLDataOptimiser will be written as. This can be used to generate processed maps compatible with older releases of MapLink.

The version must be at least TSL_MAPLINK_8_0.

temporaryDirectory() [1/2]

const TSLSimpleString & TSLOpenGLDataOptimiserOptions::temporaryDirectory ( ) const

inline

Sets the directory that the TSLOpenGLDataOptimiser will use for temporary files created during processing.

By default this method returns an empty string, which means that the TSLOpen GLDataOptimiser will use the current user's default temporary directory as defined by the operating system.

temporaryDirectory() [2/2]

void TSLOpenGLDataOptimiserOptions::temporaryDirectory ( const TSLSimpleString & tempDir )

inline

Sets the directory that the TSLOpenGLDataOptimiser will use for temporary files created during processing. Subdirectories will be automatically created in this directory to allow simultaneous use of the TSLOpenGLData Optimiser from different threads and/or processes.