Quantum GIS API Documentation  1.7.5-Wroclaw
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsRuleBasedRendererV2::Rule Class Reference

This class keeps data about a rules for rule-based renderer. More...

#include <qgsrulebasedrendererv2.h>

Collaboration diagram for QgsRuleBasedRendererV2::Rule:
Collaboration graph
[legend]

Public Member Functions

 Rule (QgsSymbolV2 *symbol, int scaleMinDenom=0, int scaleMaxDenom=0, QString filterExp=QString(), QString label=QString(), QString description=QString())
 Constructor takes ownership of the symbol. More...
 
 Rule (const Rule &other)
 
 ~Rule ()
 
QString dump () const
 
QStringList needsFields () const
 
bool isFilterOK (const QgsFieldMap &fields, QgsFeature &f) const
 
bool isScaleOK (double scale) const
 
QgsSymbolV2symbol ()
 
bool dependsOnScale () const
 
int scaleMinDenom () const
 
int scaleMaxDenom () const
 
QString filterExpression () const
 
QString label () const
 
QString description () const
 
void setScaleMinDenom (int scaleMinDenom)
 
void setScaleMaxDenom (int scaleMaxDenom)
 
void setFilterExpression (QString filterExp)
 
void setLabel (QString label)
 
void setDescription (QString description)
 
Ruleoperator= (const Rule &other)
 

Protected Member Functions

void initFilter ()
 

Protected Attributes

QgsSymbolV2mSymbol
 
int mScaleMinDenom
 
int mScaleMaxDenom
 
QString mFilterExp
 
QString mLabel
 
QString mDescription
 
QgsSearchString mFilterParsed
 
QgsSearchTreeNodemFilterTree
 

Detailed Description

This class keeps data about a rules for rule-based renderer.

A rule consists of a symbol, filter expression and range of scales. If filter is empty, it matches all features. If scale range has both values zero, it matches all scales. If one of the min/max scale denominators is zero, there is no lower/upper bound for scales. A rule matches if both filter and scale range match.

Definition at line 43 of file qgsrulebasedrendererv2.h.

Constructor & Destructor Documentation

QgsRuleBasedRendererV2::Rule::Rule ( QgsSymbolV2 symbol,
int  scaleMinDenom = 0,
int  scaleMaxDenom = 0,
QString  filterExp = QString(),
QString  label = QString(),
QString  description = QString() 
)

Constructor takes ownership of the symbol.

Definition at line 31 of file qgsrulebasedrendererv2.cpp.

References initFilter().

QgsRuleBasedRendererV2::Rule::Rule ( const Rule other)

Definition at line 39 of file qgsrulebasedrendererv2.cpp.

QgsRuleBasedRendererV2::Rule::~Rule ( )

Definition at line 45 of file qgsrulebasedrendererv2.cpp.

Member Function Documentation

bool QgsRuleBasedRendererV2::Rule::dependsOnScale ( ) const
inline

Definition at line 57 of file qgsrulebasedrendererv2.h.

QString QgsRuleBasedRendererV2::Rule::description ( ) const
inline
QString QgsRuleBasedRendererV2::Rule::dump ( ) const

Definition at line 63 of file qgsrulebasedrendererv2.cpp.

QString QgsRuleBasedRendererV2::Rule::filterExpression ( ) const
inline
void QgsRuleBasedRendererV2::Rule::initFilter ( )
protected

Definition at line 50 of file qgsrulebasedrendererv2.cpp.

Referenced by Rule().

bool QgsRuleBasedRendererV2::Rule::isFilterOK ( const QgsFieldMap fields,
QgsFeature f 
) const
bool QgsRuleBasedRendererV2::Rule::isScaleOK ( double  scale) const

Definition at line 89 of file qgsrulebasedrendererv2.cpp.

Referenced by QgsRuleBasedRendererV2::startRender().

QString QgsRuleBasedRendererV2::Rule::label ( ) const
inline
QStringList QgsRuleBasedRendererV2::Rule::needsFields ( ) const

Definition at line 71 of file qgsrulebasedrendererv2.cpp.

Referenced by QgsRuleBasedRendererV2::usedAttributes().

QgsRuleBasedRendererV2::Rule & QgsRuleBasedRendererV2::Rule::operator= ( const Rule other)
int QgsRuleBasedRendererV2::Rule::scaleMaxDenom ( ) const
inline
int QgsRuleBasedRendererV2::Rule::scaleMinDenom ( ) const
inline
void QgsRuleBasedRendererV2::Rule::setDescription ( QString  description)
inline

Definition at line 68 of file qgsrulebasedrendererv2.h.

void QgsRuleBasedRendererV2::Rule::setFilterExpression ( QString  filterExp)
inline

Definition at line 66 of file qgsrulebasedrendererv2.h.

void QgsRuleBasedRendererV2::Rule::setLabel ( QString  label)
inline

Definition at line 67 of file qgsrulebasedrendererv2.h.

void QgsRuleBasedRendererV2::Rule::setScaleMaxDenom ( int  scaleMaxDenom)
inline

Definition at line 65 of file qgsrulebasedrendererv2.h.

void QgsRuleBasedRendererV2::Rule::setScaleMinDenom ( int  scaleMinDenom)
inline

Definition at line 64 of file qgsrulebasedrendererv2.h.

QgsSymbolV2* QgsRuleBasedRendererV2::Rule::symbol ( )
inline

Member Data Documentation

QString QgsRuleBasedRendererV2::Rule::mDescription
protected

Definition at line 78 of file qgsrulebasedrendererv2.h.

Referenced by operator=().

QString QgsRuleBasedRendererV2::Rule::mFilterExp
protected

Definition at line 78 of file qgsrulebasedrendererv2.h.

Referenced by operator=().

QgsSearchString QgsRuleBasedRendererV2::Rule::mFilterParsed
protected

Definition at line 81 of file qgsrulebasedrendererv2.h.

QgsSearchTreeNode* QgsRuleBasedRendererV2::Rule::mFilterTree
protected

Definition at line 82 of file qgsrulebasedrendererv2.h.

QString QgsRuleBasedRendererV2::Rule::mLabel
protected

Definition at line 78 of file qgsrulebasedrendererv2.h.

Referenced by operator=().

int QgsRuleBasedRendererV2::Rule::mScaleMaxDenom
protected

Definition at line 77 of file qgsrulebasedrendererv2.h.

Referenced by operator=().

int QgsRuleBasedRendererV2::Rule::mScaleMinDenom
protected

Definition at line 77 of file qgsrulebasedrendererv2.h.

Referenced by operator=().

QgsSymbolV2* QgsRuleBasedRendererV2::Rule::mSymbol
protected

Definition at line 76 of file qgsrulebasedrendererv2.h.

Referenced by operator=().


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