CppSamples::Common::Paging Class Reference

Paging class helps to divide a collection into pages of given number of lines. More...

#include <Paging.h>

Public Member Functions
	Paging (int count, int numberInPage)
	Create an instance of Paging class. More...
	~Paging ()
int	GetCurrentPage () const
	Current page number. It gives 1 for first page. More...
int	GetEndIndex () const
	Zero based index of last item in the current page. More...
int	GetPageCount () const
	Total number of pages. More...
int	GetStartIndex () const
	Zero based index of first item in the current page. More...
void	NextPage ()
	Move to the next page. More...
void	PreviousPage ()
	Move to the previous page. More...

Private Attributes
int	_count
int	_currentPage
int	_numberInPage
int	_pageCount

Detailed Description

Paging class helps to divide a collection into pages of given number of lines.

Definition at line 9 of file Paging.h.

Constructor & Destructor Documentation

Paging::Paging	(	int	count,
		int	numberInPage
	)

Create an instance of Paging class.

Parameters

count	Total number of items in the collection.
numberInPage	Required number of items per page.

Definition at line 7 of file Paging.cpp.

                                          {
    // Initialize the default variables
    _count = count;
    _numberInPage = numberInPage;
    _currentPage = 1;

    // Calculate total number of pages from given input
    _pageCount = (count - 1) / numberInPage + 1;
}

CppSamples::Common::Paging::~Paging ( )

inline

Definition at line 19 of file Paging.h.

{ }

Member Function Documentation

int Paging::GetCurrentPage

(

)

const

Current page number. It gives 1 for first page.

Definition at line 18 of file Paging.cpp.

                                 {
    // Get current page number
    return _currentPage;
}

int Paging::GetEndIndex

(

)

const

Zero based index of last item in the current page.

Definition at line 24 of file Paging.cpp.

                              {
    // Calculate end index
    int endIndex = _currentPage *_numberInPage - 1;
    // Ensure the index is not crossing the limit.
    if (endIndex >= _count)
        endIndex = _count - 1;
    return endIndex;
}

int CppSamples::Common::Paging::GetPageCount ( ) const

inline

Total number of pages.

Definition at line 34 of file Paging.h.

{ return _pageCount; }

int Paging::GetStartIndex

(

)

const

Zero based index of first item in the current page.

Definition at line 34 of file Paging.cpp.

                                {
    // Calculate start index
    return (_currentPage - 1)*_numberInPage;
}

void Paging::NextPage

(

)

Move to the next page.

Definition at line 39 of file Paging.cpp.

                      {
    // Move to next page
    _currentPage++;
    // Ensure the page number is not crossing the limit.
    if (_currentPage > _pageCount)
        _currentPage = _pageCount;
}

void Paging::PreviousPage

(

)

Move to the previous page.

Definition at line 47 of file Paging.cpp.

                          {
    // Move back to previous page
    _currentPage--;
    // Ensure the page number is not crossing the limit.
    if (_currentPage <= 0)
        _currentPage = 1;
}

Member Data Documentation

int CppSamples::Common::Paging::_count

private

Definition at line 52 of file Paging.h.

int CppSamples::Common::Paging::_currentPage

private

Definition at line 53 of file Paging.h.

int CppSamples::Common::Paging::_numberInPage

private

Definition at line 54 of file Paging.h.

int CppSamples::Common::Paging::_pageCount

private

Definition at line 55 of file Paging.h.

---

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

• C:/Git/VxSDK-Samples/CppSamples/Source/Common/Paging.h
• C:/Git/VxSDK-Samples/CppSamples/Source/Common/Paging.cpp