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

Column in a ORDER BY. More...

#include <qgssqlstatement.h>

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

Public Member Functions

 NodeColumnSorted (QgsSQLStatement::NodeColumnRef *column, bool asc)
 Constructor. More...
 
 ~NodeColumnSorted () override
 
void accept (QgsSQLStatement::Visitor &v) const override
 Support the visitor pattern. More...
 
bool ascending () const
 Whether the column is sorted in ascending order. More...
 
QgsSQLStatement::Nodeclone () const override
 Generate a clone of this node. More...
 
QgsSQLStatement::NodeColumnSortedcloneThis () const
 Clone with same type return. More...
 
QgsSQLStatement::NodeColumnRefcolumn () const
 The name of the column. More...
 
QString dump () const override
 Abstract virtual dump method. 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

bool mAsc
 
NodeColumnRefmColumn = nullptr
 

Detailed Description

Column in a ORDER BY.

Definition at line 690 of file qgssqlstatement.h.

Constructor & Destructor Documentation

◆ NodeColumnSorted()

QgsSQLStatement::NodeColumnSorted::NodeColumnSorted ( QgsSQLStatement::NodeColumnRef column,
bool  asc 
)
inline

Constructor.

Definition at line 694 of file qgssqlstatement.h.

◆ ~NodeColumnSorted()

QgsSQLStatement::NodeColumnSorted::~NodeColumnSorted ( )
inlineoverride

Definition at line 695 of file qgssqlstatement.h.

Member Function Documentation

◆ accept()

void QgsSQLStatement::NodeColumnSorted::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 706 of file qgssqlstatement.h.

◆ ascending()

bool QgsSQLStatement::NodeColumnSorted::ascending ( ) const
inline

Whether the column is sorted in ascending order.

Definition at line 701 of file qgssqlstatement.h.

◆ clone()

QgsSQLStatement::Node * QgsSQLStatement::NodeColumnSorted::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 720 of file qgssqlstatement.cpp.

◆ cloneThis()

QgsSQLStatement::NodeColumnSorted * QgsSQLStatement::NodeColumnSorted::cloneThis ( ) const

Clone with same type return.

Definition at line 725 of file qgssqlstatement.cpp.

◆ column()

QgsSQLStatement::NodeColumnRef* QgsSQLStatement::NodeColumnSorted::column ( ) const
inline

The name of the column.

Definition at line 698 of file qgssqlstatement.h.

◆ dump()

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

Abstract virtual dump method.

Returns
A statement which represents this node as string

Implements QgsSQLStatement::Node.

Definition at line 711 of file qgssqlstatement.cpp.

◆ nodeType()

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

Abstract virtual that returns the type of this node.

Returns
The type of this node

Implements QgsSQLStatement::Node.

Definition at line 703 of file qgssqlstatement.h.

Member Data Documentation

◆ mAsc

bool QgsSQLStatement::NodeColumnSorted::mAsc
protected

Definition at line 713 of file qgssqlstatement.h.

◆ mColumn

NodeColumnRef* QgsSQLStatement::NodeColumnSorted::mColumn = nullptr
protected

Definition at line 712 of file qgssqlstatement.h.


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