QGIS API Documentation  3.11.0-Master (68611307d7)
Public Member Functions | Protected Attributes | List of all members
QgsSQLStatement::NodeFunction Class Reference

Function with a name and arguments node. More...

#include <qgssqlstatement.h>

Inheritance diagram for QgsSQLStatement::NodeFunction:
Inheritance graph
[legend]

Public Member Functions

 NodeFunction (const QString &name, QgsSQLStatement::NodeList *args)
 Constructor. More...
 
 ~NodeFunction () override
 
void accept (QgsSQLStatement::Visitor &v) const override
 Support the visitor pattern. More...
 
QgsSQLStatement::NodeListargs () const
 Returns arguments. More...
 
QgsSQLStatement::Nodeclone () const override
 Generate a clone of this node. More...
 
QString dump () const override
 Abstract virtual dump method. More...
 
QString name () const
 Returns function name. More...
 
QgsSQLStatement::NodeType nodeType () const override
 Abstract virtual that returns the type of this node. More...
 
- Public Member Functions inherited from QgsSQLStatement::Node
virtual ~Node ()=default
 

Protected Attributes

NodeListmArgs = nullptr
 
QString mName
 

Detailed Description

Function with a name and arguments node.

Definition at line 464 of file qgssqlstatement.h.

Constructor & Destructor Documentation

◆ NodeFunction()

QgsSQLStatement::NodeFunction::NodeFunction ( const QString &  name,
QgsSQLStatement::NodeList args 
)
inline

Constructor.

Definition at line 468 of file qgssqlstatement.h.

◆ ~NodeFunction()

QgsSQLStatement::NodeFunction::~NodeFunction ( )
inlineoverride

Definition at line 469 of file qgssqlstatement.h.

Member Function Documentation

◆ accept()

void QgsSQLStatement::NodeFunction::accept ( QgsSQLStatement::Visitor v) const
inlineoverridevirtual

Support the visitor pattern.

For any implementation this should look like

C++:

v.visit( *this );

Python:

v.visit( self)
Parameters
vA visitor that visits this node.

Implements QgsSQLStatement::Node.

Definition at line 480 of file qgssqlstatement.h.

◆ args()

QgsSQLStatement::NodeList* QgsSQLStatement::NodeFunction::args ( ) const
inline

Returns arguments.

Definition at line 475 of file qgssqlstatement.h.

◆ clone()

QgsSQLStatement::Node * QgsSQLStatement::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 QgsSQLStatement::Node.

Definition at line 455 of file qgssqlstatement.cpp.

◆ dump()

QString QgsSQLStatement::NodeFunction::dump ( ) const
overridevirtual

Abstract virtual dump method.

Returns
A statement which represents this node as string

Implements QgsSQLStatement::Node.

Definition at line 450 of file qgssqlstatement.cpp.

◆ name()

QString QgsSQLStatement::NodeFunction::name ( ) const
inline

Returns function name.

Definition at line 472 of file qgssqlstatement.h.

◆ nodeType()

QgsSQLStatement::NodeType QgsSQLStatement::NodeFunction::nodeType ( ) const
inlineoverridevirtual

Abstract virtual that returns the type of this node.

Returns
The type of this node

Implements QgsSQLStatement::Node.

Definition at line 477 of file qgssqlstatement.h.

Member Data Documentation

◆ mArgs

NodeList* QgsSQLStatement::NodeFunction::mArgs = nullptr
protected

Definition at line 485 of file qgssqlstatement.h.

◆ mName

QString QgsSQLStatement::NodeFunction::mName
protected

Definition at line 484 of file qgssqlstatement.h.


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