#include <qgsexpression.h>

Inheritance diagram for QgsExpression::NodeFunction:

Public Member Functions
	NodeFunction (int fnIndex, NodeList *args)

virtual	~NodeFunction ()

virtual void	accept (Visitor &v) const override
	Support the visitor pattern. More...

NodeList *	args () const

virtual Node *	clone () const override
	Generate a clone of this node. More...

virtual QString	dump () const override
	Abstract virtual dump method. More...

virtual QVariant	eval (QgsExpression parent, const QgsExpressionContext context) override
	Abstract virtual eval method Errors are reported to the parent. More...

int	fnIndex () const

virtual bool	needsGeometry () const override
	Abstract virtual method which returns if the geometry is required to evaluate this expression. More...

virtual NodeType	nodeType () const override
	Abstract virtual that returns the type of this node. More...

virtual bool	prepare (QgsExpression parent, const QgsExpressionContext context) override
	Abstract virtual preparation method Errors are reported to the parent. More...

virtual QStringList	referencedColumns () const override
	Abstract virtual method which returns a list of columns required to evaluate this node. More...

Public Member Functions inherited from QgsExpression::Node
virtual	~Node ()

virtual Q_DECL_DEPRECATED QVariant	eval (QgsExpression parent, const QgsFeature f)
	Abstract virtual eval method Errors are reported to the parent. More...

virtual Q_DECL_DEPRECATED bool	prepare (QgsExpression *parent, const QgsFields &fields)
	Abstract virtual preparation method Errors are reported to the parent. More...

Static Public Member Functions
static bool	validateParams (int fnIndex, NodeList *args, QString &error)
	Tests whether the provided argument list is valid for the matching function. More...

Protected Attributes
NodeList *	mArgs

int	mFnIndex

Detailed Description

Definition at line 1198 of file qgsexpression.h.

Constructor & Destructor Documentation

◆ NodeFunction()

QgsExpression::NodeFunction::NodeFunction	(	int	fnIndex,
		NodeList *	args
	)

inline

Definition at line 1201 of file qgsexpression.h.

◆ ~NodeFunction()

virtual QgsExpression::NodeFunction::~NodeFunction ( )

inlinevirtual

Definition at line 1240 of file qgsexpression.h.

Member Function Documentation

◆ accept()

virtual void QgsExpression::NodeFunction::accept ( Visitor & v ) const

inlineoverridevirtual

Support the visitor pattern.

For any implementation this should look like

C++:

v.visit( *this );

Python:

v.visit( self)

Parameters

v	A visitor that visits this node.

Implements QgsExpression::Node.

Definition at line 1252 of file qgsexpression.h.

◆ args()

NodeList* QgsExpression::NodeFunction::args ( ) const

inline

Definition at line 1243 of file qgsexpression.h.

◆ clone()

QgsExpression::Node * QgsExpression::NodeFunction::clone ( ) const

overridevirtual

Generate a clone of this node.

Make sure that the clone does not contain any information which is generated in prepare and context related. Ownership is transferred to the caller.

Returns: a deep copy of this node.

Implements QgsExpression::Node.

Definition at line 4767 of file qgsexpression.cpp.

◆ dump()

QString QgsExpression::NodeFunction::dump ( ) const

overridevirtual

Abstract virtual dump method.

Returns: An expression which represents this node as string

Implements QgsExpression::Node.

Definition at line 4738 of file qgsexpression.cpp.

◆ eval()

QVariant QgsExpression::NodeFunction::eval	(	QgsExpression *	parent,
		const QgsExpressionContext *	context
	)

overridevirtual

Abstract virtual eval method Errors are reported to the parent.

Note: added in QGIS 2.12

Reimplemented from QgsExpression::Node.

Definition at line 4687 of file qgsexpression.cpp.

◆ fnIndex()

int QgsExpression::NodeFunction::fnIndex ( ) const

inline

Definition at line 1242 of file qgsexpression.h.

◆ needsGeometry()

virtual bool QgsExpression::NodeFunction::needsGeometry ( ) const

inlineoverridevirtual

Abstract virtual method which returns if the geometry is required to evaluate this expression.

This needs to call needsGeometry() recursively on any child nodes.

Returns: true if a geometry is required to evaluate this expression

Implements QgsExpression::Node.

Definition at line 1251 of file qgsexpression.h.

◆ nodeType()

virtual NodeType QgsExpression::NodeFunction::nodeType ( ) const

inlineoverridevirtual

Abstract virtual that returns the type of this node.

Returns: The type of this node

Implements QgsExpression::Node.

Definition at line 1245 of file qgsexpression.h.

◆ prepare()

bool QgsExpression::NodeFunction::prepare	(	QgsExpression *	parent,
		const QgsExpressionContext *	context
	)

overridevirtual

Abstract virtual preparation method Errors are reported to the parent.

Note: added in QGIS 2.12

Reimplemented from QgsExpression::Node.

Definition at line 4723 of file qgsexpression.cpp.

◆ referencedColumns()

QStringList QgsExpression::NodeFunction::referencedColumns ( ) const

overridevirtual

Abstract virtual method which returns a list of columns required to evaluate this node.

When reimplementing this, you need to return any column that is required to evaluate this node and in addition recursively collect all the columns required to evaluate child nodes.

Returns: A list of columns required to evaluate this expression

Implements QgsExpression::Node.

Definition at line 4747 of file qgsexpression.cpp.

◆ validateParams()

static bool QgsExpression::NodeFunction::validateParams	(	int	fnIndex,
		NodeList *	args,
		QString &	error
	)

inlinestatic

Tests whether the provided argument list is valid for the matching function.

Definition at line 1256 of file qgsexpression.h.

Member Data Documentation

◆ mArgs

NodeList* QgsExpression::NodeFunction::mArgs

protected

Definition at line 1331 of file qgsexpression.h.

◆ mFnIndex

int QgsExpression::NodeFunction::mFnIndex

protected

Definition at line 1330 of file qgsexpression.h.

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

/tmp/buildd/qgis-2.18.21+99unstable/src/core/qgsexpression.h
/tmp/buildd/qgis-2.18.21+99unstable/src/core/qgsexpression.cpp

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ NodeFunction()

◆ ~NodeFunction()

Member Function Documentation

◆ accept()

◆ args()

◆ clone()

◆ dump()

◆ eval()

◆ fnIndex()

◆ needsGeometry()

◆ nodeType()

◆ prepare()

◆ referencedColumns()

◆ validateParams()

Member Data Documentation

◆ mArgs

◆ mFnIndex