QGIS API Documentation  3.9.0-Master (224899f119)
Public Types | Public Member Functions | List of all members
QgsExpressionNodeBinaryOperator Class Reference

A binary expression operator, which operates on two values. More...

#include <qgsexpressionnodeimpl.h>

Inheritance diagram for QgsExpressionNodeBinaryOperator:
Inheritance graph
[legend]

Public Types

enum  BinaryOperator {
  boOr, boAnd, boEQ, boNE,
  boLE, boGE, boLT, boGT,
  boRegexp, boLike, boNotLike, boILike,
  boNotILike, boIs, boIsNot, boPlus,
  boMinus, boMul, boDiv, boIntDiv,
  boMod, boPow, boConcat
}
 list of binary operators More...
 
- Public Types inherited from QgsExpressionNode
enum  NodeType {
  ntUnaryOperator, ntBinaryOperator, ntInOperator, ntFunction,
  ntLiteral, ntColumnRef, ntCondition, ntIndexOperator
}
 Known node types. More...
 

Public Member Functions

 QgsExpressionNodeBinaryOperator (QgsExpressionNodeBinaryOperator::BinaryOperator op, QgsExpressionNode *opLeft, QgsExpressionNode *opRight)
 Binary combination of the left and the right with op. More...
 
 ~QgsExpressionNodeBinaryOperator () override
 
QgsExpressionNodeclone () const override
 Generate a clone of this node. More...
 
QString dump () const override
 Dump this node into a serialized (part) of an expression. More...
 
QVariant evalNode (QgsExpression *parent, const QgsExpressionContext *context) override
 Abstract virtual eval method Errors are reported to the parent. More...
 
bool isStatic (QgsExpression *parent, const QgsExpressionContext *context) const override
 Returns true if this node can be evaluated for a static value. More...
 
bool leftAssociative () const
 Returns true if the operator is left-associative. More...
 
bool needsGeometry () const override
 Abstract virtual method which returns if the geometry is required to evaluate this expression. More...
 
QList< const QgsExpressionNode * > nodes () const override
 Returns a list of all nodes which are used in this expression. More...
 
QgsExpressionNode::NodeType nodeType () const override
 Gets the type of this node. More...
 
QgsExpressionNodeBinaryOperator::BinaryOperator op () const
 Returns the binary operator. More...
 
QgsExpressionNodeopLeft () const
 Returns the node to the left of the operator. More...
 
QgsExpressionNodeopRight () const
 Returns the node to the right of the operator. More...
 
int precedence () const
 Returns the precedence index for the operator. More...
 
bool prepareNode (QgsExpression *parent, const QgsExpressionContext *context) override
 Abstract virtual preparation method Errors are reported to the parent. More...
 
QSet< QString > referencedColumns () const override
 Abstract virtual method which returns a list of columns required to evaluate this node. More...
 
QSet< QString > referencedFunctions () const override
 Returns a set of all functions which are used in this expression. More...
 
QSet< QString > referencedVariables () const override
 Returns a set of all variables which are used in this expression. More...
 
QString text () const
 Returns a the name of this operator without the operands. More...
 
- Public Member Functions inherited from QgsExpressionNode
virtual ~QgsExpressionNode ()=default
 
QVariant eval (QgsExpression *parent, const QgsExpressionContext *context)
 Evaluate this node with the given context and parent. More...
 
bool prepare (QgsExpression *parent, const QgsExpressionContext *context)
 Prepare this node for evaluation. More...
 

Additional Inherited Members

- Public Attributes inherited from QgsExpressionNode
int parserFirstColumn = 0
 First column in the parser this node was found. More...
 
int parserFirstLine = 0
 First line in the parser this node was found. More...
 
int parserLastColumn = 0
 Last column in the parser this node was found. More...
 
int parserLastLine = 0
 Last line in the parser this node was found. More...
 
- Protected Member Functions inherited from QgsExpressionNode
void cloneTo (QgsExpressionNode *target) const
 Copies the members of this node to the node provided in target. More...
 

Detailed Description

A binary expression operator, which operates on two values.

Definition at line 91 of file qgsexpressionnodeimpl.h.

Member Enumeration Documentation

◆ BinaryOperator

list of binary operators

Note
if any change is made here, the definition of QgsExpression::BinaryOperatorText[] must be adapted.
Enumerator
boOr 
boAnd 
boEQ 

=

boNE 

<>

boLE 

<=

boGE 

>=

boLT 

<

boGT 

>

boRegexp 
boLike 
boNotLike 
boILike 
boNotILike 
boIs 
boIsNot 
boPlus 
boMinus 
boMul 
boDiv 
boIntDiv 
boMod 
boPow 
boConcat 

Definition at line 99 of file qgsexpressionnodeimpl.h.

Constructor & Destructor Documentation

◆ QgsExpressionNodeBinaryOperator()

QgsExpressionNodeBinaryOperator::QgsExpressionNodeBinaryOperator ( QgsExpressionNodeBinaryOperator::BinaryOperator  op,
QgsExpressionNode opLeft,
QgsExpressionNode opRight 
)
inline

Binary combination of the left and the right with op.

Definition at line 136 of file qgsexpressionnodeimpl.h.

◆ ~QgsExpressionNodeBinaryOperator()

