TSLDirectImportDataLayerAnalysisCallbacks Class Reference

Detailed Description

This callback class is used by the TSLDirectImportDataLayer to provide information about data analysis tasks.

If the application doesn't provide an implementation of this class it will not be able to perform data analysis and TSLDirectImportDataLayer::analyseData will always fail.

Public Member Functions
virtual void	onAnalysisStarted (const TSLDirectImportDataSet *dataSet)=0
virtual void	onAnalysisCancelled (const TSLDirectImportDataSet *dataSet)=0
virtual void	onAnalysisFailed (const TSLDirectImportDataSet *dataSet)=0
virtual void	onAnalysisComplete (const TSLDirectImportDataSet *dataSet, const TSLFeatureList *featureList)=0

Protected Member Functions
virtual	~TSLDirectImportDataLayerAnalysisCallbacks ()

Constructor & Destructor Documentation

~TSLDirectImportDataLayerAnalysisCallbacks()

TSLDirectImportDataLayerAnalysisCallbacks::~TSLDirectImportDataLayerAnalysisCallbacks ( )

inlineprotectedvirtual

Member Function Documentation

onAnalysisCancelled()

virtual void TSLDirectImportDataLayerAnalysisCallbacks::onAnalysisCancelled ( const TSLDirectImportDataSet * dataSet )

pure virtual

This function will be called when an analysis task has been cancelled

Normally this will only be when removing data from the layer

The application is not required to take any action for this callback

Parameters

dataSet

The data set being analysed

onAnalysisComplete()

virtual void TSLDirectImportDataLayerAnalysisCallbacks::onAnalysisComplete ( const TSLDirectImportDataSet * dataSet, const TSLFeatureList * featureList )

pure virtual

This function will be called when an analysis task has completed successfully

The application should take a copy of the provided feature list.

This feature list may be used to create a TSLFeatureClassConfig for use when loading data.

This feature list may also be added to an existing feature list in order to combine features from multiple datasets.

Parameters

dataSet	The data set being analysed
featureList	A list of features extracted from the analysed dataset.

onAnalysisFailed()

virtual void TSLDirectImportDataLayerAnalysisCallbacks::onAnalysisFailed ( const TSLDirectImportDataSet * dataSet )

pure virtual

This function will be called when an analysis task has failed

This will happen if the direct import driver has failed to create a valid TSLFeatureList from the data.

The application may still load the data if it can provide a suitable TSLFeatureClassConfig for the data.

Parameters

dataSet

The data set being analysed

onAnalysisStarted()

virtual void TSLDirectImportDataLayerAnalysisCallbacks::onAnalysisStarted ( const TSLDirectImportDataSet * dataSet )

pure virtual

This function will be called when the direct import layer has started an analysis task

The application is not required to take any action for this callback

Parameters

dataSet

The data set being analysed