<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta name="robots" content="noindex">
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>GDALDriver Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body bgcolor="#ffffff">
<!-- Generated by Doxygen 1.2.3-20001105 on Thu Mar 28 09:47:32 2002 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
<hr><h1>GDALDriver Class Reference</h1><code>#include <<a class="el" href="gdal_priv_h-source.html">gdal_priv.h</a>></code>
<p>
<p>Inheritance diagram for GDALDriver:
<p><center><img src="class_GDALDriver.gif" usemap="#GDALDriver_map" border="0"></center>
<map name="GDALDriver_map">
</map>
<a href="class_GDALDriver-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="a0" doxytag="GDALDriver::GDALDriver"></a>
</td><td valign=bottom><b>GDALDriver</b> ()</td></tr>
<tr><td nowrap align=right valign=top><a name="a1" doxytag="GDALDriver::~GDALDriver"></a>
</td><td valign=bottom><b>~GDALDriver</b> ()</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="class_GDALDataset.html">GDALDataset</a>* </td><td valign=bottom><a class="el" href="class_GDALDriver.html#a2">Create</a> ( const char * pszName, int nXSize, int nYSize, int nBands, <a class="el" href="gdal_h.html#a141">GDALDataType</a> eType, char ** papszOptions )</td></tr>
<tr><td nowrap align=right valign=top>CPLErr </td><td valign=bottom><a class="el" href="class_GDALDriver.html#a3">Delete</a> ( const char * pszName )</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="class_GDALDataset.html">GDALDataset</a>* </td><td valign=bottom><a class="el" href="class_GDALDriver.html#a4">CreateCopy</a> ( const char *, <a class="el" href="class_GDALDataset.html">GDALDataset</a> *, int, char **, <a class="el" href="gdal_h.html#a10">GDALProgressFunc</a> pfnProgress, void * pProgressData )</td></tr>
<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top>char* </td><td valign=bottom><a class="el" href="class_GDALDriver.html#m0">pszShortName</a></td></tr>
<tr><td nowrap align=right valign=top>char* </td><td valign=bottom><a class="el" href="class_GDALDriver.html#m1">pszLongName</a></td></tr>
<tr><td nowrap align=right valign=top>char* </td><td valign=bottom><a class="el" href="class_GDALDriver.html#m2">pszHelpTopic</a></td></tr>
<tr><td nowrap align=right valign=top><a name="m3" doxytag="GDALDriver::pfnOpen"></a>
<a class="el" href="class_GDALDataset.html">GDALDataset</a>* (* </td><td valign=bottom><b>pfnOpen</b> )( GDALOpenInfo * )</td></tr>
<tr><td nowrap align=right valign=top><a name="m4" doxytag="GDALDriver::pfnCreate"></a>
<a class="el" href="class_GDALDataset.html">GDALDataset</a>* (* </td><td valign=bottom><b>pfnCreate</b> )( const char * pszName, int nXSize, int nYSize, int nBands, <a class="el" href="gdal_h.html#a141">GDALDataType</a> eType, char ** papszOptions )</td></tr>
<tr><td nowrap align=right valign=top><a name="m5" doxytag="GDALDriver::pfnDelete"></a>
CPLErr (* </td><td valign=bottom><b>pfnDelete</b> )( const char * pszName )</td></tr>
<tr><td nowrap align=right valign=top><a name="m6" doxytag="GDALDriver::pfnCreateCopy"></a>
<a class="el" href="class_GDALDataset.html">GDALDataset</a>* (* </td><td valign=bottom><b>pfnCreateCopy</b> )( const char *, <a class="el" href="class_GDALDataset.html">GDALDataset</a> *, int, char **, <a class="el" href="gdal_h.html#a10">GDALProgressFunc</a> pfnProgress, void * pProgressData )</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An instance of this class is created for each supported format, and manages information about the format.
<p>
This roughly corresponds to a file format, though some drivers may be gateways to many formats through a secondary multi-library.
<p>
<hr><h2>Member Function Documentation</h2>
<a name="a2" doxytag="GDALDriver::Create"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="class_GDALDataset.html">GDALDataset</a> * GDALDriver::Create (
</b></td>
<td valign="bottom"><b>
const char * <em>pszFilename</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
int <em>nXSize</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
int <em>nYSize</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
int <em>nBands</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="gdal_h.html#a141">GDALDataType</a> <em>eType</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
char ** <em>papszParmList</em> )
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Create a new dataset with this driver.
<p>
What argument values are legal for particular drivers is driver specific, and there is no way to query in advance to establish legal values.
<p>
Equivelent of the C function <a class="el" href="gdal_h.html">GDALCreate</a>().<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>pszFilename</em>
</td><td>
the name of the dataset to create. </td></tr>
<tr><td valign=top><em>nXSize</em>
</td><td>
width of created raster in pixels. </td></tr>
<tr><td valign=top><em>nYSize</em>
</td><td>
height of created raster in pixels. </td></tr>
<tr><td valign=top><em>nBands</em>
</td><td>
number of bands. </td></tr>
<tr><td valign=top><em>eType</em>
</td><td>
type of raster. </td></tr>
<tr><td valign=top><em>papszParmList</em>
</td><td>
list of driver specific control parameters.
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
NULL on failure, or a new <a class="el" href="class_GDALDataset.html">GDALDataset</a>. </dl> </td>
</tr>
</table>
<a name="a4" doxytag="GDALDriver::CreateCopy"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="class_GDALDataset.html">GDALDataset</a> * GDALDriver::CreateCopy (
</b></td>
<td valign="bottom"><b>
const char * <em>pszFilename</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="class_GDALDataset.html">GDALDataset</a> * <em>poSrcDS</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
int <em>bStrict</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
char ** <em>papszOptions</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="gdal_h.html#a10">GDALProgressFunc</a> <em>pfnProgress</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
void * <em>pProgressData</em> )
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Create a copy of a dataset.
<p>
This method will attempt to create a copy of a raster dataset with the indicated filename, and in this drivers format. Band number, size, type, projection, geotransform and so forth are all to be copied from the provided template dataset.
<p>
Note that many sequential write once formats (such as JPEG and PNG) don't implement the <a class="el" href="class_GDALDriver.html#a2">Create</a>() method but do implement this <a class="el" href="class_GDALDriver.html#a4">CreateCopy</a>() method. If the driver doesn't implement <a class="el" href="class_GDALDriver.html#a4">CreateCopy</a>(), but does implement <a class="el" href="class_GDALDriver.html#a2">Create</a>() then the default <a class="el" href="class_GDALDriver.html#a4">CreateCopy</a>() mechanism built on calling <a class="el" href="class_GDALDriver.html#a2">Create</a>() will be used.
<p>
It is intended that <a class="el" href="class_GDALDriver.html#a4">CreateCopy</a>() would often be used with a source dataset which is a virtual dataset allowing configuration of band types, and other information without actually duplicating raster data. This virtual dataset format hasn't yet been implemented at the time of this documentation being written.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>pszFilename</em>
</td><td>
the name for the new dataset. </td></tr>
<tr><td valign=top><em>poSrcDS</em>
</td><td>
the dataset being duplicated. </td></tr>
<tr><td valign=top><em>bStrict</em>
</td><td>
TRUE if the copy must be strictly equivelent, or more normally FALSE indicating that the copy may adapt as needed for the output format. </td></tr>
<tr><td valign=top><em>papszOptions</em>
</td><td>
additional format dependent options controlling creation of the output file. </td></tr>
<tr><td valign=top><em>pfnProgress</em>
</td><td>
a function to be used to report progress of the copy. </td></tr>
<tr><td valign=top><em>pProgressData</em>
</td><td>
application data passed into progress function.
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
a pointer to the newly created dataset (may be read-only access). </dl> </td>
</tr>
</table>
<a name="a3" doxytag="GDALDriver::Delete"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
CPLErr GDALDriver::Delete (
</b></td>
<td valign="bottom"><b>
const char * <em>pszFilename</em> )
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Delete named dataset.
<p>
The driver will attempt to delete the named dataset in a driver specific fashion. Full featured drivers will delete all associated files, database objects, or whatever is appropriate. The default behaviour when no driver specific behaviour is provided is to attempt to delete the passed name as a single file.
<p>
It is unwise to have open dataset handles on this dataset when it is deleted.
<p>
Equivelent of the C function <a class="el" href="gdal_h.html">GDALDeleteDataset</a>().<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>pszFilename</em>
</td><td>
name of dataset to delete.
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
CE_None on success, or CE_Failure if the operation fails. </dl> </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="m2" doxytag="GDALDriver::pszHelpTopic"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
char * GDALDriver::pszHelpTopic
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Help mechanism yet to be defined. </td>
</tr>
</table>
<a name="m1" doxytag="GDALDriver::pszLongName"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
char * GDALDriver::pszLongName
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Long format name </td>
</tr>
</table>
<a name="m0" doxytag="GDALDriver::pszShortName"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
char * GDALDriver::pszShortName
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Short (symbolic) format name. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="gdal_priv_h-source.html">gdal_priv.h</a><li><a class="el" href="gdaldriver_cpp-source.html">gdaldriver.cpp</a></ul>
<hr><address><small>Generated at Thu Mar 28 09:47:32 2002 for GDAL by
<a href="http://www.stack.nl/~dimitri/doxygen/index.html">
<img src="doxygen.gif" alt="doxygen" align="middle" border=0
width=110 height=53></a>1.2.3-20001105 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
© 1997-2000</small></address>
</body>
</html>
