VRTSourcedRasterBand Class Reference

Inheritance diagram for VRTSourcedRasterBand:

List of all members.

Public Member Functions
	VRTSourcedRasterBand (GDALDataset *poDS, int nBand)
	VRTSourcedRasterBand (GDALDataType eType, int nXSize, int nYSize)
	VRTSourcedRasterBand (GDALDataset *poDS, int nBand, GDALDataType eType, int nXSize, int nYSize)
virtual CPLErr	IRasterIO (GDALRWFlag, int, int, int, int, void *, int, int, GDALDataType, int, int)
virtual char **	GetMetadata (const char *pszDomain="")
virtual CPLErr	SetMetadata (char **papszMetadata, const char *pszDomain="")
virtual CPLErr	SetMetadataItem (const char *pszName, const char *pszValue, const char *pszDomain="")
virtual CPLErr	XMLInit (CPLXMLNode *, const char *)
virtual CPLXMLNode *	SerializeToXML (const char *pszVRTPath)
CPLErr	AddSource (VRTSource *)
CPLErr	AddSimpleSource (GDALRasterBand *poSrcBand, int nSrcXOff=-1, int nSrcYOff=-1, int nSrcXSize=-1, int nSrcYSize=-1, int nDstXOff=-1, int nDstYOff=-1, int nDstXSize=-1, int nDstYSize=-1, const char *pszResampling="near", double dfNoDataValue=VRT_NODATA_UNSET)
CPLErr	AddComplexSource (GDALRasterBand *poSrcBand, int nSrcXOff=-1, int nSrcYOff=-1, int nSrcXSize=-1, int nSrcYSize=-1, int nDstXOff=-1, int nDstYOff=-1, int nDstXSize=-1, int nDstYSize=-1, double dfScaleOff=0.0, double dfScaleRatio=1.0, double dfNoDataValue=VRT_NODATA_UNSET, int nColorTableComponent=0)
CPLErr	AddFuncSource (VRTImageReadFunc pfnReadFunc, void *hCBData, double dfNoDataValue=VRT_NODATA_UNSET)
virtual CPLErr	IReadBlock (int, int, void *)
Public Attributes
int	nSources
VRTSource **	papoSources
int	bEqualAreas

---

Member Function Documentation

char ** VRTSourcedRasterBand::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:

pszDomain

the domain of interest. Use "" or NULL for the default domain.

Returns:

NULL or a string list.

Reimplemented from GDALMajorObject.

CPLErr VRTSourcedRasterBand::SetMetadata	(	char **	papszMetadataIn,
		const char *	pszDomain = ""
	)			[virtual]

Set metadata.

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

Parameters:

	papszMetadata	the metadata in name=value string list format to apply.
	pszDomain	the domain of interest. Use "" or NULL for the default domain.

Returns:

CE_None on success, CE_Failure on failure and CE_Warning if the metadata has been accepted, but is likely not maintained persistently by the underlying object between sessions.

Reimplemented from VRTRasterBand.

References GDALGetDriverByName().

CPLErr VRTSourcedRasterBand::SetMetadataItem	(	const char *	pszName,
		const char *	pszValue,
		const char *	pszDomain = ""
	)			[virtual]

Set single metadata item.

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

Parameters:

	pszName	the key for the metadata item to fetch.
	pszValue	the value to assign to the key.
	pszDomain	the domain to set within, use NULL for the default domain.

Returns:

CE_None on success, or an error code on failure.

Reimplemented from VRTRasterBand.

References GDALGetDriverByName().

---

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

• vrtdataset.h
• vrtsourcedrasterband.cpp