CachedPage Class Reference

Provides means of using page sharing with the DataAccessor class. More...

#include <CachedPage.h>

Inheritance diagram for CachedPage:

List of all members.

Public Types
typedef boost::shared_ptr < CacheUnit >	UnitPtr
Public Member Functions
	CachedPage (UnitPtr pCacheUnit, size_t offset, DimensionDescriptor startRow)
virtual	~CachedPage ()
void *	getRawData ()
unsigned int	getNumRows ()
unsigned int	getNumColumns ()
unsigned int	getNumBands ()
unsigned int	getInterlineBytes ()
Classes
class	CacheUnit

---

Detailed Description

Provides means of using page sharing with the DataAccessor class.

Page sharing/caching allows multiple data accessors to have read-only access to the same page. The CachedPage and RasterPage are thread-safe classes.

Definition at line 25 of file CachedPage.h.

---

Member Typedef Documentation

typedef boost::shared_ptr<CacheUnit> CachedPage::UnitPtr

Definition at line 127 of file CachedPage.h.

---

Constructor & Destructor Documentation

CachedPage::CachedPage	(	UnitPtr	pCacheUnit,
		size_t	offset,
		DimensionDescriptor	startRow
	)

Creates a CachedPage.

Parameters:

	pCacheUnit	The CacheUnit for this page
	offset	The number of bytes to offset into the block. This does not account for size of the data type.
	startRow	The start row for this page.

virtual CachedPage::~CachedPage

(

)

[virtual]

Virtual destructor to ensure proper deletion of inherited classes.

---

Member Function Documentation

void* CachedPage::getRawData

(

)

[virtual]

Obligation from base class; returns a pointer to the raw data.

Returns:

A pointer to the memory owned by the shared_array.

Implements RasterPage.

unsigned int CachedPage::getNumRows

(

)

[virtual]

Accessor to private data.

Returns:

The number of concurrent rows in this page.

Implements RasterPage.

unsigned int CachedPage::getNumColumns

(

)

[virtual]

Inherited obligations that return 0.

Returns:

Returns 0.

Implements RasterPage.

unsigned int CachedPage::getNumBands

(

)

[virtual]

Inherited obligations that return 0.

Returns:

Returns 0.

Implements RasterPage.

unsigned int CachedPage::getInterlineBytes

(

)

[virtual]

Access the number of interline bytes in the page.

Returns:

The number of interline bytes.

Implements RasterPage.