#include <DataRequest.h>
Public Member Functions | |
| virtual DataRequest * | copy () const =0 |
| virtual bool | validate (const RasterDataDescriptor *pDescriptor) const =0 |
| virtual bool | polish (const RasterDataDescriptor *pDescriptor)=0 |
| virtual int | getRequestVersion (const RasterDataDescriptor *pDescriptor) const =0 |
| virtual InterleaveFormatType | getInterleaveFormat () const =0 |
| virtual void | setInterleaveFormat (InterleaveFormatType interleave)=0 |
| virtual DimensionDescriptor | getStartRow () const =0 |
| virtual DimensionDescriptor | getStopRow () const =0 |
| virtual unsigned int | getConcurrentRows () const =0 |
| virtual void | setRows (DimensionDescriptor startRow, DimensionDescriptor stopRow, unsigned int concurrentRows=0)=0 |
| virtual DimensionDescriptor | getStartColumn () const =0 |
| virtual DimensionDescriptor | getStopColumn () const =0 |
| virtual unsigned int | getConcurrentColumns () const =0 |
| virtual void | setColumns (DimensionDescriptor startColumn, DimensionDescriptor stopColumn, unsigned int concurrentColumns=0)=0 |
| virtual DimensionDescriptor | getStartBand () const =0 |
| virtual DimensionDescriptor | getStopBand () const =0 |
| virtual unsigned int | getConcurrentBands () const =0 |
| virtual void | setBands (DimensionDescriptor startBand, DimensionDescriptor stopBand, unsigned int concurrentBands=0)=0 |
| virtual bool | getWritable () const =0 |
| virtual void | setWritable (bool writable)=0 |
Protected Member Functions | |
| virtual | ~DataRequest () |
To use, create an instance with the ObjectFactory or a FactoryResource. Set the fields for which the defaults are insufficient. Pass in the instance to RasterElement::getDataAccessor.
SampleRasterElementImporter.cpp, and SampleRasterElementImporter.h.
Definition at line 28 of file DataRequest.h.
| virtual DataRequest::~DataRequest | ( | ) | [protected, virtual] |
This should be destroyed by calling ObjectFactory::destroyObject.
Definition at line 293 of file DataRequest.h.
| virtual DataRequest* DataRequest::copy | ( | ) | const [pure virtual] |
Creates and returns a copy of the object.
| virtual bool DataRequest::validate | ( | const RasterDataDescriptor * | pDescriptor | ) | const [pure virtual] |
Determine whether the DataRequest is valid for the given RasterDataDescriptor.
The validation will most likely fail if the DataRequest has not had polish() called on it.
Plug-ins generally do not need to call this function.
| pDescriptor | The descriptor to validate against. |
| virtual bool DataRequest::polish | ( | const RasterDataDescriptor * | pDescriptor | ) | [pure virtual] |
Polish the DataRequest for the given RasterDataDescriptor.
This function will apply any defaults to the actual value as appropriate for the given descriptor. This function should be called before validate().
The return values of accessor functions are not valid until this function has been called.
Plug-ins generally do not need to call this function, as the core will call it when appropriate.
| pDescriptor | The descriptor from which to apply defaults. |
| virtual int DataRequest::getRequestVersion | ( | const RasterDataDescriptor * | pDescriptor | ) | const [pure virtual] |
Get the version required to support this request.
| pDescriptor | The descriptor to use to determine required version. |
| virtual InterleaveFormatType DataRequest::getInterleaveFormat | ( | ) | const [pure virtual] |
Get the requested interleave.
This defaults to the interleave of the associated RasterElement.
| virtual void DataRequest::setInterleaveFormat | ( | InterleaveFormatType | interleave | ) | [pure virtual] |
Set the requested interleave.
| interleave | The requested interleave. |
| virtual DimensionDescriptor DataRequest::getStartRow | ( | ) | const [pure virtual] |
Get the requested start row.
This defaults to the first row in the RasterElement.
| virtual DimensionDescriptor DataRequest::getStopRow | ( | ) | const [pure virtual] |
Get the requested stop row.
This defaults to the last row in the RasterElement.
| virtual unsigned int DataRequest::getConcurrentRows | ( | ) | const [pure virtual] |
Get the request concurrent rows.
This defaults to 1.
| virtual void DataRequest::setRows | ( | DimensionDescriptor | startRow, | |
| DimensionDescriptor | stopRow, | |||
| unsigned int | concurrentRows = 0 | |||
| ) | [pure virtual] |
Set the start, stop, and concurrent rows.
| startRow | The requested start row. This may be an invalid DimensionDescriptor to apply the default. | |
| stopRow | The requested stop row. This may be an invalid DimensionDescriptor to apply the default. | |
| concurrentRows | The requested number of concurrent rows. This may be 0 to apply the default. |
| virtual DimensionDescriptor DataRequest::getStartColumn | ( | ) | const [pure virtual] |
Get the requested start column.
This defaults to the first column in the RasterElement.
| virtual DimensionDescriptor DataRequest::getStopColumn | ( | ) | const [pure virtual] |
Get the requested stop column.
This defaults to the last column in the RasterElement.
| virtual unsigned int DataRequest::getConcurrentColumns | ( | ) | const [pure virtual] |
Get the request concurrent columns.
This defaults to the number of columns between start and stop.
| virtual void DataRequest::setColumns | ( | DimensionDescriptor | startColumn, | |
| DimensionDescriptor | stopColumn, | |||
| unsigned int | concurrentColumns = 0 | |||
| ) | [pure virtual] |
Set the start, stop, and concurrent column.
| startColumn | The requested start column. This may be an invalid DimensionDescriptor to apply the default. | |
| stopColumn | The requested stop column. This may be an invalid DimensionDescriptor to apply the default. | |
| concurrentColumns | The requested number of concurrent columns. This may be 0 to apply the default. |
| virtual DimensionDescriptor DataRequest::getStartBand | ( | ) | const [pure virtual] |
Get the requested start band.
This defaults to the first band in the RasterElement.
| virtual DimensionDescriptor DataRequest::getStopBand | ( | ) | const [pure virtual] |
Get the requested stop band.
This defaults to the last band in the RasterElement for BIP and BIL data, or the requested start band for BSQ data.
| virtual unsigned int DataRequest::getConcurrentBands | ( | ) | const [pure virtual] |
Get the request concurrent bands.
This defaults to the number of bands between the start and stop.
| virtual void DataRequest::setBands | ( | DimensionDescriptor | startBand, | |
| DimensionDescriptor | stopBand, | |||
| unsigned int | concurrentBands = 0 | |||
| ) | [pure virtual] |
Set the start, stop, and concurrent bands.
| startBand | The requested start band. This may be an invalid DimensionDescriptor to apply the default. | |
| stopBand | The requested stop band. This may be an invalid DimensionDescriptor to apply the default. | |
| concurrentBands | The requested number of concurrent bands. This may be 0 to apply the default. |
| virtual bool DataRequest::getWritable | ( | ) | const [pure virtual] |
Get whether the request is for writable data.
This defaults to false.
| virtual void DataRequest::setWritable | ( | bool | writable | ) | [pure virtual] |
Set whether the request is for writable data.
It is undefined what will happen if data is written from a DataAccessor requested with an unwritable DataRequest. Depending on the circumstances, it may apply the written data, ignore the written data, crash, or lead to other undesirable results. Always set the request to writable if you want to write to a RasterElement.
| writable | True if the request is for writable data, false otherwise. |