RasterPage Class Reference
This is the object returned by RasterPager to represent a page of a RasterElement's data. More...
#include <RasterPage.h>
Public Member Functions | |
| virtual void * | getRawData ()=0 |
| virtual unsigned int | getNumRows ()=0 |
| virtual unsigned int | getNumColumns ()=0 |
| virtual unsigned int | getNumBands ()=0 |
| virtual unsigned int | getInterlineBytes ()=0 |
Protected Member Functions | |
| virtual | ~RasterPage () |
Detailed Description
This is the object returned by RasterPager to represent a page of a RasterElement's data.
- See also:
- RasterPager
- Examples:
-
SampleRasterElementImporter.cpp, and SampleRasterElementImporter.h.
Definition at line 21 of file RasterPage.h.
Constructor & Destructor Documentation
| virtual RasterPage::~RasterPage | ( | ) | [protected, virtual] |
This should be destroyed by calling RasterPager::releasePage.
Definition at line 81 of file RasterPage.h.
Member Function Documentation
| virtual void* RasterPage::getRawData | ( | ) | [pure virtual] |
Returns a pointer to the raw cube data that was requested by the RasterPager::getPage() method and that was loaded from the original data into memory.
- Returns:
- a pointer to the requested raw cube data.
Implemented in CachedPage.
- Examples:
- SampleRasterElementImporter.h.
| virtual unsigned int RasterPage::getNumRows | ( | ) | [pure virtual] |
Returns the number of full complete rows of data that are contained with the memory returned by the getRawData() method.
- Returns:
- the number of full complete rows
Implemented in CachedPage.
- Examples:
- SampleRasterElementImporter.h.
| virtual unsigned int RasterPage::getNumColumns | ( | ) | [pure virtual] |
Returns the number of columns that must be skipped in from the initial pointer returned by getRawData() in order to access the same column in the second row.
- Returns:
- the number of columns that must be skipped. If a value of zero is returned, the RasterElement will assume that it will require DataDescriptor::getColumnNum() columns to be skipped in order to access the same column in the next row.
Implemented in CachedPage.
- Examples:
- SampleRasterElementImporter.h.
| virtual unsigned int RasterPage::getNumBands | ( | ) | [pure virtual] |
Returns the number of bands that must skipped in order to access the next column in BIP formatted data, or the same row/column in BIL formatted data.
- Returns:
- the number of full complete bands. If a value of zero is returned, the RasterElement will assume that it will require DataDescriptor::getBandNum() bands to be skipped. If the requested data is BSQ formatted, a value of zero should be returned from this method.
Implemented in CachedPage.
- Examples:
- SampleRasterElementImporter.h.
| virtual unsigned int RasterPage::getInterlineBytes | ( | ) | [pure virtual] |
Returns the number of inter-line bytes that must be skipped in order to access the same column in the next row.
- Returns:
- the number of inter-line bytes.
Implemented in CachedPage.
- Examples:
- SampleRasterElementImporter.h.