TSLDirectImportDataSet Class Reference

Inheritance diagram for TSLDirectImportDataSet:

Detailed Description

This class contains information about a dataset within a TSLDirectImportDataLayer.

An instance of this object may be created by calling TSLDirectImportDataLayer::createDataSets

Public Types
enum	DataSetType { DataSetTypeVector , DataSetTypeRaster , DataSetTypeMultiLevelRaster }
	The type of the data set. More...

Public Member Functions
TSLDirectImportDataSet *	clone () const
void	destroy ()
TSLDirectImportDataSet::DataSetType	type () const
	Query the type of the data set.
const char *	name () const
void	name (const char *dataSetName)
const char *	product () const
void	product (const char *prod)
const char *	dataPath () const
const TSLMUExtent &	extent () const
const TSLEnvelope &	extentTMC () const
const TSLCoordinateSystem *	coordinateSystem () const
double	scale () const
double	minDisplayScale () const
void	minDisplayScale (double minScale)
double	maxDisplayScale () const
void	maxDisplayScale (double maxScale)
TSLDirectImportDriver::DataType	dataType () const
void	reprocess ()
TSLDirectImportScaleBand *	scaleBand () const
TSLDirectImportDriver *	driver () const

Member Enumeration Documentation

DataSetType

enum TSLDirectImportDataSet::DataSetType

The type of the data set.

Enumerator
DataSetTypeVector	A vector data set.
DataSetTypeRaster	A raster data set containing a single resolution of data.
DataSetTypeMultiLevelRaster	A raster data set containing multiple resolutions of data.

Member Function Documentation

clone()

TSLDirectImportDataSet * TSLDirectImportDataSet::clone

(

)

const

Clone this data set

A data set may be cloned in order to load it multiple times.

Returns

A clone of this data set. This object is owned by the application.

coordinateSystem()

const TSLCoordinateSystem * TSLDirectImportDataSet::coordinateSystem

(

)

const

Query the coordinate system of the data.

Returns

The coordinate system of the data, or NULL if one could not be determined.

dataPath()

const char * TSLDirectImportDataSet::dataPath

(

)

const

Query the data path.

One data path may correspond to multiple data sets.

Returns

The data path, as passed to TSLDirectImportDataLayer::createDataSets

dataType()

TSLDirectImportDriver::DataType TSLDirectImportDataSet::dataType

(

)

const

Query the type of data

One data set will contain one type of data.

Returns

The type of data within the dataset.

destroy()

void TSLDirectImportDataSet::destroy

(

)

Delete this data set

This will not affect the state of the TSLDirectImportDataLayer.

driver()

TSLDirectImportDriver * TSLDirectImportDataSet::driver

(

)

const

Query the driver used for this dataset

This method should be used with care. It allows an application to modify the state of the underlying driver instance.

This driver instance may be used directly by the datalayer, or may be cloned for multithreaded processing. Any settings/attributes changed on this driver instance will affect any future loading/processing of this dataset.

extent()

const TSLMUExtent & TSLDirectImportDataSet::extent

(

)

const

Query the extent of the data.

The coordinate system of this extent may be queried via coordinateSystem.

Returns

The extent of the data.

extentTMC()

const TSLEnvelope & TSLDirectImportDataSet::extentTMC

(

)

const

Query the extent of the data in TMCs.

This extent will only be valid if the data has been loaded into the TSLDirectImportDataLayer.

Returns

The extent of the data in TMCs.

maxDisplayScale() [1/2]

double TSLDirectImportDataSet::maxDisplayScale

(

)

const

Query the maximum display scale of the data set

Minimum and maximum display scales may be set on a per-data set basis as well as per-scale band.

Returns

The highest scale at which this data set will be displayed

maxDisplayScale() [2/2]

void TSLDirectImportDataSet::maxDisplayScale

(

double

maxScale

)

Set the maximum display scale of the data set

Parameters

maxScale

The maximum scale to display this data set at

minDisplayScale() [1/2]

double TSLDirectImportDataSet::minDisplayScale

(

)

const

Query the minimum display scale of the data set

Minimum and maximum display scales may be set on a per-data set basis as well as per-scale band.

Returns

The lowest scale at which this data set will be displayed

minDisplayScale() [2/2]

void TSLDirectImportDataSet::minDisplayScale

(

double

minScale

)

Set the minimum display scale of the data set

Parameters

minScale

The minimum scale to display this data set at

name() [1/2]

const char * TSLDirectImportDataSet::name

(

)

const

Query the name of the data set.

By default this name will be created based on the dataPath() and dataType(). If multiple datasets are created from the data the name will also include a numerical suffix.

Returns

The name of this data set.

name() [2/2]

void TSLDirectImportDataSet::name

(

const char *

dataSetName

)

Set the name of the data set.

Parameters

dataSetName

The name of the data set.

product() [1/2]

const char * TSLDirectImportDataSet::product

(

)

const

Query the product specification of the data set.

Returns

The product specification of the dataset, NULL if no product is specified.

product() [2/2]

void TSLDirectImportDataSet::product

(

const char *

prod

)

Set the product specification of the data set.

If set, the feature configuration needs to contain features with the same product specification set. See TSLFeature::setProduct.

If no product is set, the feature configuration needs to contain features without product specifications.

Multiple products may be used within the same feature configuration in order to provide multiple different renderings for the same features.

Applications must ensure the product specification is set correctly when using a product-specific feature configuration.

Parameters

product

The product specification to set. Passing NULL will clear the product specification.

reprocess()

void TSLDirectImportDataSet::reprocess

(

)

Trigger a reprocess of the dataset

This method must be called by the application if any of the rasterSettings() or vectorSettings() are modified.

If the data set has been added to a TSLDirectImportDataLayer any displayed data will be removed.

This operation will be performed in the current thread and may cause a stall in the application's draw loop.

This method will not trigger any callbacks.

scale()

double TSLDirectImportDataSet::scale

(

)

const

Query the scale of the data.

If no scale is available it will be 0.0 This scale may have been read from the data by the TSLDirectImportDriver, The scale of raster data may be calculated by the data layer. This will be based on displaying the data at the DPI of the current display.

The application must provide an implementation of TSLDirectImportDataLayerCallbacks::onDeviceCapabilitiesRequired for automatic scale calculations. If not a default display size will be used.

This value is mostly for information purposes, but will be used by TSLDirectImportDataLayer::loadData to automatically select an appropriate scale band. Data may also be loaded into a specific band by the application.

Returns

The scale of the data.

scaleBand()

TSLDirectImportScaleBand * TSLDirectImportDataSet::scaleBand

(

)

const

Query the scale band for this dataset

The returned scale band may be modified by the application but must not be deleted

Returns

The scale band for this dataset, or NULL if the dataset hasn't been loaded

type()

TSLDirectImportDataSet::DataSetType TSLDirectImportDataSet::type

(

)

const

Query the type of the data set.