wxSQLite3::AggregateFunction Class Reference

Interface for user defined aggregate functions. More...

#include <wxsqlite3.h>

Public Member Functions
	AggregateFunction ()
	Constructor.
virtual	~AggregateFunction ()
	Virtual destructor.
int	GetCount () const
	Get counter.
void	IncrementCount ()
	Increment counter.
virtual void	Aggregate (FunctionContext &ctx)=0
	Execute the aggregate of the function.
virtual void	Finalize (FunctionContext &ctx)=0
	Prepare the result of the aggregate function.

Detailed Description

Interface for user defined aggregate functions.

Constructor & Destructor Documentation

AggregateFunction()

wxSQLite3::AggregateFunction::AggregateFunction ( )

inline

Constructor.

~AggregateFunction()

virtual wxSQLite3::AggregateFunction::~AggregateFunction ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

Aggregate()

virtual void wxSQLite3::AggregateFunction::Aggregate ( FunctionContext & ctx )

pure virtual

Execute the aggregate of the function.

This method is invoked for each row of the result set of the query using the aggregate function.

Parameters

ctx	function context which can be used to access arguments and result value

Finalize()

virtual void wxSQLite3::AggregateFunction::Finalize ( FunctionContext & ctx )

pure virtual

Prepare the result of the aggregate function.

This method is invoked after all rows of the result set of the query using the aggregate function have been processed. Usually the final result is calculated and returned in this method.

Parameters

ctx	function context which can be used to access arguments and result value

GetCount()

int wxSQLite3::AggregateFunction::GetCount ( ) const

inline

Get counter.

IncrementCount()

void wxSQLite3::AggregateFunction::IncrementCount ( )

inline

Increment counter.

---

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

• wxsqlite3.h