Lux::Paging Class Reference

#include <paging.h>

List of all members.

Public Member Functions

 Paging (uint32_t cond_num=10, uint32_t cond_page=0)
 ~Paging ()
void set_total_num (uint32_t num_results)
void calc (void)
uint32_t get_base (void)
uint32_t get_base (void) const
uint32_t get_num (void)
uint32_t get_num (void) const
uint32_t get_page (void)
uint32_t get_page (void) const
uint32_t get_total_num (void)
uint32_t get_total_num (void) const


Detailed Description

paging interface


Constructor & Destructor Documentation

Lux::Paging::Paging ( uint32_t  cond_num = 10,
uint32_t  cond_page = 0 
)

constructor

Parameters:
cond_num the number of results returned
cond_page page offset

Lux::Paging::~Paging (  )  [inline]

destructor


Member Function Documentation

void Lux::Paging::calc ( void   ) 

calculate the offset of the returned results (base_) and the number of results returned (num_)

uint32_t Lux::Paging::get_base ( void   )  const

get page offset

uint32_t Lux::Paging::get_base ( void   ) 

get page offset

uint32_t Lux::Paging::get_num ( void   )  const

get the number of results returned

uint32_t Lux::Paging::get_num ( void   ) 

get the number of results returned

uint32_t Lux::Paging::get_page ( void   )  const

get page offset

uint32_t Lux::Paging::get_page ( void   ) 

get page offset

uint32_t Lux::Paging::get_total_num ( void   )  const

get the total number of results

uint32_t Lux::Paging::get_total_num ( void   ) 

get the total number of results

void Lux::Paging::set_total_num ( uint32_t  num_results  ) 

set the total number of results returned

Parameters:
num_results the total number of results returned
Note:
this is a method used internally


The documentation for this class was generated from the following files:
Generated on Fri Feb 5 15:50:30 2010 for Lux by  doxygen 1.4.7