All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
HSEPData::CycleBase Class Referenceabstract

A Cycle is a special type of class that permits to execute a method for each one of the elements returned on a query operation, maintaining a state that will survive each one of these executions. More...

#include <DBBase.h>

+ Inheritance diagram for HSEPData::CycleBase:

Public Member Functions

virtual ~CycleBase ()
 
virtual bool execute (DBResultSet *pResultSetPtr, bool pIsFirst, bool pIsLast)=0
 Receives a row from a data operation to execute some action on it.
 

Detailed Description

A Cycle is a special type of class that permits to execute a method for each one of the elements returned on a query operation, maintaining a state that will survive each one of these executions.

Can be used for many purposes, as to accumulate data or to perform different types of batch processing operations.

The Cycle depends on how the pResultSetPtr has been created. It only uses the memory has been declared for its particular instance, so it is well suited for any type of batch processing operation.

Definition at line 81 of file DBBase.h.

Constructor & Destructor Documentation

virtual HSEPData::CycleBase::~CycleBase ( )
inlinevirtual

Definition at line 83 of file DBBase.h.

Member Function Documentation

virtual bool HSEPData::CycleBase::execute ( DBResultSet pResultSetPtr,
bool  pIsFirst,
bool  pIsLast 
)
pure virtual

Receives a row from a data operation to execute some action on it.

The operation will be repeated for every row received in a data set.

Parameters
pResultSetPtrThe received row
pIsFirsttrue when it is the first row in the data set
pIsLasttrue when it is the last row in the data set
Returns
true or false depends on the context. Usually true means the data was operated.

Implemented in HSEPData::QueryUniqueCycle, and HSEPData::NullCycle.

Referenced by HSEPDataSqLite::SqLiteResultSet::forEach().

+ Here is the caller graph for this function:


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