QgsExpressionNodeBinaryOperator::~QgsExpressionNodeBinaryOperator ( )
inlineoverride

Definition at line 141 of file qgsexpressionnodeimpl.h.

Member Function Documentation

◆ clone()

QgsExpressionNode * QgsExpressionNodeBinaryOperator::clone ( ) const
overridevirtual

Generate a clone of this node.

Ownership is transferred to the caller.

Returns
a deep copy of this node.

Implements QgsExpressionNode.

Definition at line 763 of file qgsexpressionnodeimpl.cpp.

◆ dump()

QString QgsExpressionNodeBinaryOperator::dump ( ) const
overridevirtual

Dump this node into a serialized (part) of an expression.

The returned expression does not necessarily literally match the original expression, it's just guaranteed to behave the same way.

Implements QgsExpressionNode.

Definition at line 704 of file qgsexpressionnodeimpl.cpp.

◆ evalNode()

QVariant QgsExpressionNodeBinaryOperator::evalNode ( QgsExpression parent,
const QgsExpressionContext context 
)
overridevirtual

Abstract virtual eval method Errors are reported to the parent.

Since
QGIS 3.0

Implements QgsExpressionNode.

Definition at line 177 of file qgsexpressionnodeimpl.cpp.

◆ isStatic()

bool QgsExpressionNodeBinaryOperator::isStatic ( QgsExpression parent,
const QgsExpressionContext context 
) const
overridevirtual

Returns true if this node can be evaluated for a static value.

This is used during the prepare() step and in case it returns true, the value of this node will already be evaluated and the result cached (and therefore not re-evaluated in subsequent calls to eval()). In case this returns true, prepareNode() will never be called.

Since
QGIS 3.0

Implements QgsExpressionNode.

Definition at line 770 of file qgsexpressionnodeimpl.cpp.

◆ leftAssociative()

bool QgsExpressionNodeBinaryOperator::leftAssociative ( ) const

Returns true if the operator is left-associative.

Definition at line 668 of file qgsexpressionnodeimpl.cpp.

◆ needsGeometry()

bool QgsExpressionNodeBinaryOperator::needsGeometry ( ) const
overridevirtual

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 QgsExpressionNode.

Definition at line 758 of file qgsexpressionnodeimpl.cpp.

◆ nodes()

QList< const QgsExpressionNode * > QgsExpressionNodeBinaryOperator::nodes ( ) const
overridevirtual

Returns a list of all nodes which are used in this expression.

Note
not available in Python bindings
Since
QGIS 3.2

Implements QgsExpressionNode.

Definition at line 750 of file qgsexpressionnodeimpl.cpp.

◆ nodeType()

QgsExpressionNode::NodeType QgsExpressionNodeBinaryOperator::nodeType ( ) const
overridevirtual

Gets the type of this node.

Returns
The type of this node

Implements QgsExpressionNode.

Definition at line 610 of file qgsexpressionnodeimpl.cpp.

◆ op()

QgsExpressionNodeBinaryOperator::BinaryOperator QgsExpressionNodeBinaryOperator::op ( ) const
inline

Returns the binary operator.

Definition at line 146 of file qgsexpressionnodeimpl.h.

◆ opLeft()

QgsExpressionNode* QgsExpressionNodeBinaryOperator::opLeft ( ) const
inline

Returns the node to the left of the operator.

See also
opRight()

Definition at line 152 of file qgsexpressionnodeimpl.h.

◆ opRight()

QgsExpressionNode* QgsExpressionNodeBinaryOperator::opRight ( ) const
inline

Returns the node to the right of the operator.

See also
opLeft()

Definition at line 158 of file qgsexpressionnodeimpl.h.

◆ precedence()

int QgsExpressionNodeBinaryOperator::precedence ( ) const

Returns the precedence index for the operator.

Higher values have higher precedence.

Definition at line 622 of file qgsexpressionnodeimpl.cpp.

◆ prepareNode()

bool QgsExpressionNodeBinaryOperator::prepareNode ( QgsExpression parent,
const QgsExpressionContext context 
)
overridevirtual

Abstract virtual preparation method Errors are reported to the parent.

Since
QGIS 3.0

Implements QgsExpressionNode.

Definition at line 615 of file qgsexpressionnodeimpl.cpp.

◆ referencedColumns()

QSet< QString > QgsExpressionNodeBinaryOperator::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 QgsExpressionNode.

Definition at line 735 of file qgsexpressionnodeimpl.cpp.

◆ referencedFunctions()

QSet< QString > QgsExpressionNodeBinaryOperator::referencedFunctions ( ) const
overridevirtual

Returns a set of all functions which are used in this expression.

Implements QgsExpressionNode.

Definition at line 745 of file qgsexpressionnodeimpl.cpp.

◆ referencedVariables()

QSet< QString > QgsExpressionNodeBinaryOperator::referencedVariables ( ) const
overridevirtual

Returns a set of all variables which are used in this expression.

Implements QgsExpressionNode.

Definition at line 740 of file qgsexpressionnodeimpl.cpp.

◆ text()

QString QgsExpressionNodeBinaryOperator::text ( ) const

Returns a the name of this operator without the operands.

I.e. "AND", "OR", ...

Definition at line 1562 of file qgsexpressionnodeimpl.cpp.


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