dballe::Cursor Class Reference

Base class for cursors that iterate over DB query results. More...

#include <cursor.h>

Inheritance diagram for dballe::Cursor:

Public Member Functions
virtual bool	has_value () const =0
	Check if the cursor points to a valid value.
virtual int	remaining () const =0
	Get the number of rows still to be fetched.
virtual bool	next ()=0
	Get a new item from the results of a query.
virtual void	discard ()=0
	Discard the results that have not been read yet.
virtual DBStation	get_station () const =0
	Get the whole station data in a single call.

Detailed Description

Base class for cursors that iterate over DB query results.

Member Function Documentation

discard()

virtual void dballe::Cursor::discard ( )

pure virtual

Discard the results that have not been read yet.

Implemented in dballe::db::summary::Cursor< Station >, dballe::impl::msg::CursorData, dballe::impl::msg::CursorStation, and dballe::impl::msg::CursorStationData.

get_station()

virtual DBStation dballe::Cursor::get_station ( ) const

pure virtual

Get the whole station data in a single call.

Implemented in dballe::db::summary::Cursor< Station >, dballe::impl::msg::CursorData, dballe::impl::msg::CursorStation, and dballe::impl::msg::CursorStationData.

has_value()

virtual bool dballe::Cursor::has_value ( ) const

pure virtual

Check if the cursor points to a valid value.

Returns

true if the cursor points to a valid accessible value, false if next() has not been called yet, or if at the end of iteration (i.e. next() returned false)

Implemented in dballe::db::summary::Cursor< Station >, dballe::impl::msg::CursorData, dballe::impl::msg::CursorStation, and dballe::impl::msg::CursorStationData.

next()

virtual bool dballe::Cursor::next ( )

pure virtual

Get a new item from the results of a query.

Returns

true if a new record has been read, false if there is no more data to read

Implemented in dballe::db::summary::Cursor< Station >, dballe::impl::msg::CursorData, dballe::impl::msg::CursorStation, and dballe::impl::msg::CursorStationData.

remaining()

virtual int dballe::Cursor::remaining ( ) const

pure virtual

Get the number of rows still to be fetched.

Returns

The number of rows still to be queried. The value is undefined if no query has been successfully peformed yet using this cursor.

Implemented in dballe::db::summary::Cursor< Station >, dballe::impl::msg::CursorData, dballe::impl::msg::CursorStation, and dballe::impl::msg::CursorStationData.

---

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

• cursor.h