<!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>GDALDriverManager 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>GDALDriverManager Class Reference</h1><code>#include <<a class="el" href="gdal_priv_h-source.html">gdal_priv.h</a>></code>
<p>
<p>Inheritance diagram for GDALDriverManager:
<p><center><img src="class_GDALDriverManager.gif" usemap="#GDALDriverManager_map" border="0"></center>
<map name="GDALDriverManager_map">
</map>
<a href="class_GDALDriverManager-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="GDALDriverManager::GDALDriverManager"></a>
</td><td valign=bottom><b>GDALDriverManager</b> ()</td></tr>
<tr><td nowrap align=right valign=top><a name="a1" doxytag="GDALDriverManager::~GDALDriverManager"></a>
</td><td valign=bottom><b>~GDALDriverManager</b> ()</td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="class_GDALDriverManager.html#a2">GetDriverCount</a> ( void )</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="class_GDALDriver.html">GDALDriver</a>* </td><td valign=bottom><a class="el" href="class_GDALDriverManager.html#a3">GetDriver</a> ( int )</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="class_GDALDriver.html">GDALDriver</a>* </td><td valign=bottom><a class="el" href="class_GDALDriverManager.html#a4">GetDriverByName</a> ( const char * )</td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="class_GDALDriverManager.html#a5">RegisterDriver</a> ( <a class="el" href="class_GDALDriver.html">GDALDriver</a> * )</td></tr>
<tr><td nowrap align=right valign=top><a name="a6" doxytag="GDALDriverManager::MoveDriver"></a>
void </td><td valign=bottom><b>MoveDriver</b> ( <a class="el" href="class_GDALDriver.html">GDALDriver</a> *, int )</td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="class_GDALDriverManager.html#a7">DeregisterDriver</a> ( <a class="el" href="class_GDALDriver.html">GDALDriver</a> * )</td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="class_GDALDriverManager.html#a8">AutoLoadDrivers</a> ()</td></tr>
<tr><td nowrap align=right valign=top><a name="a9" doxytag="GDALDriverManager::GetHome"></a>
const char* </td><td valign=bottom><b>GetHome</b> ()</td></tr>
<tr><td nowrap align=right valign=top><a name="a10" doxytag="GDALDriverManager::SetHome"></a>
void </td><td valign=bottom><b>SetHome</b> ( const char * )</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Class for managing the registration of file format drivers.
<p>
Use GetGDALDriverManager() to fetch the global singleton instance of this class.
<p>
<hr><h2>Member Function Documentation</h2>
<a name="a8" doxytag="GDALDriverManager::AutoLoadDrivers"></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>
void GDALDriverManager::AutoLoadDrivers (
</b></td>
<td valign="bottom"><b>
)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Auto-load GDAL drivers from shared libraries.
<p>
This function will automatically load drivers from shared libraries. It searches the "driver path" for .so (or .dll) files that start with the prefix "gdal_X.so". It then tries to load them and then tries to call a function within them called GDALRegister_X() where the 'X' is the same as the remainder of the shared library basename, or failing that to call GDALRegisterMe().
<p>
There are a few rules for the driver path. If the GDAL_DRIVER_PATH environment variable it set, it is taken to be a list of directories to search separated by colons on unix, or semi-colons on Windows. Otherwise the /usr/local/lib directory, and (if known) the lib subdirectory of the gdal home directory are searched. </td>
</tr>
</table>
<a name="a7" doxytag="GDALDriverManager::DeregisterDriver"></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>
void GDALDriverManager::DeregisterDriver (
</b></td>
<td valign="bottom"><b>
<a class="el" href="class_GDALDriver.html">GDALDriver</a> * <em>poDriver</em> )
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Deregister the passed driver.
<p>
If the driver isn't found no change is made.
<p>
The C analog is <a class="el" href="gdal_h.html">GDALDeregisterDriver</a>().<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>poDriver</em>
</td><td>
the driver to deregister. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a3" doxytag="GDALDriverManager::GetDriver"></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_GDALDriver.html">GDALDriver</a> * GDALDriverManager::GetDriver (
</b></td>
<td valign="bottom"><b>
int <em>iDriver</em> )
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Fetch driver by index.
<p>
This C analog to this is <a class="el" href="gdal_h.html">GDALGetDriver</a>().<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>iDriver</em>
</td><td>
the driver index from 0 to <a class="el" href="class_GDALDriverManager.html#a2">GetDriverCount</a>()-1.
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
the number of registered drivers. </dl> </td>
</tr>
</table>
<a name="a4" doxytag="GDALDriverManager::GetDriverByName"></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_GDALDriver.html">GDALDriver</a> * GDALDriverManager::GetDriverByName (
</b></td>
<td valign="bottom"><b>
const char * <em>pszName</em> )
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Fetch a driver based on the short name.
<p>
The C analog is the <a class="el" href="gdal_h.html">GDALGetDriverByName</a>() function.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>pszName</em>
</td><td>
the short name, such as GTiff, being searched for.
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
the identified driver, or NULL if no match is found. </dl> </td>
</tr>
</table>
<a name="a2" doxytag="GDALDriverManager::GetDriverCount"></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>
int GDALDriverManager::GetDriverCount (
</b></td>
<td valign="bottom"><b>
void )
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Fetch the number of registered drivers.
<p>
This C analog to this is <a class="el" href="gdal_h.html">GDALGetDriverCount</a>().
<p>
<dl compact><dt>
<b>Returns: </b><dd>
the number of registered drivers. </dl> </td>
</tr>
</table>
<a name="a5" doxytag="GDALDriverManager::RegisterDriver"></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>
int GDALDriverManager::RegisterDriver (
</b></td>
<td valign="bottom"><b>
<a class="el" href="class_GDALDriver.html">GDALDriver</a> * <em>poDriver</em> )
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Register a driver for use.
<p>
The C analog is <a class="el" href="gdal_h.html">GDALRegisterDriver</a>().
<p>
Normally this method is used by format specific C callable registration entry points such as GDALRegister_GTiff() rather than being called directly by application level code.
<p>
If this driver (based on the object pointer, not short name) is already registered, then no change is made, and the index of the existing driver is returned. Otherwise the driver list is extended, and the new driver is added at the end.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>poDriver</em>
</td><td>
the driver to register.
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
the index of the new installed driver. </dl> </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="gdaldrivermanager_cpp-source.html">gdaldrivermanager.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>
