libdballe  7.29
Public Member Functions | List of all members
dballe::db::Cursor Struct Referenceabstract

Common interface for all kinds of cursors. More...

#include <db.h>

Inheritance diagram for dballe::db::Cursor:
dballe::db::CursorStation dballe::db::CursorSummary dballe::db::CursorValue dballe::db::CursorData dballe::db::CursorStationData

Public Member Functions

virtual DBget_db () const =0
 Get the database that created this cursor.
 
virtual int remaining () const =0
 Get the number of rows still to be fetched. More...
 
virtual bool next ()=0
 Get a new item from the results of a query. More...
 
virtual void discard_rest ()=0
 Discard the results that have not been read yet.
 
virtual void to_record (Record &rec)=0
 Fill in a record with the contents of a dba_db_cursor. More...
 
virtual Station get_station () const =0
 Get the whole station data in a single call.
 
virtual int get_station_id () const =0
 Get the station identifier.
 
virtual double get_lat () const =0
 Get the station latitude.
 
virtual double get_lon () const =0
 Get the station longitude.
 
virtual const char * get_ident (const char *def=0) const =0
 Get the station identifier, or NULL if missing.
 
virtual const char * get_rep_memo () const =0
 Get the report name.
 
virtual unsigned test_iterate (FILE *dump=0)
 Iterate the cursor until the end, returning the number of items. More...
 

Detailed Description

Common interface for all kinds of cursors.

Member Function Documentation

virtual bool dballe::db::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
virtual int dballe::db::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.
virtual unsigned dballe::db::Cursor::test_iterate ( FILE *  dump = 0)
virtual

Iterate the cursor until the end, returning the number of items.

If dump is a FILE pointer, also dump the cursor values to it

virtual void dballe::db::Cursor::to_record ( Record rec)
pure virtual

Fill in a record with the contents of a dba_db_cursor.

Parameters
recThe record where to store the values

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