PixelLightAPI  .
Public Member Functions | Protected Member Functions | Protected Attributes
PLDatabase::DatabaseQueryResult Class Reference

Abstract database query result base class. More...

#include <DatabaseQueryResult.h>

List of all members.

Public Member Functions

virtual PLDATABASE_API ~DatabaseQueryResult ()
 Destructor.
PLDATABASE_API DatabaseQueryGetQuery () const
 Returns the database query this data base query result is in.
virtual bool IsEmpty () const =0
 Returns whether all query results are processed or not.
virtual void FirstRow ()=0
 Resets the query result to the first row.
virtual const PLCore::Array
< PLCore::String > & 
FetchFieldList ()=0
 Fetches the field list.
virtual const PLCore::HashMap
< PLCore::String,
PLCore::String > * 
FetchRow ()=0
 Fetches current row from cursor and moves forward.

Protected Member Functions

PLDATABASE_API DatabaseQueryResult (DatabaseQuery &cParentQuery)
 Constructor.

Protected Attributes

PLCore::Array< PLCore::Stringm_lstFields
PLCore::HashMap
< PLCore::String,
PLCore::String
m_mapRow

Detailed Description

Abstract database query result base class.


Constructor & Destructor Documentation

virtual PLDATABASE_API PLDatabase::DatabaseQueryResult::~DatabaseQueryResult ( ) [virtual]

Destructor.

PLDATABASE_API PLDatabase::DatabaseQueryResult::DatabaseQueryResult ( DatabaseQuery cParentQuery) [protected]

Constructor.

Parameters:
[in]cParentQueryDatabase query this database query result is in

Member Function Documentation

Returns the database query this data base query result is in.

Returns:
The database query this data base query result is in
virtual bool PLDatabase::DatabaseQueryResult::IsEmpty ( ) const [pure virtual]

Returns whether all query results are processed or not.

Returns:
'true' if all query results are processed, else 'false'
virtual void PLDatabase::DatabaseQueryResult::FirstRow ( ) [pure virtual]

Resets the query result to the first row.

Fetches the field list.

Returns:
Reference to the current field list

Fetches current row from cursor and moves forward.

Returns:
Pointer to the current row map, a null pointer on error (do NOT delete this!)

Member Data Documentation

List of fields

Row map


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


PixelLight PixelLight 0.9.11-R1
Copyright (C) 2002-2012 by The PixelLight Team
Last modified Thu Feb 23 2012 14:09:29
The content of this PixelLight document is published under the
Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported