EVOLUTION-MANAGER
Edit File: classOGRFieldDefn.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>OGR: OGRFieldDefn 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="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">OGR </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.5 --> <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> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-static-methods">Static Public Member Functions</a> | <a href="classOGRFieldDefn-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">OGRFieldDefn Class Reference</div> </div> </div><!--header--> <div class="contents"> <p><code>#include <<a class="el" href="ogr__feature_8h_source.html">ogr_feature.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:afc375f038b548b5a86b854c214fee114"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRFieldDefn.html#afc375f038b548b5a86b854c214fee114">OGRFieldDefn</a> (const char *, <a class="el" href="ogr__core_8h.html#a787194bea637faf12d61643124a7c9fc">OGRFieldType</a>)</td></tr> <tr class="memdesc:afc375f038b548b5a86b854c214fee114"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#afc375f038b548b5a86b854c214fee114">More...</a><br/></td></tr> <tr class="separator:afc375f038b548b5a86b854c214fee114"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae1a23eb2e7ec5d95f51e192a524d4fac"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRFieldDefn.html#ae1a23eb2e7ec5d95f51e192a524d4fac">OGRFieldDefn</a> (<a class="el" href="classOGRFieldDefn.html">OGRFieldDefn</a> *)</td></tr> <tr class="memdesc:ae1a23eb2e7ec5d95f51e192a524d4fac"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#ae1a23eb2e7ec5d95f51e192a524d4fac">More...</a><br/></td></tr> <tr class="separator:ae1a23eb2e7ec5d95f51e192a524d4fac"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a241585cd66a38311aa0322f34e6d5214"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRFieldDefn.html#a241585cd66a38311aa0322f34e6d5214">SetName</a> (const char *)</td></tr> <tr class="memdesc:a241585cd66a38311aa0322f34e6d5214"><td class="mdescLeft"> </td><td class="mdescRight">Reset the name of this field. <a href="#a241585cd66a38311aa0322f34e6d5214">More...</a><br/></td></tr> <tr class="separator:a241585cd66a38311aa0322f34e6d5214"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7754d32a36e4ba854f71f511a5ca7740"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRFieldDefn.html#a7754d32a36e4ba854f71f511a5ca7740">GetNameRef</a> ()</td></tr> <tr class="memdesc:a7754d32a36e4ba854f71f511a5ca7740"><td class="mdescLeft"> </td><td class="mdescRight">Fetch name of this field. <a href="#a7754d32a36e4ba854f71f511a5ca7740">More...</a><br/></td></tr> <tr class="separator:a7754d32a36e4ba854f71f511a5ca7740"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac59789eed0b750d05f8ce8b6a8c68dfb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="ogr__core_8h.html#a787194bea637faf12d61643124a7c9fc">OGRFieldType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRFieldDefn.html#ac59789eed0b750d05f8ce8b6a8c68dfb">GetType</a> ()</td></tr> <tr class="memdesc:ac59789eed0b750d05f8ce8b6a8c68dfb"><td class="mdescLeft"> </td><td class="mdescRight">Fetch type of this field. <a href="#ac59789eed0b750d05f8ce8b6a8c68dfb">More...</a><br/></td></tr> <tr class="separator:ac59789eed0b750d05f8ce8b6a8c68dfb"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a26bf22b7d805b9e33dd5c5fe9b4a8363"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRFieldDefn.html#a26bf22b7d805b9e33dd5c5fe9b4a8363">SetType</a> (<a class="el" href="ogr__core_8h.html#a787194bea637faf12d61643124a7c9fc">OGRFieldType</a> eTypeIn)</td></tr> <tr class="memdesc:a26bf22b7d805b9e33dd5c5fe9b4a8363"><td class="mdescLeft"> </td><td class="mdescRight">Set the type of this field. This should never be done to an <a class="el" href="classOGRFieldDefn.html">OGRFieldDefn</a> that is already part of an <a class="el" href="classOGRFeatureDefn.html">OGRFeatureDefn</a>. <a href="#a26bf22b7d805b9e33dd5c5fe9b4a8363">More...</a><br/></td></tr> <tr class="separator:a26bf22b7d805b9e33dd5c5fe9b4a8363"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a40f6520b0638571f8acf32b2c436231f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="ogr__core_8h.html#a701976be938cd60a2fa96454f61d3600">OGRJustification</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRFieldDefn.html#a40f6520b0638571f8acf32b2c436231f">GetJustify</a> ()</td></tr> <tr class="memdesc:a40f6520b0638571f8acf32b2c436231f"><td class="mdescLeft"> </td><td class="mdescRight">Get the justification for this field. <a href="#a40f6520b0638571f8acf32b2c436231f">More...</a><br/></td></tr> <tr class="separator:a40f6520b0638571f8acf32b2c436231f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:acbd783e3b61ab388eab3f45c25cf1bc0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRFieldDefn.html#acbd783e3b61ab388eab3f45c25cf1bc0">SetJustify</a> (<a class="el" href="ogr__core_8h.html#a701976be938cd60a2fa96454f61d3600">OGRJustification</a> eJustifyIn)</td></tr> <tr class="memdesc:acbd783e3b61ab388eab3f45c25cf1bc0"><td class="mdescLeft"> </td><td class="mdescRight">Set the justification for this field. <a href="#acbd783e3b61ab388eab3f45c25cf1bc0">More...</a><br/></td></tr> <tr class="separator:acbd783e3b61ab388eab3f45c25cf1bc0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a3aca8d59291beed0ccfe2e05a187bcb1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRFieldDefn.html#a3aca8d59291beed0ccfe2e05a187bcb1">GetWidth</a> ()</td></tr> <tr class="memdesc:a3aca8d59291beed0ccfe2e05a187bcb1"><td class="mdescLeft"> </td><td class="mdescRight">Get the formatting width for this field. <a href="#a3aca8d59291beed0ccfe2e05a187bcb1">More...</a><br/></td></tr> <tr class="separator:a3aca8d59291beed0ccfe2e05a187bcb1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa793194c45ccba5ec7e9f7aea49dc6f3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRFieldDefn.html#aa793194c45ccba5ec7e9f7aea49dc6f3">SetWidth</a> (int nWidthIn)</td></tr> <tr class="memdesc:aa793194c45ccba5ec7e9f7aea49dc6f3"><td class="mdescLeft"> </td><td class="mdescRight">Set the formatting width for this field in characters. <a href="#aa793194c45ccba5ec7e9f7aea49dc6f3">More...</a><br/></td></tr> <tr class="separator:aa793194c45ccba5ec7e9f7aea49dc6f3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a704a3aa995e9ee44b369aff7f1e065a5"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRFieldDefn.html#a704a3aa995e9ee44b369aff7f1e065a5">GetPrecision</a> ()</td></tr> <tr class="memdesc:a704a3aa995e9ee44b369aff7f1e065a5"><td class="mdescLeft"> </td><td class="mdescRight">Get the formatting precision for this field. This should normally be zero for fields of types other than OFTReal. <a href="#a704a3aa995e9ee44b369aff7f1e065a5">More...</a><br/></td></tr> <tr class="separator:a704a3aa995e9ee44b369aff7f1e065a5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:abea88d3ed96c46b4f0eda415460f8664"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRFieldDefn.html#abea88d3ed96c46b4f0eda415460f8664">SetPrecision</a> (int nPrecisionIn)</td></tr> <tr class="memdesc:abea88d3ed96c46b4f0eda415460f8664"><td class="mdescLeft"> </td><td class="mdescRight">Set the formatting precision for this field in characters. <a href="#abea88d3ed96c46b4f0eda415460f8664">More...</a><br/></td></tr> <tr class="separator:abea88d3ed96c46b4f0eda415460f8664"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9b08b348f111ecbfe2970b312d9ce54b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRFieldDefn.html#a9b08b348f111ecbfe2970b312d9ce54b">Set</a> (const char *, <a class="el" href="ogr__core_8h.html#a787194bea637faf12d61643124a7c9fc">OGRFieldType</a>, int=0, int=0, <a class="el" href="ogr__core_8h.html#a701976be938cd60a2fa96454f61d3600">OGRJustification</a>=OJUndefined)</td></tr> <tr class="memdesc:a9b08b348f111ecbfe2970b312d9ce54b"><td class="mdescLeft"> </td><td class="mdescRight">Set defining parameters for a field in one call. <a href="#a9b08b348f111ecbfe2970b312d9ce54b">More...</a><br/></td></tr> <tr class="separator:a9b08b348f111ecbfe2970b312d9ce54b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1e8863611c93c09bd5d922e1b859670d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRFieldDefn.html#a1e8863611c93c09bd5d922e1b859670d">SetDefault</a> (const <a class="el" href="unionOGRField.html">OGRField</a> *)</td></tr> <tr class="memdesc:a1e8863611c93c09bd5d922e1b859670d"><td class="mdescLeft"> </td><td class="mdescRight">Set default field value. <a href="#a1e8863611c93c09bd5d922e1b859670d">More...</a><br/></td></tr> <tr class="separator:a1e8863611c93c09bd5d922e1b859670d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7cdd15cda075af9fd4178b927743aa07"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRFieldDefn.html#a7cdd15cda075af9fd4178b927743aa07">IsIgnored</a> ()</td></tr> <tr class="memdesc:a7cdd15cda075af9fd4178b927743aa07"><td class="mdescLeft"> </td><td class="mdescRight">Return whether this field should be omitted when fetching features. <a href="#a7cdd15cda075af9fd4178b927743aa07">More...</a><br/></td></tr> <tr class="separator:a7cdd15cda075af9fd4178b927743aa07"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad194ad748a62ec40b772a7ded173c367"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRFieldDefn.html#ad194ad748a62ec40b772a7ded173c367">SetIgnored</a> (int bIgnore)</td></tr> <tr class="memdesc:ad194ad748a62ec40b772a7ded173c367"><td class="mdescLeft"> </td><td class="mdescRight">Set whether this field should be omitted when fetching features. <a href="#ad194ad748a62ec40b772a7ded173c367">More...</a><br/></td></tr> <tr class="separator:ad194ad748a62ec40b772a7ded173c367"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9660ad0b4ba3b639ab0d6ff28800ac98"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRFieldDefn.html#a9660ad0b4ba3b639ab0d6ff28800ac98">IsSame</a> (const <a class="el" href="classOGRFieldDefn.html">OGRFieldDefn</a> *) const </td></tr> <tr class="memdesc:a9660ad0b4ba3b639ab0d6ff28800ac98"><td class="mdescLeft"> </td><td class="mdescRight">Test if the field definition is identical to the other one. <a href="#a9660ad0b4ba3b639ab0d6ff28800ac98">More...</a><br/></td></tr> <tr class="separator:a9660ad0b4ba3b639ab0d6ff28800ac98"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> Static Public Member Functions</h2></td></tr> <tr class="memitem:afc2a020f72be8296b6e09f5ab979f930"><td class="memItemLeft" align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRFieldDefn.html#afc2a020f72be8296b6e09f5ab979f930">GetFieldTypeName</a> (<a class="el" href="ogr__core_8h.html#a787194bea637faf12d61643124a7c9fc">OGRFieldType</a>)</td></tr> <tr class="memdesc:afc2a020f72be8296b6e09f5ab979f930"><td class="mdescLeft"> </td><td class="mdescRight">Fetch human readable name for a field type. <a href="#afc2a020f72be8296b6e09f5ab979f930">More...</a><br/></td></tr> <tr class="separator:afc2a020f72be8296b6e09f5ab979f930"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Definition of an attribute of an <a class="el" href="classOGRFeatureDefn.html">OGRFeatureDefn</a>. </p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="afc375f038b548b5a86b854c214fee114"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">OGRFieldDefn::OGRFieldDefn </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>pszNameIn</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="ogr__core_8h.html#a787194bea637faf12d61643124a7c9fc">OGRFieldType</a> </td> <td class="paramname"><em>eTypeIn</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Constructor. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">pszNameIn</td><td>the name of the new field. </td></tr> <tr><td class="paramname">eTypeIn</td><td>the type of the new field. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="ae1a23eb2e7ec5d95f51e192a524d4fac"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">OGRFieldDefn::OGRFieldDefn </td> <td>(</td> <td class="paramtype"><a class="el" href="classOGRFieldDefn.html">OGRFieldDefn</a> * </td> <td class="paramname"><em>poPrototype</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Constructor. </p> <p>Create by cloning an existing field definition.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">poPrototype</td><td>the field definition to clone. </td></tr> </table> </dd> </dl> <p>References <a class="el" href="classOGRFieldDefn.html#a40f6520b0638571f8acf32b2c436231f">GetJustify()</a>, <a class="el" href="classOGRFieldDefn.html#a7754d32a36e4ba854f71f511a5ca7740">GetNameRef()</a>, <a class="el" href="classOGRFieldDefn.html#a704a3aa995e9ee44b369aff7f1e065a5">GetPrecision()</a>, <a class="el" href="classOGRFieldDefn.html#ac59789eed0b750d05f8ce8b6a8c68dfb">GetType()</a>, <a class="el" href="classOGRFieldDefn.html#a3aca8d59291beed0ccfe2e05a187bcb1">GetWidth()</a>, <a class="el" href="classOGRFieldDefn.html#acbd783e3b61ab388eab3f45c25cf1bc0">SetJustify()</a>, <a class="el" href="classOGRFieldDefn.html#abea88d3ed96c46b4f0eda415460f8664">SetPrecision()</a>, and <a class="el" href="classOGRFieldDefn.html#aa793194c45ccba5ec7e9f7aea49dc6f3">SetWidth()</a>.</p> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="afc2a020f72be8296b6e09f5ab979f930"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const char * OGRFieldDefn::GetFieldTypeName </td> <td>(</td> <td class="paramtype"><a class="el" href="ogr__core_8h.html#a787194bea637faf12d61643124a7c9fc">OGRFieldType</a> </td> <td class="paramname"><em>eType</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Fetch human readable name for a field type. </p> <p>This static method is the same as the C function <a class="el" href="ogr__api_8h.html#af1e61b89ae2d799cf5e217d01ef7b415" title="Fetch human readable name for a field type. ">OGR_GetFieldTypeName()</a>.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">eType</td><td>the field type to get name for.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>pointer to an internal static name string. It should not be modified or freed. </dd></dl> <p>References <a class="el" href="ogr__core_8h.html#a787194bea637faf12d61643124a7c9fca87c732175b3e99aeebca957ada1f6a2c">OFTBinary</a>, <a class="el" href="ogr__core_8h.html#a787194bea637faf12d61643124a7c9fca742f1a13593939558dd7f0083e78df27">OFTDate</a>, <a class="el" href="ogr__core_8h.html#a787194bea637faf12d61643124a7c9fcac88631a8d99c78b5df17f971b8304239">OFTDateTime</a>, <a class="el" href="ogr__core_8h.html#a787194bea637faf12d61643124a7c9fca81294535b47252b1da0274f178420ae4">OFTInteger</a>, <a class="el" href="ogr__core_8h.html#a787194bea637faf12d61643124a7c9fca6406fce5e1937d3092f587ed83aff009">OFTIntegerList</a>, <a class="el" href="ogr__core_8h.html#a787194bea637faf12d61643124a7c9fca99520e47d9e26303f7c0127c1254c962">OFTReal</a>, <a class="el" href="ogr__core_8h.html#a787194bea637faf12d61643124a7c9fca8d1dd6b4ecafa6fdc552de07a2e612a7">OFTRealList</a>, <a class="el" href="ogr__core_8h.html#a787194bea637faf12d61643124a7c9fca862a7b8506c67c5390c2e0860c4edf45">OFTString</a>, <a class="el" href="ogr__core_8h.html#a787194bea637faf12d61643124a7c9fcac29f48b1251f60a6e6eb1bb66dc75ad2">OFTStringList</a>, and <a class="el" href="ogr__core_8h.html#a787194bea637faf12d61643124a7c9fca30c4c3e7adec85f189b4a025efa6725f">OFTTime</a>.</p> <p>Referenced by <a class="el" href="classOGRFeature.html#a6c787aeb650bd03420309ca4f52c0083">OGRFeature::DumpReadable()</a>, and <a class="el" href="ogr__api_8h.html#af1e61b89ae2d799cf5e217d01ef7b415">OGR_GetFieldTypeName()</a>.</p> </div> </div> <a class="anchor" id="a40f6520b0638571f8acf32b2c436231f"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="ogr__core_8h.html#a701976be938cd60a2fa96454f61d3600">OGRJustification</a> OGRFieldDefn::GetJustify </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Get the justification for this field. </p> <p>This method is the same as the C function <a class="el" href="ogr__api_8h.html#a0cf8a09826e47763e6bf667af0dae1a7" title="Get the justification for this field. ">OGR_Fld_GetJustify()</a>.</p> <dl class="section return"><dt>Returns</dt><dd>the justification. </dd></dl> <p>Referenced by <a class="el" href="classOGRFieldDefn.html#ae1a23eb2e7ec5d95f51e192a524d4fac">OGRFieldDefn()</a>.</p> </div> </div> <a class="anchor" id="a7754d32a36e4ba854f71f511a5ca7740"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const char * OGRFieldDefn::GetNameRef </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Fetch name of this field. </p> <p>This method is the same as the C function <a class="el" href="ogr__api_8h.html#a8d7640a6b6a47a95d83415f9271ffe30" title="Fetch name of this field. ">OGR_Fld_GetNameRef()</a>.</p> <dl class="section return"><dt>Returns</dt><dd>pointer to an internal name string that should not be freed or modified. </dd></dl> <p>Referenced by <a class="el" href="classOGRDataSource.html#a42dc7f7f538cd4f083af350722fe53ae">OGRDataSource::CopyLayer()</a>, <a class="el" href="classOGRFeature.html#a6c787aeb650bd03420309ca4f52c0083">OGRFeature::DumpReadable()</a>, <a class="el" href="classOGRUnionLayer.html#a4c680d7e5c02454ea7361f341d6d54e9">OGRUnionLayer::GetLayerDefn()</a>, <a class="el" href="classOGRFieldDefn.html#ae1a23eb2e7ec5d95f51e192a524d4fac">OGRFieldDefn()</a>, <a class="el" href="classOGRFeature.html#a2d96b53563cf0c1ad7ada15170d9d75e">OGRFeature::SetField()</a>, and <a class="el" href="classOGRFeature.html#a8ebc0999c4bce0b5073add16598dfc77">OGRFeature::SetFrom()</a>.</p> </div> </div> <a class="anchor" id="a704a3aa995e9ee44b369aff7f1e065a5"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">int OGRFieldDefn::GetPrecision </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Get the formatting precision for this field. This should normally be zero for fields of types other than OFTReal. </p> <p>This method is the same as the C function <a class="el" href="ogr__api_8h.html#a120dd56ee23070922e4d84ed06b06e27" title="Get the formatting precision for this field. This should normally be zero for fields of types other t...">OGR_Fld_GetPrecision()</a>.</p> <dl class="section return"><dt>Returns</dt><dd>the precision. </dd></dl> <p>Referenced by <a class="el" href="classOGRFeature.html#ac7a0224e13dce1f9479a6bf2111ea766">OGRFeature::GetFieldAsString()</a>, and <a class="el" href="classOGRFieldDefn.html#ae1a23eb2e7ec5d95f51e192a524d4fac">OGRFieldDefn()</a>.</p> </div> </div> <a class="anchor" id="ac59789eed0b750d05f8ce8b6a8c68dfb"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="ogr__core_8h.html#a787194bea637faf12d61643124a7c9fc">OGRFieldType</a> OGRFieldDefn::GetType </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Fetch type of this field. </p> <p>This method is the same as the C function <a class="el" href="ogr__api_8h.html#ad8d150dfc678e0a2a7f5241ba38c5611" title="Fetch type of this field. ">OGR_Fld_GetType()</a>.</p> <dl class="section return"><dt>Returns</dt><dd>field type. </dd></dl> <p>Referenced by <a class="el" href="classOGRFeature.html#a6c787aeb650bd03420309ca4f52c0083">OGRFeature::DumpReadable()</a>, <a class="el" href="classOGRFeature.html#a738dfd54ecb6fb86e294929e91f90479">OGRFeature::Equal()</a>, <a class="el" href="classOGRFeature.html#a0262d9d3f0f9e18a1e2101e1972aebae">OGRFeature::GetFieldAsBinary()</a>, <a class="el" href="classOGRFeature.html#a6c5d2444407b07e07b79863c42ee7a49">OGRFeature::GetFieldAsDateTime()</a>, <a class="el" href="classOGRFeature.html#ab8a57c94e8bb8ffac5e7048d896254b4">OGRFeature::GetFieldAsDouble()</a>, <a class="el" href="classOGRFeature.html#a8f799b9e9e44af526659b646bbfda870">OGRFeature::GetFieldAsDoubleList()</a>, <a class="el" href="classOGRFeature.html#add319b68ea27a4ee0602d3aa460ca3b5">OGRFeature::GetFieldAsInteger()</a>, <a class="el" href="classOGRFeature.html#a3f153cf4e2e6513b7df60f46ae8440bd">OGRFeature::GetFieldAsIntegerList()</a>, <a class="el" href="classOGRFeature.html#ac7a0224e13dce1f9479a6bf2111ea766">OGRFeature::GetFieldAsString()</a>, <a class="el" href="classOGRFeature.html#ac142f8ba9929f6c89133adbcbff39945">OGRFeature::GetFieldAsStringList()</a>, <a class="el" href="classOGRFieldDefn.html#ae1a23eb2e7ec5d95f51e192a524d4fac">OGRFieldDefn()</a>, <a class="el" href="classOGRFeature.html#a4abbe118cc2f3e48bbac7f710b71b531">OGRFeature::SetField()</a>, <a class="el" href="classOGRFeature.html#a6705e5ff8b1012ce4a687b973ecddf73">OGRFeature::SetFieldsFrom()</a>, and <a class="el" href="classOGRFeature.html#a937b21e0137e40bc1473f354879975da">OGRFeature::UnsetField()</a>.</p> </div> </div> <a class="anchor" id="a3aca8d59291beed0ccfe2e05a187bcb1"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">int OGRFieldDefn::GetWidth </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Get the formatting width for this field. </p> <p>This method is the same as the C function <a class="el" href="ogr__api_8h.html#aa6500186e3f22761a615428c55bba0ce" title="Get the formatting width for this field. ">OGR_Fld_GetWidth()</a>.</p> <dl class="section return"><dt>Returns</dt><dd>the width, zero means no specified width. </dd></dl> <p>Referenced by <a class="el" href="classOGRFeature.html#ac7a0224e13dce1f9479a6bf2111ea766">OGRFeature::GetFieldAsString()</a>, and <a class="el" href="classOGRFieldDefn.html#ae1a23eb2e7ec5d95f51e192a524d4fac">OGRFieldDefn()</a>.</p> </div> </div> <a class="anchor" id="a7cdd15cda075af9fd4178b927743aa07"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">int OGRFieldDefn::IsIgnored </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Return whether this field should be omitted when fetching features. </p> <p>This method is the same as the C function <a class="el" href="ogr__api_8h.html#a29bec35ae5a4c232ad850315bdc2b675" title="Return whether this field should be omitted when fetching features. ">OGR_Fld_IsIgnored()</a>.</p> <dl class="section return"><dt>Returns</dt><dd>ignore state </dd></dl> </div> </div> <a class="anchor" id="a9660ad0b4ba3b639ab0d6ff28800ac98"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int OGRFieldDefn::IsSame </td> <td>(</td> <td class="paramtype">const <a class="el" href="classOGRFieldDefn.html">OGRFieldDefn</a> * </td> <td class="paramname"><em>poOtherFieldDefn</em></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Test if the field definition is identical to the other one. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">poOtherFieldDefn</td><td>the other field definition to compare to. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>TRUE if the field definition is identical to the other one. </dd></dl> <p>Referenced by <a class="el" href="classOGRFeatureDefn.html#a89662e5a2e89edbce422b5e05c4ecfde">OGRFeatureDefn::IsSame()</a>.</p> </div> </div> <a class="anchor" id="a9b08b348f111ecbfe2970b312d9ce54b"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void OGRFieldDefn::Set </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>pszNameIn</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="ogr__core_8h.html#a787194bea637faf12d61643124a7c9fc">OGRFieldType</a> </td> <td class="paramname"><em>eTypeIn</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>nWidthIn</em> = <code>0</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>nPrecisionIn</em> = <code>0</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="ogr__core_8h.html#a701976be938cd60a2fa96454f61d3600">OGRJustification</a> </td> <td class="paramname"><em>eJustifyIn</em> = <code>OJUndefined</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Set defining parameters for a field in one call. </p> <p>This method is the same as the C function <a class="el" href="ogr__api_8h.html#a5922e599fe8746b81adf251be6b5ecf0" title="Set defining parameters for a field in one call. ">OGR_Fld_Set()</a>.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">pszNameIn</td><td>the new name to assign. </td></tr> <tr><td class="paramname">eTypeIn</td><td>the new type (one of the OFT values like OFTInteger). </td></tr> <tr><td class="paramname">nWidthIn</td><td>the preferred formatting width. Defaults to zero indicating undefined. </td></tr> <tr><td class="paramname">nPrecisionIn</td><td>number of decimals places for formatting, defaults to zero indicating undefined. </td></tr> <tr><td class="paramname">eJustifyIn</td><td>the formatting justification (OJLeft or OJRight), defaults to OJUndefined. </td></tr> </table> </dd> </dl> <p>References <a class="el" href="classOGRFieldDefn.html#acbd783e3b61ab388eab3f45c25cf1bc0">SetJustify()</a>, <a class="el" href="classOGRFieldDefn.html#a241585cd66a38311aa0322f34e6d5214">SetName()</a>, <a class="el" href="classOGRFieldDefn.html#abea88d3ed96c46b4f0eda415460f8664">SetPrecision()</a>, <a class="el" href="classOGRFieldDefn.html#a26bf22b7d805b9e33dd5c5fe9b4a8363">SetType()</a>, and <a class="el" href="classOGRFieldDefn.html#aa793194c45ccba5ec7e9f7aea49dc6f3">SetWidth()</a>.</p> </div> </div> <a class="anchor" id="a1e8863611c93c09bd5d922e1b859670d"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void OGRFieldDefn::SetDefault </td> <td>(</td> <td class="paramtype">const <a class="el" href="unionOGRField.html">OGRField</a> * </td> <td class="paramname"><em>puDefaultIn</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Set default field value. </p> <p>Currently use of <a class="el" href="classOGRFieldDefn.html">OGRFieldDefn</a> "defaults" is discouraged. This feature may be fleshed out in the future. </p> <p>References <a class="el" href="ogr__core_8h.html#a787194bea637faf12d61643124a7c9fca81294535b47252b1da0274f178420ae4">OFTInteger</a>, <a class="el" href="ogr__core_8h.html#a787194bea637faf12d61643124a7c9fca99520e47d9e26303f7c0127c1254c962">OFTReal</a>, and <a class="el" href="ogr__core_8h.html#a787194bea637faf12d61643124a7c9fca862a7b8506c67c5390c2e0860c4edf45">OFTString</a>.</p> </div> </div> <a class="anchor" id="ad194ad748a62ec40b772a7ded173c367"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void OGRFieldDefn::SetIgnored </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>ignore</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Set whether this field should be omitted when fetching features. </p> <p>This method is the same as the C function <a class="el" href="ogr__api_8h.html#aeddf9aa9767cd28c90dc66ed2a7a7332" title="Set whether this field should be omitted when fetching features. ">OGR_Fld_SetIgnored()</a>.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ignore</td><td>ignore state </td></tr> </table> </dd> </dl> <p>Referenced by <a class="el" href="classOGRLayer.html#a5e0c3427f64249d1c35cefb487546b10">OGRLayer::SetIgnoredFields()</a>.</p> </div> </div> <a class="anchor" id="acbd783e3b61ab388eab3f45c25cf1bc0"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void OGRFieldDefn::SetJustify </td> <td>(</td> <td class="paramtype"><a class="el" href="ogr__core_8h.html#a701976be938cd60a2fa96454f61d3600">OGRJustification</a> </td> <td class="paramname"><em>eJustify</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Set the justification for this field. </p> <p>This method is the same as the C function <a class="el" href="ogr__api_8h.html#ae4809f2fe957002b8e18aacc1bdca240" title="Set the justification for this field. ">OGR_Fld_SetJustify()</a>.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">eJustify</td><td>the new justification. </td></tr> </table> </dd> </dl> <p>Referenced by <a class="el" href="classOGRFieldDefn.html#ae1a23eb2e7ec5d95f51e192a524d4fac">OGRFieldDefn()</a>, and <a class="el" href="classOGRFieldDefn.html#a9b08b348f111ecbfe2970b312d9ce54b">Set()</a>.</p> </div> </div> <a class="anchor" id="a241585cd66a38311aa0322f34e6d5214"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void OGRFieldDefn::SetName </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>pszNameIn</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Reset the name of this field. </p> <p>This method is the same as the C function <a class="el" href="ogr__api_8h.html#a6599fa42bad3aba26574ae3260c6984d" title="Reset the name of this field. ">OGR_Fld_SetName()</a>.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">pszNameIn</td><td>the new name to apply. </td></tr> </table> </dd> </dl> <p>References <a class="el" href="cpl__conv_8h.html#a464d6861faf9f6272317d160a3ad9a81">CPLStrdup()</a>.</p> <p>Referenced by <a class="el" href="classOGRFieldDefn.html#a9b08b348f111ecbfe2970b312d9ce54b">Set()</a>.</p> </div> </div> <a class="anchor" id="abea88d3ed96c46b4f0eda415460f8664"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void OGRFieldDefn::SetPrecision </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>nPrecision</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Set the formatting precision for this field in characters. </p> <p>This should normally be zero for fields of types other than OFTReal.</p> <p>This method is the same as the C function <a class="el" href="ogr__api_8h.html#a13890f01f7d7e57bcd07e23f3e2947da" title="Set the formatting precision for this field in characters. ">OGR_Fld_SetPrecision()</a>.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">nPrecision</td><td>the new precision. </td></tr> </table> </dd> </dl> <p>Referenced by <a class="el" href="classOGRFieldDefn.html#ae1a23eb2e7ec5d95f51e192a524d4fac">OGRFieldDefn()</a>, and <a class="el" href="classOGRFieldDefn.html#a9b08b348f111ecbfe2970b312d9ce54b">Set()</a>.</p> </div> </div> <a class="anchor" id="a26bf22b7d805b9e33dd5c5fe9b4a8363"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void OGRFieldDefn::SetType </td> <td>(</td> <td class="paramtype"><a class="el" href="ogr__core_8h.html#a787194bea637faf12d61643124a7c9fc">OGRFieldType</a> </td> <td class="paramname"><em>eType</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Set the type of this field. This should never be done to an <a class="el" href="classOGRFieldDefn.html">OGRFieldDefn</a> that is already part of an <a class="el" href="classOGRFeatureDefn.html">OGRFeatureDefn</a>. </p> <p>This method is the same as the C function <a class="el" href="ogr__api_8h.html#a76195990f814eb93e821c01ce0599a50" title="Set the type of this field. This should never be done to an OGRFieldDefn that is already part of an O...">OGR_Fld_SetType()</a>.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">eType</td><td>the new field type. </td></tr> </table> </dd> </dl> <p>Referenced by <a class="el" href="classOGRFieldDefn.html#a9b08b348f111ecbfe2970b312d9ce54b">Set()</a>.</p> </div> </div> <a class="anchor" id="aa793194c45ccba5ec7e9f7aea49dc6f3"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void OGRFieldDefn::SetWidth </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>nWidth</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Set the formatting width for this field in characters. </p> <p>This method is the same as the C function <a class="el" href="ogr__api_8h.html#a1d7bf7c14a299448efac58f7bf364326" title="Set the formatting width for this field in characters. ">OGR_Fld_SetWidth()</a>.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">nWidth</td><td>the new width. </td></tr> </table> </dd> </dl> <p>Referenced by <a class="el" href="classOGRFieldDefn.html#ae1a23eb2e7ec5d95f51e192a524d4fac">OGRFieldDefn()</a>, and <a class="el" href="classOGRFieldDefn.html#a9b08b348f111ecbfe2970b312d9ce54b">Set()</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="ogr__feature_8h_source.html">ogr_feature.h</a></li> <li>ogrfielddefn.cpp</li> </ul> </div><!-- contents --> <hr> Generated for GDAL by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.8.5. </body> </html>