QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsInterpolator Class Referenceabstract

Interface class for interpolations. More...

#include <qgsinterpolator.h>

Inheritance diagram for QgsInterpolator:
Inheritance graph
[legend]

Classes

struct  LayerData
 A layer together with the information about interpolation attribute / z-coordinate interpolation and the type (point, structure line, breakline) More...
 

Public Types

enum  InputType { POINTS, STRUCTURE_LINES, BREAK_LINES }
 Describes the type of input data. More...
 

Public Member Functions

 QgsInterpolator (const QList< LayerData > &layerData)
 
virtual ~QgsInterpolator ()
 
virtual int interpolatePoint (double x, double y, double &result)=0
 Calculates interpolation value for map coordinates x, y. More...
 
const QList< LayerData > & layerData () const
 

Protected Member Functions

int cacheBaseData ()
 Caches the vertex and value data from the provider. More...
 

Protected Attributes

QVector< vertexDatamCachedBaseData
 
bool mDataIsCached
 Flag that tells if the cache already has been filled. More...
 
QList< LayerDatamLayerData
 

Detailed Description

Interface class for interpolations.

Interpolators take the vertices of a vector layer as base data. The z-Value can be an attribute or the z-coordinates in case of 25D types

Member Enumeration Documentation

Describes the type of input data.

Enumerator
POINTS 
STRUCTURE_LINES 
BREAK_LINES 

Constructor & Destructor Documentation

QgsInterpolator::QgsInterpolator ( const QList< LayerData > &  layerData)
QgsInterpolator::~QgsInterpolator ( )
virtual

Member Function Documentation

int QgsInterpolator::cacheBaseData ( )
protected

Caches the vertex and value data from the provider.

All the vertex data will be held in virtual memory

Returns
0 in case of success
virtual int QgsInterpolator::interpolatePoint ( double  x,
double  y,
double &  result 
)
pure virtual

Calculates interpolation value for map coordinates x, y.

Parameters
xx-coordinate (in map units)
yy-coordinate (in map units)
resultout: interpolation result
Returns
0 in case of success

Implemented in QgsTINInterpolator, and QgsIDWInterpolator.

const QList<LayerData>& QgsInterpolator::layerData ( ) const
inline

Member Data Documentation

QVector<vertexData> QgsInterpolator::mCachedBaseData
protected
bool QgsInterpolator::mDataIsCached
protected

Flag that tells if the cache already has been filled.

QList<LayerData> QgsInterpolator::mLayerData
protected

The documentation for this class was generated from the following files: