GDAL
Public Member Functions | Protected Member Functions | Friends | List of all members
GDALProxyPoolDataset Class Reference
Inheritance diagram for GDALProxyPoolDataset:
GDALProxyDataset GDALDataset GDALMajorObject

Public Member Functions

 GDALProxyPoolDataset (const char *pszSourceDatasetDescription, int nRasterXSize, int nRasterYSize, GDALAccess eAccess=GA_ReadOnly, int bShared=FALSE, const char *pszProjectionRef=NULL, double *padfGeoTransform=NULL)
 
void AddSrcBandDescription (GDALDataType eDataType, int nBlockXSize, int nBlockYSize)
 
virtual const char * GetProjectionRef (void)
 Fetch the projection definition string for this dataset. More...
 
virtual CPLErr SetProjection (const char *)
 Set the projection reference string for this dataset. More...
 
virtual CPLErr GetGeoTransform (double *)
 Fetch the affine transformation coefficients. More...
 
virtual CPLErr SetGeoTransform (double *)
 Set the affine transformation coefficients. More...
 
virtual char ** GetMetadata (const char *pszDomain)
 Fetch metadata. More...
 
virtual const char * GetMetadataItem (const char *pszName, const char *pszDomain)
 Fetch single metadata item. More...
 
virtual void * GetInternalHandle (const char *pszRequest)
 Fetch a format specific internally meaningful handle. More...
 
virtual const char * GetGCPProjection ()
 Get output projection for GCPs. More...
 
virtual const GDAL_GCPGetGCPs ()
 Fetch GCPs. More...
 
- Public Member Functions inherited from GDALProxyDataset
virtual char ** GetMetadataDomainList ()
 Fetch list of metadata domains. More...
 
virtual CPLErr SetMetadata (char **papszMetadata, const char *pszDomain)
 Set metadata. More...
 
virtual CPLErr SetMetadataItem (const char *pszName, const char *pszValue, const char *pszDomain)
 Set single metadata item. More...
 
virtual void FlushCache (void)
 Flush all write cached data to disk. More...
 
virtual GDALDriverGetDriver (void)
 Fetch the driver to which this dataset relates. More...
 
virtual char ** GetFileList (void)
 Fetch files forming dataset. More...
 
virtual int GetGCPCount ()
 Get number of GCPs. More...
 
virtual CPLErr SetGCPs (int nGCPCount, const GDAL_GCP *pasGCPList, const char *pszGCPProjection)
 Assign GCPs. More...
 
virtual CPLErr AdviseRead (int nXOff, int nYOff, int nXSize, int nYSize, int nBufXSize, int nBufYSize, GDALDataType eDT, int nBandCount, int *panBandList, char **papszOptions)
 Advise driver of upcoming read requests. More...
 
virtual CPLErr CreateMaskBand (int nFlags)
 Adds a mask band to the dataset. More...
 
- Public Member Functions inherited from GDALDataset
virtual ~GDALDataset ()
 Destroy an open GDALDataset. More...
 
int GetRasterXSize (void)
 Fetch raster width in pixels. More...
 
int GetRasterYSize (void)
 Fetch raster height in pixels. More...
 
int GetRasterCount (void)
 Fetch the number of raster bands on this dataset. More...
 
GDALRasterBandGetRasterBand (int)
 Fetch a band object for a dataset. More...
 
virtual CPLErr AddBand (GDALDataType eType, char **papszOptions=NULL)
 Add a band to a dataset. More...
 
virtual GDALAsyncReaderBeginAsyncReader (int nXOff, int nYOff, int nXSize, int nYSize, void *pBuf, int nBufXSize, int nBufYSize, GDALDataType eBufType, int nBandCount, int *panBandMap, int nPixelSpace, int nLineSpace, int nBandSpace, char **papszOptions)
 Sets up an asynchronous data request. More...
 
virtual void EndAsyncReader (GDALAsyncReader *)
 End asynchronous request. More...
 
