EVOLUTION-MANAGER
Edit File: classOGRLayer.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.5"/> <title>My Project: OGRLayer Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">My Project </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.5 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Pages</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pro-methods">Protected Member Functions</a> | <a href="#pro-attribs">Protected Attributes</a> | <a href="classOGRLayer-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">OGRLayer Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> </div><!--header--> <div class="contents"> <p><code>#include <<a class="el" href="ogrsf__frmts_8h_source.html">ogrsf_frmts.h</a>></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:adc3735e444204d46f517eec251712f4d"><td class="memItemLeft" align="right" valign="top">virtual OGRGeometry * </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRLayer.html#adc3735e444204d46f517eec251712f4d">GetSpatialFilter</a> ()</td></tr> <tr class="memdesc:adc3735e444204d46f517eec251712f4d"><td class="mdescLeft"> </td><td class="mdescRight">This method returns the current spatial filter for this layer. <a href="#adc3735e444204d46f517eec251712f4d">More...</a><br/></td></tr> <tr class="separator:adc3735e444204d46f517eec251712f4d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0b4ab45cf97cbc470f0d60474d3e4169"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRLayer.html#a0b4ab45cf97cbc470f0d60474d3e4169">SetSpatialFilter</a> (OGRGeometry *)</td></tr> <tr class="memdesc:a0b4ab45cf97cbc470f0d60474d3e4169"><td class="mdescLeft"> </td><td class="mdescRight">Set a new spatial filter. <a href="#a0b4ab45cf97cbc470f0d60474d3e4169">More...</a><br/></td></tr> <tr class="separator:a0b4ab45cf97cbc470f0d60474d3e4169"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:acd16bcdb3e8f720003fb24cd68f25460"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRLayer.html#acd16bcdb3e8f720003fb24cd68f25460">SetSpatialFilterRect</a> (double dfMinX, double dfMinY, double dfMaxX, double dfMaxY)</td></tr> <tr class="memdesc:acd16bcdb3e8f720003fb24cd68f25460"><td class="mdescLeft"> </td><td class="mdescRight">Set a new rectangular spatial filter. <a href="#acd16bcdb3e8f720003fb24cd68f25460">More...</a><br/></td></tr> <tr class="separator:acd16bcdb3e8f720003fb24cd68f25460"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aebac60fb86ee178be016655532070ee3"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRLayer.html#aebac60fb86ee178be016655532070ee3">SetSpatialFilter</a> (int iGeomField, OGRGeometry *)</td></tr> <tr class="memdesc:aebac60fb86ee178be016655532070ee3"><td class="mdescLeft"> </td><td class="mdescRight">Set a new spatial filter. <a href="#aebac60fb86ee178be016655532070ee3">More...</a><br/></td></tr> <tr class="separator:aebac60fb86ee178be016655532070ee3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5cd4ceb8f4ec20594be63280c8e4498a"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRLayer.html#a5cd4ceb8f4ec20594be63280c8e4498a">SetSpatialFilterRect</a> (int iGeomField, double dfMinX, double dfMinY, double dfMaxX, double dfMaxY)</td></tr> <tr class="memdesc:a5cd4ceb8f4ec20594be63280c8e4498a"><td class="mdescLeft"> </td><td class="mdescRight">Set a new rectangular spatial filter. <a href="#a5cd4ceb8f4ec20594be63280c8e4498a">More...</a><br/></td></tr> <tr class="separator:a5cd4ceb8f4ec20594be63280c8e4498a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9ff2038ec26d2c3d1140178dc51b0a48"><td class="memItemLeft" align="right" valign="top">virtual OGRErr </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRLayer.html#a9ff2038ec26d2c3d1140178dc51b0a48">SetAttributeFilter</a> (const char *)</td></tr> <tr class="memdesc:a9ff2038ec26d2c3d1140178dc51b0a48"><td class="mdescLeft"> </td><td class="mdescRight">Set a new attribute query. <a href="#a9ff2038ec26d2c3d1140178dc51b0a48">More...</a><br/></td></tr> <tr class="separator:a9ff2038ec26d2c3d1140178dc51b0a48"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aad0f2cd7f0587584b8f382c6a913583c"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRLayer.html#aad0f2cd7f0587584b8f382c6a913583c">ResetReading</a> ()=0</td></tr> <tr class="memdesc:aad0f2cd7f0587584b8f382c6a913583c"><td class="mdescLeft"> </td><td class="mdescRight">Reset feature reading to start on the first feature. <a href="#aad0f2cd7f0587584b8f382c6a913583c">More...</a><br/></td></tr> <tr class="separator:aad0f2cd7f0587584b8f382c6a913583c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a47d21ff33b32d14fa4e9885b9edecad6"><td class="memItemLeft" align="right" valign="top">virtual OGRFeature * </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRLayer.html#a47d21ff33b32d14fa4e9885b9edecad6">GetNextFeature</a> ()=0</td></tr> <tr class="memdesc:a47d21ff33b32d14fa4e9885b9edecad6"><td class="mdescLeft"> </td><td class="mdescRight">Fetch the next available feature from this layer. <a href="#a47d21ff33b32d14fa4e9885b9edecad6">More...</a><br/></td></tr> <tr class="separator:a47d21ff33b32d14fa4e9885b9edecad6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae3b6234d6077a18a19eddaf7e75ff5e1"><td class="memItemLeft" align="right" valign="top">virtual OGRErr </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRLayer.html#ae3b6234d6077a18a19eddaf7e75ff5e1">SetNextByIndex</a> (long nIndex)</td></tr> <tr class="memdesc:ae3b6234d6077a18a19eddaf7e75ff5e1"><td class="mdescLeft"> </td><td class="mdescRight">Move read cursor to the nIndex'th feature in the current resultset. <a href="#ae3b6234d6077a18a19eddaf7e75ff5e1">More...</a><br/></td></tr> <tr class="separator:ae3b6234d6077a18a19eddaf7e75ff5e1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:acb7625383f161e5a04aeea2173dce411"><td class="memItemLeft" align="right" valign="top">virtual OGRFeature * </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRLayer.html#acb7625383f161e5a04aeea2173dce411">GetFeature</a> (long nFID)</td></tr> <tr class="memdesc:acb7625383f161e5a04aeea2173dce411"><td class="mdescLeft"> </td><td class="mdescRight">Fetch a feature by its identifier. <a href="#acb7625383f161e5a04aeea2173dce411">More...</a><br/></td></tr> <tr class="separator:acb7625383f161e5a04aeea2173dce411"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a681139bfd585b74d7218e51a32144283"><td class="memItemLeft" align="right" valign="top">virtual OGRErr </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRLayer.html#a681139bfd585b74d7218e51a32144283">SetFeature</a> (OGRFeature *poFeature)</td></tr> <tr class="memdesc:a681139bfd585b74d7218e51a32144283"><td class="mdescLeft"> </td><td class="mdescRight">Rewrite an existing feature. <a href="#a681139bfd585b74d7218e51a32144283">More...</a><br/></td></tr> <tr class="separator:a681139bfd585b74d7218e51a32144283"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aaa1e32016f481596a55e1d988a15a067"><td class="memItemLeft" align="right" valign="top">virtual OGRErr </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRLayer.html#aaa1e32016f481596a55e1d988a15a067">CreateFeature</a> (OGRFeature *poFeature)</td></tr> <tr class="memdesc:aaa1e32016f481596a55e1d988a15a067"><td class="mdescLeft"> </td><td class="mdescRight">Create and write a new feature within a layer. <a href="#aaa1e32016f481596a55e1d988a15a067">More...</a><br/></td></tr> <tr class="separator:aaa1e32016f481596a55e1d988a15a067"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7e3d454d54a615a1b4359628bb6e7674"><td class="memItemLeft" align="right" valign="top">virtual OGRErr </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRLayer.html#a7e3d454d54a615a1b4359628bb6e7674">DeleteFeature</a> (long nFID)</td></tr> <tr class="memdesc:a7e3d454d54a615a1b4359628bb6e7674"><td class="mdescLeft"> </td><td class="mdescRight">Delete feature from layer. <a href="#a7e3d454d54a615a1b4359628bb6e7674">More...</a><br/></td></tr> <tr class="separator:a7e3d454d54a615a1b4359628bb6e7674"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a287f5ec7728cacc2f7d94882a9f1a22e"><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRLayer.html#a287f5ec7728cacc2f7d94882a9f1a22e">GetName</a> ()</td></tr> <tr class="memdesc:a287f5ec7728cacc2f7d94882a9f1a22e"><td class="mdescLeft"> </td><td class="mdescRight">Return the layer name. <a href="#a287f5ec7728cacc2f7d94882a9f1a22e">More...</a><br/></td></tr> <tr class="separator:a287f5ec7728cacc2f7d94882a9f1a22e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a818a25520ce08d5a681443348e930604"><td class="memItemLeft" align="right" valign="top">virtual OGRwkbGeometryType </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRLayer.html#a818a25520ce08d5a681443348e930604">GetGeomType</a> ()</td></tr> <tr class="memdesc:a818a25520ce08d5a681443348e930604"><td class="mdescLeft"> </td><td class="mdescRight">Return the layer geometry type. <a href="#a818a25520ce08d5a681443348e930604">More...</a><br/></td></tr> <tr class="separator:a818a25520ce08d5a681443348e930604"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a80473bcfd11341e70dd35bebe94026cf"><td class="memItemLeft" align="right" valign="top">virtual OGRFeatureDefn * </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRLayer.html#a80473bcfd11341e70dd35bebe94026cf">GetLayerDefn</a> ()=0</td></tr> <tr class="memdesc:a80473bcfd11341e70dd35bebe94026cf"><td class="mdescLeft"> </td><td class="mdescRight">Fetch the schema information for this layer. <a href="#a80473bcfd11341e70dd35bebe94026cf">More...</a><br/></td></tr> <tr class="separator:a80473bcfd11341e70dd35bebe94026cf"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aef41bcd7adad1ac5ddcef54d6b38713c"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRLayer.html#aef41bcd7adad1ac5ddcef54d6b38713c">FindFieldIndex</a> (const char *pszFieldName, int bExactMatch)</td></tr> <tr class="memdesc:aef41bcd7adad1ac5ddcef54d6b38713c"><td class="mdescLeft"> </td><td class="mdescRight">Find the index of field in the layer. <a href="#aef41bcd7adad1ac5ddcef54d6b38713c">More...</a><br/></td></tr> <tr class="separator:aef41bcd7adad1ac5ddcef54d6b38713c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a75c06b4993f8eb76b569f37365cd19ab"><td class="memItemLeft" align="right" valign="top">virtual OGRSpatialReference * </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRLayer.html#a75c06b4993f8eb76b569f37365cd19ab">GetSpatialRef</a> ()</td></tr> <tr class="memdesc:a75c06b4993f8eb76b569f37365cd19ab"><td class="mdescLeft"> </td><td class="mdescRight">Fetch the spatial reference system for this layer. <a href="#a75c06b4993f8eb76b569f37365cd19ab">More...</a><br/></td></tr> <tr class="separator:a75c06b4993f8eb76b569f37365cd19ab"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a74c796d4ce712e9a78df6042eeb8a91a"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRLayer.html#a74c796d4ce712e9a78df6042eeb8a91a">GetFeatureCount</a> (int bForce=TRUE)</td></tr> <tr class="memdesc:a74c796d4ce712e9a78df6042eeb8a91a"><td class="mdescLeft"> </td><td class="mdescRight">Fetch the feature count in this layer. <a href="#a74c796d4ce712e9a78df6042eeb8a91a">More...</a><br/></td></tr> <tr class="separator:a74c796d4ce712e9a78df6042eeb8a91a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a3be658ddb5b33d1ed95c31286774bbd2"><td class="memItemLeft" align="right" valign="top">virtual OGRErr </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRLayer.html#a3be658ddb5b33d1ed95c31286774bbd2">GetExtent</a> (OGREnvelope *psExtent, int bForce=TRUE)</td></tr> <tr class="memdesc:a3be658ddb5b33d1ed95c31286774bbd2"><td class="mdescLeft"> </td><td class="mdescRight">Fetch the extent of this layer. <a href="#a3be658ddb5b33d1ed95c31286774bbd2">More...</a><br/></td></tr> <tr class="separator:a3be658ddb5b33d1ed95c31286774bbd2"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a47a3cc550866eee1668bea2315f9df9c"><td class="memItemLeft" align="right" valign="top">virtual OGRErr </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRLayer.html#a47a3cc550866eee1668bea2315f9df9c">GetExtent</a> (int iGeomField, OGREnvelope *psExtent, int bForce=TRUE)</td></tr> <tr class="memdesc:a47a3cc550866eee1668bea2315f9df9c"><td class="mdescLeft"> </td><td class="mdescRight">Fetch the extent of this layer, on the specified geometry field. <a href="#a47a3cc550866eee1668bea2315f9df9c">More...</a><br/></td></tr> <tr class="separator:a47a3cc550866eee1668bea2315f9df9c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aeedbda1a62f9b89b8e5f24332cf22286"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRLayer.html#aeedbda1a62f9b89b8e5f24332cf22286">TestCapability</a> (const char *)=0</td></tr> <tr class="memdesc:aeedbda1a62f9b89b8e5f24332cf22286"><td class="mdescLeft"> </td><td class="mdescRight">Test if this layer supported the named capability. <a href="#aeedbda1a62f9b89b8e5f24332cf22286">More...</a><br/></td></tr> <tr class="separator:aeedbda1a62f9b89b8e5f24332cf22286"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a143b0d2c48bc0adf3a19d1f51e76b8ba"><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRLayer.html#a143b0d2c48bc0adf3a19d1f51e76b8ba">GetInfo</a> (const char *)</td></tr> <tr class="memdesc:a143b0d2c48bc0adf3a19d1f51e76b8ba"><td class="mdescLeft"> </td><td class="mdescRight">Fetch metadata from layer. <a href="#a143b0d2c48bc0adf3a19d1f51e76b8ba">More...</a><br/></td></tr> <tr class="separator:a143b0d2c48bc0adf3a19d1f51e76b8ba"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a00b1376a1eabb1298ef278f92f6d84be"><td class="memItemLeft" align="right" valign="top">virtual OGRErr </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRLayer.html#a00b1376a1eabb1298ef278f92f6d84be">CreateField</a> (OGRFieldDefn *poField, int bApproxOK=TRUE)</td></tr> <tr class="memdesc:a00b1376a1eabb1298ef278f92f6d84be"><td class="mdescLeft"> </td><td class="mdescRight">Create a new field on a layer. <a href="#a00b1376a1eabb1298ef278f92f6d84be">More...</a><br/></td></tr> <tr class="separator:a00b1376a1eabb1298ef278f92f6d84be"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aaebe7c671dca995549543eecf0f7a76a"><td class="memItemLeft" align="right" valign="top">virtual OGRErr </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRLayer.html#aaebe7c671dca995549543eecf0f7a76a">DeleteField</a> (int iField)</td></tr> <tr class="memdesc:aaebe7c671dca995549543eecf0f7a76a"><td class="mdescLeft"> </td><td class="mdescRight">Delete an existing field on a layer. <a href="#aaebe7c671dca995549543eecf0f7a76a">More...</a><br/></td></tr> <tr class="separator:aaebe7c671dca995549543eecf0f7a76a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aebd364a150d91f8d65d967646e0f92d3"><td class="memItemLeft" align="right" valign="top">virtual OGRErr </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRLayer.html#aebd364a150d91f8d65d967646e0f92d3">ReorderFields</a> (int *panMap)</td></tr> <tr class="memdesc:aebd364a150d91f8d65d967646e0f92d3"><td class="mdescLeft"> </td><td class="mdescRight">Reorder all the fields of a layer. <a href="#aebd364a150d91f8d65d967646e0f92d3">More...</a><br/></td></tr> <tr class="separator:aebd364a150d91f8d65d967646e0f92d3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a71e69a665e93001d48a4339695f33c1a"><td class="memItemLeft" align="right" valign="top">virtual OGRErr </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRLayer.html#a71e69a665e93001d48a4339695f33c1a">AlterFieldDefn</a> (int iField, OGRFieldDefn *poNewFieldDefn, int nFlags)</td></tr> <tr class="memdesc:a71e69a665e93001d48a4339695f33c1a"><td class="mdescLeft"> </td><td class="mdescRight">Alter the definition of an existing field on a layer. <a href="#a71e69a665e93001d48a4339695f33c1a">More...</a><br/></td></tr> <tr class="separator:a71e69a665e93001d48a4339695f33c1a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af3c68cad279ad80a476c6fb307cf5e48"><td class="memItemLeft" align="right" valign="top">virtual OGRErr </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRLayer.html#af3c68cad279ad80a476c6fb307cf5e48">CreateGeomField</a> (OGRGeomFieldDefn *poField, int bApproxOK=TRUE)</td></tr> <tr class="memdesc:af3c68cad279ad80a476c6fb307cf5e48"><td class="mdescLeft"> </td><td class="mdescRight">Create a new geometry field on a layer. <a href="#af3c68cad279ad80a476c6fb307cf5e48">More...</a><br/></td></tr> <tr class="separator:af3c68cad279ad80a476c6fb307cf5e48"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aebb07284c734e485d8611b7c8599254f"><td class="memItemLeft" align="right" valign="top">virtual OGRErr </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRLayer.html#aebb07284c734e485d8611b7c8599254f">SyncToDisk</a> ()</td></tr> <tr class="memdesc:aebb07284c734e485d8611b7c8599254f"><td class="mdescLeft"> </td><td class="mdescRight">Flush pending changes to disk. <a href="#aebb07284c734e485d8611b7c8599254f">More...</a><br/></td></tr> <tr class="separator:aebb07284c734e485d8611b7c8599254f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a265ddcd701c1d29cb959aae97dda1af4"><td class="memItemLeft" align="right" valign="top">virtual OGRStyleTable * </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRLayer.html#a265ddcd701c1d29cb959aae97dda1af4">GetStyleTable</a> ()</td></tr> <tr class="memdesc:a265ddcd701c1d29cb959aae97dda1af4"><td class="mdescLeft"> </td><td class="mdescRight">Returns layer style table. <a href="#a265ddcd701c1d29cb959aae97dda1af4">More...</a><br/></td></tr> <tr class="separator:a265ddcd701c1d29cb959aae97dda1af4"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2687d4312c044bb3a20bd13974ba8905"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRLayer.html#a2687d4312c044bb3a20bd13974ba8905">SetStyleTableDirectly</a> (OGRStyleTable *poStyleTable)</td></tr> <tr class="memdesc:a2687d4312c044bb3a20bd13974ba8905"><td class="mdescLeft"> </td><td class="mdescRight">Set layer style table. <a href="#a2687d4312c044bb3a20bd13974ba8905">More...</a><br/></td></tr> <tr class="separator:a2687d4312c044bb3a20bd13974ba8905"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a33fa0802c0686fb0e6ca6337e11cd7d5"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRLayer.html#a33fa0802c0686fb0e6ca6337e11cd7d5">SetStyleTable</a> (OGRStyleTable *poStyleTable)</td></tr> <tr class="memdesc:a33fa0802c0686fb0e6ca6337e11cd7d5"><td class="mdescLeft"> </td><td class="mdescRight">Set layer style table. <a href="#a33fa0802c0686fb0e6ca6337e11cd7d5">More...</a><br/></td></tr> <tr class="separator:a33fa0802c0686fb0e6ca6337e11cd7d5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a163f9c35fc44cd4f57b2d900b3ac553c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a163f9c35fc44cd4f57b2d900b3ac553c"></a> virtual OGRErr </td><td class="memItemRight" valign="bottom"><b>StartTransaction</b> ()</td></tr> <tr class="separator:a163f9c35fc44cd4f57b2d900b3ac553c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a283749fe25f02540ae02c254baf14d19"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a283749fe25f02540ae02c254baf14d19"></a> virtual OGRErr </td><td class="memItemRight" valign="bottom"><b>CommitTransaction</b> ()</td></tr> <tr class="separator:a283749fe25f02540ae02c254baf14d19"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5e3005e043d4d8dac597aec33c94adab"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5e3005e043d4d8dac597aec33c94adab"></a> virtual OGRErr </td><td class="memItemRight" valign="bottom"><b>RollbackTransaction</b> ()</td></tr> <tr class="separator:a5e3005e043d4d8dac597aec33c94adab"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af0cb9a05310d7b17d9dfec9e83a18e61"><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRLayer.html#af0cb9a05310d7b17d9dfec9e83a18e61">GetFIDColumn</a> ()</td></tr> <tr class="memdesc:af0cb9a05310d7b17d9dfec9e83a18e61"><td class="mdescLeft"> </td><td class="mdescRight">This method returns the name of the underlying database column being used as the FID column, or "" if not supported. <a href="#af0cb9a05310d7b17d9dfec9e83a18e61">More...</a><br/></td></tr> <tr class="separator:af0cb9a05310d7b17d9dfec9e83a18e61"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af68036c23622c954ce3a91861f22b724"><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRLayer.html#af68036c23622c954ce3a91861f22b724">GetGeometryColumn</a> ()</td></tr> <tr class="memdesc:af68036c23622c954ce3a91861f22b724"><td class="mdescLeft"> </td><td class="mdescRight">This method returns the name of the underlying database column being used as the geometry column, or "" if not supported. <a href="#af68036c23622c954ce3a91861f22b724">More...</a><br/></td></tr> <tr class="separator:af68036c23622c954ce3a91861f22b724"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5e0c3427f64249d1c35cefb487546b10"><td class="memItemLeft" align="right" valign="top">virtual OGRErr </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRLayer.html#a5e0c3427f64249d1c35cefb487546b10">SetIgnoredFields</a> (const char **papszFields)</td></tr> <tr class="memdesc:a5e0c3427f64249d1c35cefb487546b10"><td class="mdescLeft"> </td><td class="mdescRight">Set which fields can be omitted when retrieving features from the layer. <a href="#a5e0c3427f64249d1c35cefb487546b10">More...</a><br/></td></tr> <tr class="separator:a5e0c3427f64249d1c35cefb487546b10"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac189f54996c2d6fd769889ec99e0f48a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac189f54996c2d6fd769889ec99e0f48a"></a> OGRErr </td><td class="memItemRight" valign="bottom"><b>Intersection</b> (<a class="el" href="classOGRLayer.html">OGRLayer</a> *pLayerMethod, <a class="el" href="classOGRLayer.html">OGRLayer</a> *pLayerResult, char **papszOptions=NULL, GDALProgressFunc pfnProgress=NULL, void *pProgressArg=NULL)</td></tr> <tr class="separator:ac189f54996c2d6fd769889ec99e0f48a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aeb8ab475561f2aca2c0e605cfb810b22"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeb8ab475561f2aca2c0e605cfb810b22"></a> OGRErr </td><td class="memItemRight" valign="bottom"><b>Union</b> (<a class="el" href="classOGRLayer.html">OGRLayer</a> *pLayerMethod, <a class="el" href="classOGRLayer.html">OGRLayer</a> *pLayerResult, char **papszOptions=NULL, GDALProgressFunc pfnProgress=NULL, void *pProgressArg=NULL)</td></tr> <tr class="separator:aeb8ab475561f2aca2c0e605cfb810b22"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a781aa76c6b44b19de09f61816e32245b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a781aa76c6b44b19de09f61816e32245b"></a> OGRErr </td><td class="memItemRight" valign="bottom"><b>SymDifference</b> (<a class="el" href="classOGRLayer.html">OGRLayer</a> *pLayerMethod, <a class="el" href="classOGRLayer.html">OGRLayer</a> *pLayerResult, char **papszOptions, GDALProgressFunc pfnProgress, void *pProgressArg)</td></tr> <tr class="separator:a781aa76c6b44b19de09f61816e32245b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:acac6a0bde9737555b22c6ac7fa967431"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acac6a0bde9737555b22c6ac7fa967431"></a> OGRErr </td><td class="memItemRight" valign="bottom"><b>Identity</b> (<a class="el" href="classOGRLayer.html">OGRLayer</a> *pLayerMethod, <a class="el" href="classOGRLayer.html">OGRLayer</a> *pLayerResult, char **papszOptions=NULL, GDALProgressFunc pfnProgress=NULL, void *pProgressArg=NULL)</td></tr> <tr class="separator:acac6a0bde9737555b22c6ac7fa967431"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa1c5dc5ca195956c46d35a85b0b21d9b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa1c5dc5ca195956c46d35a85b0b21d9b"></a> OGRErr </td><td class="memItemRight" valign="bottom"><b>Update</b> (<a class="el" href="classOGRLayer.html">OGRLayer</a> *pLayerMethod, <a class="el" href="classOGRLayer.html">OGRLayer</a> *pLayerResult, char **papszOptions=NULL, GDALProgressFunc pfnProgress=NULL, void *pProgressArg=NULL)</td></tr> <tr class="separator:aa1c5dc5ca195956c46d35a85b0b21d9b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a56d7ee3b2020e53c730d67ee4f1e2fb6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a56d7ee3b2020e53c730d67ee4f1e2fb6"></a> OGRErr </td><td class="memItemRight" valign="bottom"><b>Clip</b> (<a class="el" href="classOGRLayer.html">OGRLayer</a> *pLayerMethod, <a class="el" href="classOGRLayer.html">OGRLayer</a> *pLayerResult, char **papszOptions=NULL, GDALProgressFunc pfnProgress=NULL, void *pProgressArg=NULL)</td></tr> <tr class="separator:a56d7ee3b2020e53c730d67ee4f1e2fb6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae8fcf55ffa259f32df35edcb05274439"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae8fcf55ffa259f32df35edcb05274439"></a> OGRErr </td><td class="memItemRight" valign="bottom"><b>Erase</b> (<a class="el" href="classOGRLayer.html">OGRLayer</a> *pLayerMethod, <a class="el" href="classOGRLayer.html">OGRLayer</a> *pLayerResult, char **papszOptions=NULL, GDALProgressFunc pfnProgress=NULL, void *pProgressArg=NULL)</td></tr> <tr class="separator:ae8fcf55ffa259f32df35edcb05274439"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae783de2e9ee2629e6bf27fd3b8622fb5"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRLayer.html#ae783de2e9ee2629e6bf27fd3b8622fb5">Reference</a> ()</td></tr> <tr class="memdesc:ae783de2e9ee2629e6bf27fd3b8622fb5"><td class="mdescLeft"> </td><td class="mdescRight">Increment layer reference count. <a href="#ae783de2e9ee2629e6bf27fd3b8622fb5">More...</a><br/></td></tr> <tr class="separator:ae783de2e9ee2629e6bf27fd3b8622fb5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2271d53f75d4f6ff2f4a8aeb71e825d6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRLayer.html#a2271d53f75d4f6ff2f4a8aeb71e825d6">Dereference</a> ()</td></tr> <tr class="memdesc:a2271d53f75d4f6ff2f4a8aeb71e825d6"><td class="mdescLeft"> </td><td class="mdescRight">Decrement layer reference count. <a href="#a2271d53f75d4f6ff2f4a8aeb71e825d6">More...</a><br/></td></tr> <tr class="separator:a2271d53f75d4f6ff2f4a8aeb71e825d6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2fc393bc9962a73e94478b72d9fc4954"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRLayer.html#a2fc393bc9962a73e94478b72d9fc4954">GetRefCount</a> () const </td></tr> <tr class="memdesc:a2fc393bc9962a73e94478b72d9fc4954"><td class="mdescLeft"> </td><td class="mdescRight">Fetch reference count. <a href="#a2fc393bc9962a73e94478b72d9fc4954">More...</a><br/></td></tr> <tr class="separator:a2fc393bc9962a73e94478b72d9fc4954"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa115651be277d0c5100ec00e1835fdd0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa115651be277d0c5100ec00e1835fdd0"></a> GIntBig </td><td class="memItemRight" valign="bottom"><b>GetFeaturesRead</b> ()</td></tr> <tr class="separator:aa115651be277d0c5100ec00e1835fdd0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab4c02b991bfa78552eeb0cbcdcf1aed8"><td class="memItemLeft" align="right" valign="top">OGRErr </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRLayer.html#ab4c02b991bfa78552eeb0cbcdcf1aed8">ReorderField</a> (int iOldFieldPos, int iNewFieldPos)</td></tr> <tr class="memdesc:ab4c02b991bfa78552eeb0cbcdcf1aed8"><td class="mdescLeft"> </td><td class="mdescRight">Reorder an existing field on a layer. <a href="#ab4c02b991bfa78552eeb0cbcdcf1aed8">More...</a><br/></td></tr> <tr class="separator:ab4c02b991bfa78552eeb0cbcdcf1aed8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a981aa2d33beb085a2f1313e63d5a3532"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a981aa2d33beb085a2f1313e63d5a3532"></a> int </td><td class="memItemRight" valign="bottom"><b>AttributeFilterEvaluationNeedsGeometry</b> ()</td></tr> <tr class="separator:a981aa2d33beb085a2f1313e63d5a3532"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aedd3eefce78b6dd3e57dee48e005e11a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aedd3eefce78b6dd3e57dee48e005e11a"></a> OGRErr </td><td class="memItemRight" valign="bottom"><b>InitializeIndexSupport</b> (const char *)</td></tr> <tr class="separator:aedd3eefce78b6dd3e57dee48e005e11a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad157ca3951ca0dc5228354980fbc553f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad157ca3951ca0dc5228354980fbc553f"></a> <a class="el" href="classOGRLayerAttrIndex.html">OGRLayerAttrIndex</a> * </td><td class="memItemRight" valign="bottom"><b>GetIndex</b> ()</td></tr> <tr class="separator:ad157ca3951ca0dc5228354980fbc553f"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> Protected Member Functions</h2></td></tr> <tr class="memitem:ae3137fa7b37c708a0774d85673f60325"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae3137fa7b37c708a0774d85673f60325"></a> int </td><td class="memItemRight" valign="bottom"><b>FilterGeometry</b> (OGRGeometry *)</td></tr> <tr class="separator:ae3137fa7b37c708a0774d85673f60325"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a352b15ff1bae23039538bc05ec37195f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a352b15ff1bae23039538bc05ec37195f"></a> int </td><td class="memItemRight" valign="bottom"><b>InstallFilter</b> (OGRGeometry *)</td></tr> <tr class="separator:a352b15ff1bae23039538bc05ec37195f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a36eca63081674dd8001a314e7957618b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a36eca63081674dd8001a314e7957618b"></a> OGRErr </td><td class="memItemRight" valign="bottom"><b>GetExtentInternal</b> (int iGeomField, OGREnvelope *psExtent, int bForce)</td></tr> <tr class="separator:a36eca63081674dd8001a314e7957618b"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a> Protected Attributes</h2></td></tr> <tr class="memitem:a29d8149758b1c0870dfbcefb15d4aa4a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a29d8149758b1c0870dfbcefb15d4aa4a"></a> int </td><td class="memItemRight" valign="bottom"><b>m_bFilterIsEnvelope</b></td></tr> <tr class="separator:a29d8149758b1c0870dfbcefb15d4aa4a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9dade1d7ba7522aaea2cdbbb6e3e5e9f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9dade1d7ba7522aaea2cdbbb6e3e5e9f"></a> OGRGeometry * </td><td class="memItemRight" valign="bottom"><b>m_poFilterGeom</b></td></tr> <tr class="separator:a9dade1d7ba7522aaea2cdbbb6e3e5e9f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac92a22c7efc7bbb6ac9c0d0f4cdd9f4a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac92a22c7efc7bbb6ac9c0d0f4cdd9f4a"></a> OGRPreparedGeometry * </td><td class="memItemRight" valign="bottom"><b>m_pPreparedFilterGeom</b></td></tr> <tr class="separator:ac92a22c7efc7bbb6ac9c0d0f4cdd9f4a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0c1fd4e25c8a5d7080323e14a8f7a682"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0c1fd4e25c8a5d7080323e14a8f7a682"></a> OGREnvelope </td><td class="memItemRight" valign="bottom"><b>m_sFilterEnvelope</b></td></tr> <tr class="separator:a0c1fd4e25c8a5d7080323e14a8f7a682"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2def8404ca4d9e775676f2c0aed1e0a3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2def8404ca4d9e775676f2c0aed1e0a3"></a> int </td><td class="memItemRight" valign="bottom"><b>m_iGeomFieldFilter</b></td></tr> <tr class="separator:a2def8404ca4d9e775676f2c0aed1e0a3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9e0d2c752c60890aa6cfc88e0313ea95"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9e0d2c752c60890aa6cfc88e0313ea95"></a> OGRStyleTable * </td><td class="memItemRight" valign="bottom"><b>m_poStyleTable</b></td></tr> <tr class="separator:a9e0d2c752c60890aa6cfc88e0313ea95"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab1d526cb57f9e885a909c78ea09117b4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab1d526cb57f9e885a909c78ea09117b4"></a> OGRFeatureQuery * </td><td class="memItemRight" valign="bottom"><b>m_poAttrQuery</b></td></tr> <tr class="separator:ab1d526cb57f9e885a909c78ea09117b4"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:afccfdded1c0722eba7eb51d5e4d76288"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afccfdded1c0722eba7eb51d5e4d76288"></a> char * </td><td class="memItemRight" valign="bottom"><b>m_pszAttrQueryString</b></td></tr> <tr class="separator:afccfdded1c0722eba7eb51d5e4d76288"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7211ce20ccbaa8e45a14e1cee5fde825"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7211ce20ccbaa8e45a14e1cee5fde825"></a> <a class="el" href="classOGRLayerAttrIndex.html">OGRLayerAttrIndex</a> * </td><td class="memItemRight" valign="bottom"><b>m_poAttrIndex</b></td></tr> <tr class="separator:a7211ce20ccbaa8e45a14e1cee5fde825"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a45bde7b9ca67f27976ded99f7db342a9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a45bde7b9ca67f27976ded99f7db342a9"></a> int </td><td class="memItemRight" valign="bottom"><b>m_nRefCount</b></td></tr> <tr class="separator:a45bde7b9ca67f27976ded99f7db342a9"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af1b8b198adb20343958aca5062106f04"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af1b8b198adb20343958aca5062106f04"></a> GIntBig </td><td class="memItemRight" valign="bottom"><b>m_nFeaturesRead</b></td></tr> <tr class="separator:af1b8b198adb20343958aca5062106f04"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>This class represents a layer of simple features, with access methods. </p> </div><h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a71e69a665e93001d48a4339695f33c1a"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">OGRErr OGRLayer::AlterFieldDefn </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>iField</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">OGRFieldDefn * </td> <td class="paramname"><em>poNewFieldDefn</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>nFlags</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Alter the definition of an existing field on a layer. </p> <p>You must use this to alter the definition of an existing field of a real layer. Internally the OGRFeatureDefn for the layer will be updated to reflect the altered field. Applications should never modify the OGRFeatureDefn used by a layer directly.</p> <p>This method should not be called while there are feature objects in existance that were obtained or created with the previous layer definition.</p> <p>Not all drivers support this method. You can query a layer to check if it supports it with the OLCAlterFieldDefn capability. Some drivers may only support this method while there are still no features in the layer. When it is supported, the existings features of the backing file/database should be updated accordingly. Some drivers might also not support all update flags.</p> <p>This function is the same as the C function OGR_L_AlterFieldDefn().</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">iField</td><td>index of the field whose definition must be altered. </td></tr> <tr><td class="paramname">poNewFieldDefn</td><td>new field definition </td></tr> <tr><td class="paramname">nFlags</td><td>combination of ALTER_NAME_FLAG, ALTER_TYPE_FLAG and ALTER_WIDTH_PRECISION_FLAG to indicate which of the name and/or type and/or width and precision fields from the new field definition must be taken into account.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>OGRERR_NONE on success.</dd></dl> <dl class="section since"><dt>Since</dt><dd>OGR 1.9.0 </dd></dl> </div> </div> <a class="anchor" id="aaa1e32016f481596a55e1d988a15a067"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">OGRErr OGRLayer::CreateFeature </td> <td>(</td> <td class="paramtype">OGRFeature * </td> <td class="paramname"><em>poFeature</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Create and write a new feature within a layer. </p> <p>The passed feature is written to the layer as a new feature, rather than overwriting an existing one. If the feature has a feature id other than OGRNullFID, then the native implementation may use that as the feature id of the new feature, but not necessarily. Upon successful return the passed feature will have been updated with the new feature id.</p> <p>This method is the same as the C function OGR_L_CreateFeature().</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">poFeature</td><td>the feature to write to disk.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>OGRERR_NONE on success. </dd></dl> </div> </div> <a class="anchor" id="a00b1376a1eabb1298ef278f92f6d84be"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">OGRErr OGRLayer::CreateField </td> <td>(</td> <td class="paramtype">OGRFieldDefn * </td> <td class="paramname"><em>poField</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>bApproxOK</em> = <code>TRUE</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Create a new field on a layer. </p> <p>You must use this to create new fields on a real layer. Internally the OGRFeatureDefn for the layer will be updated to reflect the new field. Applications should never modify the OGRFeatureDefn used by a layer directly.</p> <p>This method should not be called while there are feature objects in existance that were obtained or created with the previous layer definition.</p> <p>Not all drivers support this method. You can query a layer to check if it supports it with the OLCCreateField capability. Some drivers may only support this method while there are still no features in the layer. When it is supported, the existings features of the backing file/database should be updated accordingly.</p> <p>This function is the same as the C function OGR_L_CreateField().</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">poField</td><td>field definition to write to disk. </td></tr> <tr><td class="paramname">bApproxOK</td><td>If TRUE, the field may be created in a slightly different form depending on the limitations of the format driver.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>OGRERR_NONE on success. </dd></dl> </div> </div> <a class="anchor" id="af3c68cad279ad80a476c6fb307cf5e48"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">OGRErr OGRLayer::CreateGeomField </td> <td>(</td> <td class="paramtype">OGRGeomFieldDefn * </td> <td class="paramname"><em>poField</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>bApproxOK</em> = <code>TRUE</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Create a new geometry field on a layer. </p> <p>You must use this to create new geometry fields on a real layer. Internally the OGRFeatureDefn for the layer will be updated to reflect the new field. Applications should never modify the OGRFeatureDefn used by a layer directly.</p> <p>This method should not be called while there are feature objects in existance that were obtained or created with the previous layer definition.</p> <p>Not all drivers support this method. You can query a layer to check if it supports it with the OLCCreateGeomField capability. Some drivers may only support this method while there are still no features in the layer. When it is supported, the existings features of the backing file/database should be updated accordingly.</p> <p>This function is the same as the C function OGR_L_CreateGeomField().</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">poField</td><td>geometry field definition to write to disk. </td></tr> <tr><td class="paramname">bApproxOK</td><td>If TRUE, the field may be created in a slightly different form depending on the limitations of the format driver.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>OGRERR_NONE on success.</dd></dl> <dl class="section since"><dt>Since</dt><dd>OGR 1.11 </dd></dl> </div> </div> <a class="anchor" id="a7e3d454d54a615a1b4359628bb6e7674"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">OGRErr OGRLayer::DeleteFeature </td> <td>(</td> <td class="paramtype">long </td> <td class="paramname"><em>nFID</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Delete feature from layer. </p> <p>The feature with the indicated feature id is deleted from the layer if supported by the driver. Most drivers do not support feature deletion, and will return OGRERR_UNSUPPORTED_OPERATION. The <a class="el" href="classOGRLayer.html#aeedbda1a62f9b89b8e5f24332cf22286" title="Test if this layer supported the named capability. ">TestCapability()</a> layer method may be called with OLCDeleteFeature to check if the driver supports feature deletion.</p> <p>This method is the same as the C function OGR_L_DeleteFeature().</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">nFID</td><td>the feature id to be deleted from the layer</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>OGRERR_NONE on success. </dd></dl> </div> </div> <a class="anchor" id="aaebe7c671dca995549543eecf0f7a76a"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">OGRErr OGRLayer::DeleteField </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>iField</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Delete an existing field on a layer. </p> <p>You must use this to delete existing fields on a real layer. Internally the OGRFeatureDefn for the layer will be updated to reflect the deleted field. Applications should never modify the OGRFeatureDefn used by a layer directly.</p> <p>This method should not be called while there are feature objects in existance that were obtained or created with the previous layer definition.</p> <p>Not all drivers support this method. You can query a layer to check if it supports it with the OLCDeleteField capability. Some drivers may only support this method while there are still no features in the layer. When it is supported, the existings features of the backing file/database should be updated accordingly.</p> <p>This function is the same as the C function OGR_L_DeleteField().</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">iField</td><td>index of the field to delete.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>OGRERR_NONE on success.</dd></dl> <dl class="section since"><dt>Since</dt><dd>OGR 1.9.0 </dd></dl> </div> </div> <a class="anchor" id="a2271d53f75d4f6ff2f4a8aeb71e825d6"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int OGRLayer::Dereference </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Decrement layer reference count. </p> <p>This method is the same as the C function OGR_L_Dereference().</p> <dl class="section return"><dt>Returns</dt><dd>the reference count after decrementing. </dd></dl> </div> </div> <a class="anchor" id="aef41bcd7adad1ac5ddcef54d6b38713c"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">int OGRLayer::FindFieldIndex </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>pszFieldName</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>bExactMatch</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Find the index of field in the layer. </p> <p>The returned number is the index of the field in the layers, or -1 if the field doesn't exist.</p> <p>If bExactMatch is set to FALSE and the field doesn't exists in the given form the driver might apply some changes to make it match, like those it might do if the layer was created (eg. like LAUNDER in the OCI driver).</p> <p>This method is the same as the C function OGR_L_FindFieldIndex().</p> <dl class="section return"><dt>Returns</dt><dd>field index, or -1 if the field doesn't exist </dd></dl> </div> </div> <a class="anchor" id="a3be658ddb5b33d1ed95c31286774bbd2"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">OGRErr OGRLayer::GetExtent </td> <td>(</td> <td class="paramtype">OGREnvelope * </td> <td class="paramname"><em>psExtent</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>bForce</em> = <code>TRUE</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Fetch the extent of this layer. </p> <p>Returns the extent (MBR) of the data in the layer. If bForce is FALSE, and it would be expensive to establish the extent then OGRERR_FAILURE will be returned indicating that the extent isn't know. If bForce is TRUE then some implementations will actually scan the entire layer once to compute the MBR of all the features in the layer.</p> <p>Depending on the drivers, the returned extent may or may not take the spatial filter into account. So it is safer to call <a class="el" href="classOGRLayer.html#a3be658ddb5b33d1ed95c31286774bbd2" title="Fetch the extent of this layer. ">GetExtent()</a> without setting a spatial filter.</p> <p>Layers without any geometry may return OGRERR_FAILURE just indicating that no meaningful extents could be collected.</p> <p>Note that some implementations of this method may alter the read cursor of the layer.</p> <p>This method is the same as the C function OGR_L_GetExtent().</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">psExtent</td><td>the structure in which the extent value will be returned. </td></tr> <tr><td class="paramname">bForce</td><td>Flag indicating whether the extent should be computed even if it is expensive.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>OGRERR_NONE on success, OGRERR_FAILURE if extent not known. </dd></dl> </div> </div> <a class="anchor" id="a47a3cc550866eee1668bea2315f9df9c"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">OGRErr OGRLayer::GetExtent </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>iGeomField</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">OGREnvelope * </td> <td class="paramname"><em>psExtent</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>bForce</em> = <code>TRUE</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Fetch the extent of this layer, on the specified geometry field. </p> <p>Returns the extent (MBR) of the data in the layer. If bForce is FALSE, and it would be expensive to establish the extent then OGRERR_FAILURE will be returned indicating that the extent isn't know. If bForce is TRUE then some implementations will actually scan the entire layer once to compute the MBR of all the features in the layer.</p> <p>Depending on the drivers, the returned extent may or may not take the spatial filter into account. So it is safer to call <a class="el" href="classOGRLayer.html#a3be658ddb5b33d1ed95c31286774bbd2" title="Fetch the extent of this layer. ">GetExtent()</a> without setting a spatial filter.</p> <p>Layers without any geometry may return OGRERR_FAILURE just indicating that no meaningful extents could be collected.</p> <p>Note that some implementations of this method may alter the read cursor of the layer.</p> <p>Note to driver implementators: if you implement <a class="el" href="classOGRLayer.html#a47a3cc550866eee1668bea2315f9df9c" title="Fetch the extent of this layer, on the specified geometry field. ">GetExtent(int,OGREnvelope*,int)</a>, you must also implement <a class="el" href="classOGRLayer.html#a3be658ddb5b33d1ed95c31286774bbd2" title="Fetch the extent of this layer. ">GetExtent(OGREnvelope*, int)</a> to make it call GetExtent(0,OGREnvelope*,int).</p> <p>This method is the same as the C function OGR_L_GetExtentEx().</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">iGeomField</td><td>the index of the geometry field on which to compute the extent. </td></tr> <tr><td class="paramname">psExtent</td><td>the structure in which the extent value will be returned. </td></tr> <tr><td class="paramname">bForce</td><td>Flag indicating whether the extent should be computed even if it is expensive.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>OGRERR_NONE on success, OGRERR_FAILURE if extent not known. </dd></dl> </div> </div> <a class="anchor" id="acb7625383f161e5a04aeea2173dce411"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">OGRFeature * OGRLayer::GetFeature </td> <td>(</td> <td class="paramtype">long </td> <td class="paramname"><em>nFID</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Fetch a feature by its identifier. </p> <p>This function will attempt to read the identified feature. The nFID value cannot be OGRNullFID. Success or failure of this operation is unaffected by the spatial or attribute filters (and specialized implementations in drivers should make sure that they do not take into account spatial or attribute filters).</p> <p>If this method returns a non-NULL feature, it is guaranteed that its feature id (OGRFeature::GetFID()) will be the same as nFID.</p> <p>Use OGRLayer::TestCapability(OLCRandomRead) to establish if this layer supports efficient random access reading via <a class="el" href="classOGRLayer.html#acb7625383f161e5a04aeea2173dce411" title="Fetch a feature by its identifier. ">GetFeature()</a>; however, the call should always work if the feature exists as a fallback implementation just scans all the features in the layer looking for the desired feature.</p> <p>Sequential reads (with <a class="el" href="classOGRLayer.html#a47d21ff33b32d14fa4e9885b9edecad6" title="Fetch the next available feature from this layer. ">GetNextFeature()</a>) are generally considered interrupted by a <a class="el" href="classOGRLayer.html#acb7625383f161e5a04aeea2173dce411" title="Fetch a feature by its identifier. ">GetFeature()</a> call.</p> <p>The returned feature should be free with OGRFeature::DestroyFeature().</p> <p>This method is the same as the C function OGR_L_GetFeature().</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">nFID</td><td>the feature id of the feature to read.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>a feature now owned by the caller, or NULL on failure. </dd></dl> </div> </div> <a class="anchor" id="a74c796d4ce712e9a78df6042eeb8a91a"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">int OGRLayer::GetFeatureCount </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>bForce</em> = <code>TRUE</code></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Fetch the feature count in this layer. </p> <p>Returns the number of features in the layer. For dynamic databases the count may not be exact. If bForce is FALSE, and it would be expensive to establish the feature count a value of -1 may be returned indicating that the count isn't know. If bForce is TRUE some implementations will actually scan the entire layer once to count objects.</p> <p>The returned count takes the spatial filter into account.</p> <p>Note that some implementations of this method may alter the read cursor of the layer.</p> <p>This method is the same as the C function OGR_L_GetFeatureCount().</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">bForce</td><td>Flag indicating whether the count should be computed even if it is expensive.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>feature count, -1 if count not known. </dd></dl> </div> </div> <a class="anchor" id="af0cb9a05310d7b17d9dfec9e83a18e61"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const char * OGRLayer::GetFIDColumn </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>This method returns the name of the underlying database column being used as the FID column, or "" if not supported. </p> <p>This method is the same as the C function OGR_L_GetFIDColumn().</p> <dl class="section return"><dt>Returns</dt><dd>fid column name. </dd></dl> </div> </div> <a class="anchor" id="af68036c23622c954ce3a91861f22b724"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const char * OGRLayer::GetGeometryColumn </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>This method returns the name of the underlying database column being used as the geometry column, or "" if not supported. </p> <p>This method is the same as the C function OGR_L_GetGeometryColumn().</p> <dl class="section return"><dt>Returns</dt><dd>geometry column name. </dd></dl> </div> </div> <a class="anchor" id="a818a25520ce08d5a681443348e930604"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">OGRwkbGeometryType OGRLayer::GetGeomType </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Return the layer geometry type. </p> <p>This returns the same result as <a class="el" href="classOGRLayer.html#a80473bcfd11341e70dd35bebe94026cf" title="Fetch the schema information for this layer. ">GetLayerDefn()</a>-><a class="el" href="classOGRLayer.html#a818a25520ce08d5a681443348e930604" title="Return the layer geometry type. ">GetGeomType()</a>, but for a few drivers, calling <a class="el" href="classOGRLayer.html#a818a25520ce08d5a681443348e930604" title="Return the layer geometry type. ">GetGeomType()</a> directly can avoid lengthy layer definition initialization.</p> <p>This method is the same as the C function OGR_L_GetGeomType().</p> <p>If this method is derived in a driver, it must be done such that it returns the same content as <a class="el" href="classOGRLayer.html#a80473bcfd11341e70dd35bebe94026cf" title="Fetch the schema information for this layer. ">GetLayerDefn()</a>-><a class="el" href="classOGRLayer.html#a818a25520ce08d5a681443348e930604" title="Return the layer geometry type. ">GetGeomType()</a>.</p> <dl class="section return"><dt>Returns</dt><dd>the geometry type </dd></dl> <dl class="section since"><dt>Since</dt><dd>OGR 1.8.0 </dd></dl> </div> </div> <a class="anchor" id="a143b0d2c48bc0adf3a19d1f51e76b8ba"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const char * OGRLayer::GetInfo </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>pszTag</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Fetch metadata from layer. </p> <p>This method can be used to fetch various kinds of metadata or layer specific information encoded as a string. It is anticipated that various tag values will be defined with well known semantics, while other tags will be used for driver/application specific purposes.</p> <p>This method is deprecated and will be replaced with a more general metadata model in the future. At this time no drivers return information via the <a class="el" href="classOGRLayer.html#a143b0d2c48bc0adf3a19d1f51e76b8ba" title="Fetch metadata from layer. ">GetInfo()</a> call.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">pszTag</td><td>the tag for which information is being requested.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>the value of the requested tag, or NULL if that tag does not have a value, or is unknown.</dd></dl> <dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000001">Deprecated:</a></b></dt><dd></dd></dl> </div> </div> <a class="anchor" id="a80473bcfd11341e70dd35bebe94026cf"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">OGRFeatureDefn * OGRLayer::GetLayerDefn </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Fetch the schema information for this layer. </p> <p>The returned OGRFeatureDefn is owned by the <a class="el" href="classOGRLayer.html">OGRLayer</a>, and should not be modified or freed by the application. It encapsulates the attribute schema of the features of the layer.</p> <p>This method is the same as the C function OGR_L_GetLayerDefn().</p> <dl class="section return"><dt>Returns</dt><dd>feature definition. </dd></dl> </div> </div> <a class="anchor" id="a287f5ec7728cacc2f7d94882a9f1a22e"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const char * OGRLayer::GetName </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Return the layer name. </p> <p>This returns the same content as <a class="el" href="classOGRLayer.html#a80473bcfd11341e70dd35bebe94026cf" title="Fetch the schema information for this layer. ">GetLayerDefn()</a>-><a class="el" href="classOGRLayer.html#a287f5ec7728cacc2f7d94882a9f1a22e" title="Return the layer name. ">GetName()</a>, but for a few drivers, calling <a class="el" href="classOGRLayer.html#a287f5ec7728cacc2f7d94882a9f1a22e" title="Return the layer name. ">GetName()</a> directly can avoid lengthy layer definition initialization.</p> <p>This method is the same as the C function OGR_L_GetName().</p> <p>If this method is derived in a driver, it must be done such that it returns the same content as <a class="el" href="classOGRLayer.html#a80473bcfd11341e70dd35bebe94026cf" title="Fetch the schema information for this layer. ">GetLayerDefn()</a>-><a class="el" href="classOGRLayer.html#a287f5ec7728cacc2f7d94882a9f1a22e" title="Return the layer name. ">GetName()</a>.</p> <dl class="section return"><dt>Returns</dt><dd>the layer name (must not been freed) </dd></dl> <dl class="section since"><dt>Since</dt><dd>OGR 1.8.0 </dd></dl> </div> </div> <a class="anchor" id="a47d21ff33b32d14fa4e9885b9edecad6"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">OGRFeature * OGRLayer::GetNextFeature </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Fetch the next available feature from this layer. </p> <p>The returned feature becomes the responsiblity of the caller to delete with OGRFeature::DestroyFeature(). It is critical that all features associated with an <a class="el" href="classOGRLayer.html">OGRLayer</a> (more specifically an OGRFeatureDefn) be deleted before that layer/datasource is deleted.</p> <p>Only features matching the current spatial filter (set with <a class="el" href="classOGRLayer.html#a0b4ab45cf97cbc470f0d60474d3e4169" title="Set a new spatial filter. ">SetSpatialFilter()</a>) will be returned.</p> <p>This method implements sequential access to the features of a layer. The <a class="el" href="classOGRLayer.html#aad0f2cd7f0587584b8f382c6a913583c" title="Reset feature reading to start on the first feature. ">ResetReading()</a> method can be used to start at the beginning again.</p> <p>This method is the same as the C function OGR_L_GetNextFeature().</p> <dl class="section return"><dt>Returns</dt><dd>a feature, or NULL if no more features are available. </dd></dl> </div> </div> <a class="anchor" id="a2fc393bc9962a73e94478b72d9fc4954"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int OGRLayer::GetRefCount </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Fetch reference count. </p> <p>This method is the same as the C function OGR_L_GetRefCount().</p> <dl class="section return"><dt>Returns</dt><dd>the current reference count for the layer object itself. </dd></dl> </div> </div> <a class="anchor" id="adc3735e444204d46f517eec251712f4d"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">OGRGeometry * OGRLayer::GetSpatialFilter </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>This method returns the current spatial filter for this layer. </p> <p>The returned pointer is to an internally owned object, and should not be altered or deleted by the caller.</p> <p>This method is the same as the C function OGR_L_GetSpatialFilter().</p> <dl class="section return"><dt>Returns</dt><dd>spatial filter geometry. </dd></dl> </div> </div> <a class="anchor" id="a75c06b4993f8eb76b569f37365cd19ab"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">OGRSpatialReference * OGRLayer::GetSpatialRef </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Fetch the spatial reference system for this layer. </p> <p>The returned object is owned by the <a class="el" href="classOGRLayer.html">OGRLayer</a> and should not be modified or freed by the application.</p> <p>Starting with OGR 1.11, several geometry fields can be associated to a feature definition. Each geometry field can have its own spatial reference system, which is returned by OGRGeomFieldDefn::GetSpatialRef(). <a class="el" href="classOGRLayer.html#a75c06b4993f8eb76b569f37365cd19ab" title="Fetch the spatial reference system for this layer. ">OGRLayer::GetSpatialRef()</a> is equivalent to <a class="el" href="classOGRLayer.html#a80473bcfd11341e70dd35bebe94026cf" title="Fetch the schema information for this layer. ">GetLayerDefn()</a>->GetGeomFieldDefn(0)-><a class="el" href="classOGRLayer.html#a75c06b4993f8eb76b569f37365cd19ab" title="Fetch the spatial reference system for this layer. ">GetSpatialRef()</a></p> <p>This method is the same as the C function OGR_L_GetSpatialRef().</p> <dl class="section return"><dt>Returns</dt><dd>spatial reference, or NULL if there isn't one. </dd></dl> </div> </div> <a class="anchor" id="a265ddcd701c1d29cb959aae97dda1af4"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void OGRLayer::GetStyleTable </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Returns layer style table. </p> <p>This method is the same as the C function OGR_L_GetStyleTable().</p> <dl class="section return"><dt>Returns</dt><dd>pointer to a style table which should not be modified or freed by the caller. </dd></dl> </div> </div> <a class="anchor" id="ae783de2e9ee2629e6bf27fd3b8622fb5"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int OGRLayer::Reference </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Increment layer reference count. </p> <p>This method is the same as the C function OGR_L_Reference().</p> <dl class="section return"><dt>Returns</dt><dd>the reference count after incrementing. </dd></dl> </div> </div> <a class="anchor" id="ab4c02b991bfa78552eeb0cbcdcf1aed8"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">OGRErr OGRLayer::ReorderField </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>iOldFieldPos</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>iNewFieldPos</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Reorder an existing field on a layer. </p> <p>This method is a conveniency wrapper of <a class="el" href="classOGRLayer.html#aebd364a150d91f8d65d967646e0f92d3" title="Reorder all the fields of a layer. ">ReorderFields()</a> dedicated to move a single field. It is a non-virtual method, so drivers should implement <a class="el" href="classOGRLayer.html#aebd364a150d91f8d65d967646e0f92d3" title="Reorder all the fields of a layer. ">ReorderFields()</a> instead.</p> <p>You must use this to reorder existing fields on a real layer. Internally the OGRFeatureDefn for the layer will be updated to reflect the reordering of the fields. Applications should never modify the OGRFeatureDefn used by a layer directly.</p> <p>This method should not be called while there are feature objects in existance that were obtained or created with the previous layer definition.</p> <p>The field definition that was at initial position iOldFieldPos will be moved at position iNewFieldPos, and elements between will be shuffled accordingly.</p> <p>For example, let suppose the fields were "0","1","2","3","4" initially. ReorderField(1, 3) will reorder them as "0","2","3","1","4".</p> <p>Not all drivers support this method. You can query a layer to check if it supports it with the OLCReorderFields capability. Some drivers may only support this method while there are still no features in the layer. When it is supported, the existings features of the backing file/database should be updated accordingly.</p> <p>This function is the same as the C function OGR_L_ReorderField().</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">iOldFieldPos</td><td>previous position of the field to move. Must be in the range [0,GetFieldCount()-1]. </td></tr> <tr><td class="paramname">iNewFieldPos</td><td>new position of the field to move. Must be in the range [0,GetFieldCount()-1].</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>OGRERR_NONE on success.</dd></dl> <dl class="section since"><dt>Since</dt><dd>OGR 1.9.0 </dd></dl> </div> </div> <a class="anchor" id="aebd364a150d91f8d65d967646e0f92d3"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">OGRErr OGRLayer::ReorderFields </td> <td>(</td> <td class="paramtype">int * </td> <td class="paramname"><em>panMap</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Reorder all the fields of a layer. </p> <p>You must use this to reorder existing fields on a real layer. Internally the OGRFeatureDefn for the layer will be updated to reflect the reordering of the fields. Applications should never modify the OGRFeatureDefn used by a layer directly.</p> <p>This method should not be called while there are feature objects in existance that were obtained or created with the previous layer definition.</p> <p>panMap is such that,for each field definition at position i after reordering, its position before reordering was panMap[i].</p> <p>For example, let suppose the fields were "0","1","2","3","4" initially. ReorderFields([0,2,3,1,4]) will reorder them as "0","2","3","1","4".</p> <p>Not all drivers support this method. You can query a layer to check if it supports it with the OLCReorderFields capability. Some drivers may only support this method while there are still no features in the layer. When it is supported, the existings features of the backing file/database should be updated accordingly.</p> <p>This function is the same as the C function OGR_L_ReorderFields().</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">panMap</td><td>an array of <a class="el" href="classOGRLayer.html#a80473bcfd11341e70dd35bebe94026cf" title="Fetch the schema information for this layer. ">GetLayerDefn()</a>->GetFieldCount() elements which is a permutation of [0, <a class="el" href="classOGRLayer.html#a80473bcfd11341e70dd35bebe94026cf" title="Fetch the schema information for this layer. ">GetLayerDefn()</a>->GetFieldCount()-1].</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>OGRERR_NONE on success.</dd></dl> <dl class="section since"><dt>Since</dt><dd>OGR 1.9.0 </dd></dl> </div> </div> <a class="anchor" id="aad0f2cd7f0587584b8f382c6a913583c"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void OGRLayer::ResetReading </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Reset feature reading to start on the first feature. </p> <p>This affects <a class="el" href="classOGRLayer.html#a47d21ff33b32d14fa4e9885b9edecad6" title="Fetch the next available feature from this layer. ">GetNextFeature()</a>.</p> <p>This method is the same as the C function OGR_L_ResetReading(). </p> </div> </div> <a class="anchor" id="a9ff2038ec26d2c3d1140178dc51b0a48"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void OGRLayer::SetAttributeFilter </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>pszQuery</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Set a new attribute query. </p> <p>This method sets the attribute query string to be used when fetching features via the <a class="el" href="classOGRLayer.html#a47d21ff33b32d14fa4e9885b9edecad6" title="Fetch the next available feature from this layer. ">GetNextFeature()</a> method. Only features for which the query evaluates as true will be returned.</p> <p>The query string should be in the format of an SQL WHERE clause. For instance "population > 1000000 and population < 5000000" where population is an attribute in the layer. The query format is normally a restricted form of SQL WHERE clause as described in the "WHERE" section of the <a href="ogr_sql.html">OGR SQL</a> tutorial. In some cases (RDBMS backed drivers) the native capabilities of the database may be used to interprete the WHERE clause in which case the capabilities will be broader than those of OGR SQL.</p> <p>Note that installing a query string will generally result in resetting the current reading position (ala <a class="el" href="classOGRLayer.html#aad0f2cd7f0587584b8f382c6a913583c" title="Reset feature reading to start on the first feature. ">ResetReading()</a>).</p> <p>This method is the same as the C function OGR_L_SetAttributeFilter().</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">pszQuery</td><td>query in restricted SQL WHERE format, or NULL to clear the current query.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>OGRERR_NONE if successfully installed, or an error code if the query expression is in error, or some other failure occurs. </dd></dl> </div> </div> <a class="anchor" id="a681139bfd585b74d7218e51a32144283"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">OGRErr OGRLayer::SetFeature </td> <td>(</td> <td class="paramtype">OGRFeature * </td> <td class="paramname"><em>poFeature</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Rewrite an existing feature. </p> <p>This method will write a feature to the layer, based on the feature id within the OGRFeature.</p> <p>Use OGRLayer::TestCapability(OLCRandomWrite) to establish if this layer supports random access writing via <a class="el" href="classOGRLayer.html#a681139bfd585b74d7218e51a32144283" title="Rewrite an existing feature. ">SetFeature()</a>.</p> <p>This method is the same as the C function OGR_L_SetFeature().</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">poFeature</td><td>the feature to write.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>OGRERR_NONE if the operation works, otherwise an appropriate error code. </dd></dl> </div> </div> <a class="anchor" id="a5e0c3427f64249d1c35cefb487546b10"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">OGRErr OGRLayer::SetIgnoredFields </td> <td>(</td> <td class="paramtype">const char ** </td> <td class="paramname"><em>papszFields</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Set which fields can be omitted when retrieving features from the layer. </p> <p>If the driver supports this functionality (testable using OLCIgnoreFields capability), it will not fetch the specified fields in subsequent calls to <a class="el" href="classOGRLayer.html#acb7625383f161e5a04aeea2173dce411" title="Fetch a feature by its identifier. ">GetFeature()</a> / <a class="el" href="classOGRLayer.html#a47d21ff33b32d14fa4e9885b9edecad6" title="Fetch the next available feature from this layer. ">GetNextFeature()</a> and thus save some processing time and/or bandwidth.</p> <p>Besides field names of the layers, the following special fields can be passed: "OGR_GEOMETRY" to ignore geometry and "OGR_STYLE" to ignore layer style.</p> <p>By default, no fields are ignored.</p> <p>This method is the same as the C function OGR_L_SetIgnoredFields()</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">papszFields</td><td>an array of field names terminated by NULL item. If NULL is passed, the ignored list is cleared. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>OGRERR_NONE if all field names have been resolved (even if the driver does not support this method) </dd></dl> </div> </div> <a class="anchor" id="ae3b6234d6077a18a19eddaf7e75ff5e1"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">OGRErr OGRLayer::SetNextByIndex </td> <td>(</td> <td class="paramtype">long </td> <td class="paramname"><em>nIndex</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Move read cursor to the nIndex'th feature in the current resultset. </p> <p>This method allows positioning of a layer such that the <a class="el" href="classOGRLayer.html#a47d21ff33b32d14fa4e9885b9edecad6" title="Fetch the next available feature from this layer. ">GetNextFeature()</a> call will read the requested feature, where nIndex is an absolute index into the current result set. So, setting it to 3 would mean the next feature read with <a class="el" href="classOGRLayer.html#a47d21ff33b32d14fa4e9885b9edecad6" title="Fetch the next available feature from this layer. ">GetNextFeature()</a> would have been the 4th feature to have been read if sequential reading took place from the beginning of the layer, including accounting for spatial and attribute filters.</p> <p>Only in rare circumstances is <a class="el" href="classOGRLayer.html#ae3b6234d6077a18a19eddaf7e75ff5e1" title="Move read cursor to the nIndex'th feature in the current resultset. ">SetNextByIndex()</a> efficiently implemented. In all other cases the default implementation which calls <a class="el" href="classOGRLayer.html#aad0f2cd7f0587584b8f382c6a913583c" title="Reset feature reading to start on the first feature. ">ResetReading()</a> and then calls <a class="el" href="classOGRLayer.html#a47d21ff33b32d14fa4e9885b9edecad6" title="Fetch the next available feature from this layer. ">GetNextFeature()</a> nIndex times is used. To determine if fast seeking is available on the current layer use the <a class="el" href="classOGRLayer.html#aeedbda1a62f9b89b8e5f24332cf22286" title="Test if this layer supported the named capability. ">TestCapability()</a> method with a value of OLCFastSetNextByIndex.</p> <p>This method is the same as the C function OGR_L_SetNextByIndex().</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">nIndex</td><td>the index indicating how many steps into the result set to seek.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>OGRERR_NONE on success or an error code. </dd></dl> </div> </div> <a class="anchor" id="a0b4ab45cf97cbc470f0d60474d3e4169"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void OGRLayer::SetSpatialFilter </td> <td>(</td> <td class="paramtype">OGRGeometry * </td> <td class="paramname"><em>poFilter</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Set a new spatial filter. </p> <p>This method set the geometry to be used as a spatial filter when fetching features via the <a class="el" href="classOGRLayer.html#a47d21ff33b32d14fa4e9885b9edecad6" title="Fetch the next available feature from this layer. ">GetNextFeature()</a> method. Only features that geometrically intersect the filter geometry will be returned.</p> <p>Currently this test is may be inaccurately implemented, but it is guaranteed that all features who's envelope (as returned by OGRGeometry::getEnvelope()) overlaps the envelope of the spatial filter will be returned. This can result in more shapes being returned that should strictly be the case.</p> <p>This method makes an internal copy of the passed geometry. The passed geometry remains the responsibility of the caller, and may be safely destroyed.</p> <p>For the time being the passed filter geometry should be in the same SRS as the layer (as returned by <a class="el" href="classOGRLayer.html#a75c06b4993f8eb76b569f37365cd19ab" title="Fetch the spatial reference system for this layer. ">OGRLayer::GetSpatialRef()</a>). In the future this may be generalized.</p> <p>This method is the same as the C function OGR_L_SetSpatialFilter().</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">poFilter</td><td>the geometry to use as a filtering region. NULL may be passed indicating that the current spatial filter should be cleared, but no new one instituted. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="aebac60fb86ee178be016655532070ee3"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void OGRLayer::SetSpatialFilter </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>iGeomField</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">OGRGeometry * </td> <td class="paramname"><em>poFilter</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Set a new spatial filter. </p> <p>This method set the geometry to be used as a spatial filter when fetching features via the <a class="el" href="classOGRLayer.html#a47d21ff33b32d14fa4e9885b9edecad6" title="Fetch the next available feature from this layer. ">GetNextFeature()</a> method. Only features that geometrically intersect the filter geometry will be returned.</p> <p>Currently this test is may be inaccurately implemented, but it is guaranteed that all features who's envelope (as returned by OGRGeometry::getEnvelope()) overlaps the envelope of the spatial filter will be returned. This can result in more shapes being returned that should strictly be the case.</p> <p>This method makes an internal copy of the passed geometry. The passed geometry remains the responsibility of the caller, and may be safely destroyed.</p> <p>For the time being the passed filter geometry should be in the same SRS as the geometry field definition it corresponds to (as returned by <a class="el" href="classOGRLayer.html#a80473bcfd11341e70dd35bebe94026cf" title="Fetch the schema information for this layer. ">GetLayerDefn()</a>->GetGeomFieldDefn(iGeomField)-><a class="el" href="classOGRLayer.html#a75c06b4993f8eb76b569f37365cd19ab" title="Fetch the spatial reference system for this layer. ">GetSpatialRef()</a>). In the future this may be generalized.</p> <p>Note that only the last spatial filter set is applied, even if several successive calls are done with different iGeomField values.</p> <p>Note to driver implementators: if you implement <a class="el" href="classOGRLayer.html#aebac60fb86ee178be016655532070ee3" title="Set a new spatial filter. ">SetSpatialFilter(int,OGRGeometry*)</a>, you must also implement <a class="el" href="classOGRLayer.html#a0b4ab45cf97cbc470f0d60474d3e4169" title="Set a new spatial filter. ">SetSpatialFilter(OGRGeometry*)</a> to make it call SetSpatialFilter(0,OGRGeometry*).</p> <p>This method is the same as the C function OGR_L_SetSpatialFilterEx().</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">iGeomField</td><td>index of the geometry field on which the spatial filter operates. </td></tr> <tr><td class="paramname">poFilter</td><td>the geometry to use as a filtering region. NULL may be passed indicating that the current spatial filter should be cleared, but no new one instituted.</td></tr> </table> </dd> </dl> <dl class="section since"><dt>Since</dt><dd>GDAL 1.11 </dd></dl> </div> </div> <a class="anchor" id="acd16bcdb3e8f720003fb24cd68f25460"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void OGRLayer::SetSpatialFilterRect </td> <td>(</td> <td class="paramtype">double </td> <td class="paramname"><em>dfMinX</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">double </td> <td class="paramname"><em>dfMinY</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">double </td> <td class="paramname"><em>dfMaxX</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">double </td> <td class="paramname"><em>dfMaxY</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Set a new rectangular spatial filter. </p> <p>This method set rectangle to be used as a spatial filter when fetching features via the <a class="el" href="classOGRLayer.html#a47d21ff33b32d14fa4e9885b9edecad6" title="Fetch the next available feature from this layer. ">GetNextFeature()</a> method. Only features that geometrically intersect the given rectangle will be returned.</p> <p>The x/y values should be in the same coordinate system as the layer as a whole (as returned by <a class="el" href="classOGRLayer.html#a75c06b4993f8eb76b569f37365cd19ab" title="Fetch the spatial reference system for this layer. ">OGRLayer::GetSpatialRef()</a>). Internally this method is normally implemented as creating a 5 vertex closed rectangular polygon and passing it to <a class="el" href="classOGRLayer.html#a0b4ab45cf97cbc470f0d60474d3e4169" title="Set a new spatial filter. ">OGRLayer::SetSpatialFilter()</a>. It exists as a convenience.</p> <p>The only way to clear a spatial filter set with this method is to call OGRLayer::SetSpatialFilter(NULL).</p> <p>This method is the same as the C function OGR_L_SetSpatialFilterRect().</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">dfMinX</td><td>the minimum X coordinate for the rectangular region. </td></tr> <tr><td class="paramname">dfMinY</td><td>the minimum Y coordinate for the rectangular region. </td></tr> <tr><td class="paramname">dfMaxX</td><td>the maximum X coordinate for the rectangular region. </td></tr> <tr><td class="paramname">dfMaxY</td><td>the maximum Y coordinate for the rectangular region. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a5cd4ceb8f4ec20594be63280c8e4498a"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void OGRLayer::SetSpatialFilterRect </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>iGeomField</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">double </td> <td class="paramname"><em>dfMinX</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">double </td> <td class="paramname"><em>dfMinY</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">double </td> <td class="paramname"><em>dfMaxX</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">double </td> <td class="paramname"><em>dfMaxY</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Set a new rectangular spatial filter. </p> <p>This method set rectangle to be used as a spatial filter when fetching features via the <a class="el" href="classOGRLayer.html#a47d21ff33b32d14fa4e9885b9edecad6" title="Fetch the next available feature from this layer. ">GetNextFeature()</a> method. Only features that geometrically intersect the given rectangle will be returned.</p> <p>The x/y values should be in the same coordinate system as as the geometry field definition it corresponds to (as returned by <a class="el" href="classOGRLayer.html#a80473bcfd11341e70dd35bebe94026cf" title="Fetch the schema information for this layer. ">GetLayerDefn()</a>->GetGeomFieldDefn(iGeomField)-><a class="el" href="classOGRLayer.html#a75c06b4993f8eb76b569f37365cd19ab" title="Fetch the spatial reference system for this layer. ">GetSpatialRef()</a>). Internally this method is normally implemented as creating a 5 vertex closed rectangular polygon and passing it to <a class="el" href="classOGRLayer.html#a0b4ab45cf97cbc470f0d60474d3e4169" title="Set a new spatial filter. ">OGRLayer::SetSpatialFilter()</a>. It exists as a convenience.</p> <p>The only way to clear a spatial filter set with this method is to call OGRLayer::SetSpatialFilter(NULL).</p> <p>This method is the same as the C function OGR_L_SetSpatialFilterRectEx().</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">iGeomField</td><td>index of the geometry field on which the spatial filter operates. </td></tr> <tr><td class="paramname">dfMinX</td><td>the minimum X coordinate for the rectangular region. </td></tr> <tr><td class="paramname">dfMinY</td><td>the minimum Y coordinate for the rectangular region. </td></tr> <tr><td class="paramname">dfMaxX</td><td>the maximum X coordinate for the rectangular region. </td></tr> <tr><td class="paramname">dfMaxY</td><td>the maximum Y coordinate for the rectangular region.</td></tr> </table> </dd> </dl> <dl class="section since"><dt>Since</dt><dd>GDAL 1.11 </dd></dl> </div> </div> <a class="anchor" id="a33fa0802c0686fb0e6ca6337e11cd7d5"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void OGRLayer::SetStyleTable </td> <td>(</td> <td class="paramtype">OGRStyleTable * </td> <td class="paramname"><em>poStyleTable</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Set layer style table. </p> <p>This method operate exactly as <a class="el" href="classOGRLayer.html#a2687d4312c044bb3a20bd13974ba8905" title="Set layer style table. ">OGRLayer::SetStyleTableDirectly()</a> except that it does not assume ownership of the passed table.</p> <p>This method is the same as the C function OGR_L_SetStyleTable().</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">poStyleTable</td><td>pointer to style table to set </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a2687d4312c044bb3a20bd13974ba8905"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void OGRLayer::SetStyleTableDirectly </td> <td>(</td> <td class="paramtype">OGRStyleTable * </td> <td class="paramname"><em>poStyleTable</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Set layer style table. </p> <p>This method operate exactly as <a class="el" href="classOGRLayer.html#a33fa0802c0686fb0e6ca6337e11cd7d5" title="Set layer style table. ">OGRLayer::SetStyleTable()</a> except that it assumes ownership of the passed table.</p> <p>This method is the same as the C function OGR_L_SetStyleTableDirectly().</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">poStyleTable</td><td>pointer to style table to set </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="aebb07284c734e485d8611b7c8599254f"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">OGRErr OGRLayer::SyncToDisk </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Flush pending changes to disk. </p> <p>This call is intended to force the layer to flush any pending writes to disk, and leave the disk file in a consistent state. It would not normally have any effect on read-only datasources.</p> <p>Some layers do not implement this method, and will still return OGRERR_NONE. The default implementation just returns OGRERR_NONE. An error is only returned if an error occurs while attempting to flush to disk.</p> <p>In any event, you should always close any opened datasource with <a class="el" href="classOGRDataSource.html#a77841576d07b24a01208e4125ccb40a5" title="Closes opened datasource and releases allocated resources. ">OGRDataSource::DestroyDataSource()</a> that will ensure all data is correctly flushed.</p> <p>This method is the same as the C function OGR_L_SyncToDisk().</p> <dl class="section return"><dt>Returns</dt><dd>OGRERR_NONE if no error occurs (even if nothing is done) or an error code. </dd></dl> </div> </div> <a class="anchor" id="aeedbda1a62f9b89b8e5f24332cf22286"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">int OGRLayer::TestCapability </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>pszCap</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Test if this layer supported the named capability. </p> <p>The capability codes that can be tested are represented as strings, but #defined constants exists to ensure correct spelling. Specific layer types may implement class specific capabilities, but this can't generally be discovered by the caller. </p> <ul> <li> <p class="startli"><b>OLCRandomRead</b> / "RandomRead": TRUE if the <a class="el" href="classOGRLayer.html#acb7625383f161e5a04aeea2173dce411" title="Fetch a feature by its identifier. ">GetFeature()</a> method is implemented in an optimized way for this layer, as opposed to the default implementation using <a class="el" href="classOGRLayer.html#aad0f2cd7f0587584b8f382c6a913583c" title="Reset feature reading to start on the first feature. ">ResetReading()</a> and <a class="el" href="classOGRLayer.html#a47d21ff33b32d14fa4e9885b9edecad6" title="Fetch the next available feature from this layer. ">GetNextFeature()</a> to find the requested feature id.</p> <p></p> <p class="endli"></p> </li> <li> <p class="startli"><b>OLCSequentialWrite</b> / "SequentialWrite": TRUE if the <a class="el" href="classOGRLayer.html#aaa1e32016f481596a55e1d988a15a067" title="Create and write a new feature within a layer. ">CreateFeature()</a> method works for this layer. Note this means that this particular layer is writable. The same <a class="el" href="classOGRLayer.html">OGRLayer</a> class may returned FALSE for other layer instances that are effectively read-only.</p> <p></p> <p class="endli"></p> </li> <li> <p class="startli"><b>OLCRandomWrite</b> / "RandomWrite": TRUE if the <a class="el" href="classOGRLayer.html#a681139bfd585b74d7218e51a32144283" title="Rewrite an existing feature. ">SetFeature()</a> method is operational on this layer. Note this means that this particular layer is writable. The same <a class="el" href="classOGRLayer.html">OGRLayer</a> class may returned FALSE for other layer instances that are effectively read-only.</p> <p></p> <p class="endli"></p> </li> <li> <p class="startli"><b>OLCFastSpatialFilter</b> / "FastSpatialFilter": TRUE if this layer implements spatial filtering efficiently. Layers that effectively read all features, and test them with the OGRFeature intersection methods should return FALSE. This can be used as a clue by the application whether it should build and maintain its own spatial index for features in this layer.</p> <p></p> <p class="endli"></p> </li> <li> <p class="startli"><b>OLCFastFeatureCount</b> / "FastFeatureCount": TRUE if this layer can return a feature count (via <a class="el" href="classOGRLayer.html#a74c796d4ce712e9a78df6042eeb8a91a" title="Fetch the feature count in this layer. ">GetFeatureCount()</a>) efficiently ... ie. without counting the features. In some cases this will return TRUE until a spatial filter is installed after which it will return FALSE.</p> <p></p> <p class="endli"></p> </li> <li> <p class="startli"><b>OLCFastGetExtent</b> / "FastGetExtent": TRUE if this layer can return its data extent (via <a class="el" href="classOGRLayer.html#a3be658ddb5b33d1ed95c31286774bbd2" title="Fetch the extent of this layer. ">GetExtent()</a>) efficiently ... ie. without scanning all the features. In some cases this will return TRUE until a spatial filter is installed after which it will return FALSE.</p> <p></p> <p class="endli"></p> </li> <li> <p class="startli"><b>OLCFastSetNextByIndex</b> / "FastSetNextByIndex": TRUE if this layer can perform the <a class="el" href="classOGRLayer.html#ae3b6234d6077a18a19eddaf7e75ff5e1" title="Move read cursor to the nIndex'th feature in the current resultset. ">SetNextByIndex()</a> call efficiently, otherwise FALSE.</p> <p></p> <p class="endli"></p> </li> <li> <p class="startli"><b>OLCCreateField</b> / "CreateField": TRUE if this layer can create new fields on the current layer using <a class="el" href="classOGRLayer.html#a00b1376a1eabb1298ef278f92f6d84be" title="Create a new field on a layer. ">CreateField()</a>, otherwise FALSE.</p> <p></p> <p class="endli"></p> </li> <li> <p class="startli"><b>OLCCreateGeomField</b> / "CreateGeomField": (GDAL >= 1.11) TRUE if this layer can create new geometry fields on the current layer using <a class="el" href="classOGRLayer.html#af3c68cad279ad80a476c6fb307cf5e48" title="Create a new geometry field on a layer. ">CreateGeomField()</a>, otherwise FALSE.</p> <p></p> <p class="endli"></p> </li> <li> <p class="startli"><b>OLCDeleteField</b> / "DeleteField": TRUE if this layer can delete existing fields on the current layer using <a class="el" href="classOGRLayer.html#aaebe7c671dca995549543eecf0f7a76a" title="Delete an existing field on a layer. ">DeleteField()</a>, otherwise FALSE.</p> <p></p> <p class="endli"></p> </li> <li> <p class="startli"><b>OLCReorderFields</b> / "ReorderFields": TRUE if this layer can reorder existing fields on the current layer using <a class="el" href="classOGRLayer.html#ab4c02b991bfa78552eeb0cbcdcf1aed8" title="Reorder an existing field on a layer. ">ReorderField()</a> or <a class="el" href="classOGRLayer.html#aebd364a150d91f8d65d967646e0f92d3" title="Reorder all the fields of a layer. ">ReorderFields()</a>, otherwise FALSE.</p> <p></p> <p class="endli"></p> </li> <li> <p class="startli"><b>OLCAlterFieldDefn</b> / "AlterFieldDefn": TRUE if this layer can alter the definition of an existing field on the current layer using <a class="el" href="classOGRLayer.html#a71e69a665e93001d48a4339695f33c1a" title="Alter the definition of an existing field on a layer. ">AlterFieldDefn()</a>, otherwise FALSE.</p> <p></p> <p class="endli"></p> </li> <li> <p class="startli"><b>OLCDeleteFeature</b> / "DeleteFeature": TRUE if the <a class="el" href="classOGRLayer.html#a7e3d454d54a615a1b4359628bb6e7674" title="Delete feature from layer. ">DeleteFeature()</a> method is supported on this layer, otherwise FALSE.</p> <p></p> <p class="endli"></p> </li> <li> <p class="startli"><b>OLCStringsAsUTF8</b> / "StringsAsUTF8": TRUE if values of OFTString fields are assured to be in UTF-8 format. If FALSE the encoding of fields is uncertain, though it might still be UTF-8.</p> <p></p> <p class="endli"></p> </li> <li> <p class="startli"><b>OLCTransactions</b> / "Transactions": TRUE if the StartTransaction(), CommitTransaction() and RollbackTransaction() methods work in a meaningful way, otherwise FALSE.</p> <p></p> <p class="endli"></p> </li> <li> <p class="startli"><b>OLCIgnoreFields</b> / "IgnoreFields": TRUE if fields, geometry and style will be omitted when fetching features as set by <a class="el" href="classOGRLayer.html#a5e0c3427f64249d1c35cefb487546b10" title="Set which fields can be omitted when retrieving features from the layer. ">SetIgnoredFields()</a> method.</p> <p></p> <p></p> <p class="endli"></p> </li> </ul> <p>This method is the same as the C function OGR_L_TestCapability().</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">pszCap</td><td>the name of the capability to test.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>TRUE if the layer has the requested capability, or FALSE otherwise. OGRLayers will return FALSE for any unrecognised capabilities.</dd></dl> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="ogrsf__frmts_8h_source.html">ogrsf_frmts.h</a></li> <li>ogrsf_frmts.dox</li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.5 </small></address> </body> </html>