CPLErr RasterIO (GDALRWFlag, int, int, int, int, void *, int, int, GDALDataType, int, int *, int, int, int)
 Read/write a region of image data from multiple bands. More...
 
int Reference ()
 Add one to dataset reference count. More...
 
int Dereference ()
 Subtract one from dataset reference count. More...
 
GDALAccess GetAccess ()
 
int GetShared ()
 Returns shared flag. More...
 
void MarkAsShared ()
 Mark this dataset as available for sharing.
 
CPLErr BuildOverviews (const char *, int, int *, int, int *, GDALProgressFunc, void *)
 Build raster overview(s) More...
 
void ReportError (CPLErr eErrClass, int err_no, const char *fmt,...) CPL_PRINT_FUNC_FORMAT(4
 Emits an error related to a dataset. More...
 
- Public Member Functions inherited from GDALMajorObject
int GetMOFlags ()
 
void SetMOFlags (int nFlags)
 
virtual const char * GetDescription () const
 Fetch object description. More...
 
virtual void SetDescription (const char *)
 Set object description. More...
 

Protected Member Functions

virtual GDALDatasetRefUnderlyingDataset ()
 
virtual void UnrefUnderlyingDataset (GDALDataset *poUnderlyingDataset)
 
- Protected Member Functions inherited from GDALProxyDataset
virtual CPLErr IBuildOverviews (const char *, int, int *, int, int *, GDALProgressFunc, void *)
 
virtual CPLErr IRasterIO (GDALRWFlag, int, int, int, int, void *, int, int, GDALDataType, int, int *, int, int, int)
 
- Protected Member Functions inherited from GDALDataset
void RasterInitialize (int, int)
 
void SetBand (int, GDALRasterBand *)
 
CPLErr BlockBasedRasterIO (GDALRWFlag, int, int, int, int, void *, int, int, GDALDataType, int, int *, int, int, int)
 
void BlockBasedFlushCache ()
 
CPLErr ValidateRasterIOOrAdviseReadParameters (const char *pszCallingFunc, int *pbStopProcessingOnCENone, int nXOff, int nYOff, int nXSize, int nYSize, int nBufXSize, int nBufYSize, int nBandCount, int *panBandMap)
 
virtual int CloseDependentDatasets ()
 Drop references to any other datasets referenced by this dataset. More...
 
- Protected Member Functions inherited from GDALMajorObject
char ** BuildMetadataDomainList (char **papszList, int bCheckNonEmpty,...) CPL_NULL_TERMINATED
 Helper function for custom implementations of GetMetadataDomainList() More...
 

Friends

class GDALProxyPoolRasterBand
 

Additional Inherited Members

- Static Public Member Functions inherited from GDALDataset
static GDALDataset ** GetOpenDatasets (int *pnDatasetCount)
 Fetch all open GDAL dataset handles. More...
 
- Protected Attributes inherited from GDALDataset
GDALDriverpoDriver
 
GDALAccess eAccess
 
int nRasterXSize
 
int nRasterYSize
 
int nBands
 
GDALRasterBand ** papoBands
 
int bForceCachedIO
 
int nRefCount
 
int bShared
 
GDALDefaultOverviews oOvManager
 
- Protected Attributes inherited from GDALMajorObject
int nFlags
 
CPLString sDescription
 
GDALMultiDomainMetadata oMDMD
 

Member Function Documentation

const char * GDALProxyPoolDataset::GetGCPProjection ( )
virtual

Get output projection for GCPs.

This method is the same as the C function GDALGetGCPProjection().

The projection string follows the normal rules from GetProjectionRef().

Returns
internal projection string or "" if there are no GCPs. It should not be altered, freed or expected to last for long.

Reimplemented from GDALProxyDataset.

const GDAL_GCP * GDALProxyPoolDataset::GetGCPs ( )
virtual

Fetch GCPs.

This method is the same as the C function GDALGetGCPs().

Returns
pointer to internal GCP structure list. It should not be modified, and may change on the next GDAL call.

Reimplemented from GDALProxyDataset.

CPLErr GDALProxyPoolDataset::GetGeoTransform ( double *  padfTransform)
virtual

Fetch the affine transformation coefficients.

Fetches the coefficients for transforming between pixel/line (P,L) raster space, and projection coordinates (Xp,Yp) space.

Xp = padfTransform[0] + P*padfTransform[1] + L*padfTransform[2];
Yp = padfTransform[3] + P*padfTransform[4] + L*padfTransform[5];

In a north up image, padfTransform[1] is the pixel width, and padfTransform[5] is the pixel height. The upper left corner of the upper left pixel is at position (padfTransform[0],padfTransform[3]).

The default transform is (0,1,0,0,0,1) and should be returned even when a CE_Failure error is returned, such as for formats that don't support transformation to projection coordinates.

This method does the same thing as the C GDALGetGeoTransform() function.

Parameters
padfTransforman existing six double buffer into which the transformation will be placed.
Returns
CE_None on success, or CE_Failure if no transform can be fetched.

Reimplemented from GDALProxyDataset.

void * GDALProxyPoolDataset::GetInternalHandle ( const char *  )
virtual

Fetch a format specific internally meaningful handle.

This method is the same as the C GDALGetInternalHandle() method.

Parameters
pszHandleNamethe handle name desired. The meaningful names will be specific to the file format.
Returns
the desired handle value, or NULL if not recognised/supported.

Reimplemented from GDALProxyDataset.

char ** GDALProxyPoolDataset::GetMetadata ( const char *  pszDomain)
virtual

Fetch metadata.

The returned string list is owned by the object, and may change at any time. It is formated as a "Name=value" list with the last pointer value being NULL. Use the the CPL StringList functions such as CSLFetchNameValue() to manipulate it.

Note that relatively few formats return any metadata at this time.

This method does the same thing as the C function GDALGetMetadata().

Parameters
pszDomainthe domain of interest. Use "" or NULL for the default domain.
Returns
NULL or a string list.

Reimplemented from GDALProxyDataset.

const char * GDALProxyPoolDataset::GetMetadataItem ( const char *  pszName,
const char *  pszDomain 
)
virtual

Fetch single metadata item.

The C function GDALGetMetadataItem() does the same thing as this method.

Parameters
pszNamethe key for the metadata item to fetch.
pszDomainthe domain to fetch for, use NULL for the default domain.
Returns
NULL on failure to find the key, or a pointer to an internal copy of the value string on success.

Reimplemented from GDALProxyDataset.

const char * GDALProxyPoolDataset::GetProjectionRef ( void  )
virtual

Fetch the projection definition string for this dataset.

Same as the C function GDALGetProjectionRef().

The returned string defines the projection coordinate system of the image in OpenGIS WKT format. It should be suitable for use with the OGRSpatialReference class.

When a projection definition is not available an empty (but not NULL) string is returned.

Returns
a pointer to an internal projection reference string. It should not be altered, freed or expected to last for long.
See also
http://www.gdal.org/ogr/osr_tutorial.html

Reimplemented from GDALProxyDataset.

CPLErr GDALProxyPoolDataset::SetGeoTransform ( double *  )
virtual

Set the affine transformation coefficients.

See GetGeoTransform() for details on the meaning of the padfTransform coefficients.

This method does the same thing as the C GDALSetGeoTransform() function.

Parameters
padfTransforma six double buffer containing the transformation coefficients to be written with the dataset.
Returns
CE_None on success, or CE_Failure if this transform cannot be written.

Reimplemented from GDALProxyDataset.

CPLErr GDALProxyPoolDataset::SetProjection ( const char *  )
virtual

Set the projection reference string for this dataset.

The string should be in OGC WKT or PROJ.4 format. An error may occur because of incorrectly specified projection strings, because the dataset is not writable, or because the dataset does not support the indicated projection. Many formats do not support writing projections.

This method is the same as the C GDALSetProjection() function.

Parameters
pszProjectionprojection reference string.
Returns
CE_Failure if an error occurs, otherwise CE_None.

Reimplemented from GDALProxyDataset.


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

Generated for GDAL by doxygen 1.8.11.