EVOLUTION-MANAGER
Edit File: classDDFFieldDefn.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>ISO8211Lib: DDFFieldDefn 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">ISO8211Lib </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="classes.html"><span>Class Index</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="classDDFFieldDefn-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">DDFFieldDefn Class Reference</div> </div> </div><!--header--> <div class="contents"> <p><code>#include <<a class="el" href="iso8211_8h_source.html">iso8211.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:a1c6b2b5d8ff18cd527ed4e437161510a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDDFFieldDefn.html#a1c6b2b5d8ff18cd527ed4e437161510a">Dump</a> (FILE *fp)</td></tr> <tr class="separator:a1c6b2b5d8ff18cd527ed4e437161510a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a74b88cf7b76eea9fca01f3034a60a375"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDDFFieldDefn.html#a74b88cf7b76eea9fca01f3034a60a375">GetName</a> ()</td></tr> <tr class="separator:a74b88cf7b76eea9fca01f3034a60a375"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a4b40f35561f8a4e4d2d5442cca7a9058"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDDFFieldDefn.html#a4b40f35561f8a4e4d2d5442cca7a9058">GetDescription</a> ()</td></tr> <tr class="separator:a4b40f35561f8a4e4d2d5442cca7a9058"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab0aca50e5913eda6ae7f058ae3e20971"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classDDFFieldDefn.html#ab0aca50e5913eda6ae7f058ae3e20971">GetSubfieldCount</a> ()</td></tr> <tr class="separator:ab0aca50e5913eda6ae7f058ae3e20971"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae9e1df79781078301f83fd09f713e416"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classDDFSubfieldDefn.html">DDFSubfieldDefn</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDDFFieldDefn.html#ae9e1df79781078301f83fd09f713e416">GetSubfield</a> (int i)</td></tr> <tr class="separator:ae9e1df79781078301f83fd09f713e416"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8e885fce091d6388a24ad16aacb33c8f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classDDFSubfieldDefn.html">DDFSubfieldDefn</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDDFFieldDefn.html#a8e885fce091d6388a24ad16aacb33c8f">FindSubfieldDefn</a> (const char *)</td></tr> <tr class="separator:a8e885fce091d6388a24ad16aacb33c8f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5295aa3f4f6eadc4ae5deb5afb03b6f4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classDDFFieldDefn.html#a5295aa3f4f6eadc4ae5deb5afb03b6f4">GetFixedWidth</a> ()</td></tr> <tr class="separator:a5295aa3f4f6eadc4ae5deb5afb03b6f4"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0ac685789e23f809c70fd420d1eb69c6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classDDFFieldDefn.html#a0ac685789e23f809c70fd420d1eb69c6">IsRepeating</a> ()</td></tr> <tr class="separator:a0ac685789e23f809c70fd420d1eb69c6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab9a007019110ddd2bedc968a5a7ba0ff"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDDFFieldDefn.html#ab9a007019110ddd2bedc968a5a7ba0ff">SetRepeatingFlag</a> (int n)</td></tr> <tr class="separator:ab9a007019110ddd2bedc968a5a7ba0ff"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:abd26a6ecf4b1814dcf44399e7bc15e6e"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDDFFieldDefn.html#abd26a6ecf4b1814dcf44399e7bc15e6e">GetDefaultValue</a> (int *pnSize)</td></tr> <tr class="separator:abd26a6ecf4b1814dcf44399e7bc15e6e"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Information from the DDR defining one field. Note that just because a field is defined for a <a class="el" href="classDDFModule.html">DDFModule</a> doesn't mean that it actually occurs on any records in the module. DDFFieldDefns are normally just significant as containers of the DDFSubfieldDefns. </p> </div><h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a1c6b2b5d8ff18cd527ed4e437161510a"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void DDFFieldDefn::Dump </td> <td>(</td> <td class="paramtype">FILE * </td> <td class="paramname"><em>fp</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Write out field definition info to debugging file.</p> <p>A variety of information about this field definition, and all it's subfields is written to the give debugging file handle.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">fp</td><td>The standard io file handle to write to. ie. stderr </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a8e885fce091d6388a24ad16aacb33c8f"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classDDFSubfieldDefn.html">DDFSubfieldDefn</a> * DDFFieldDefn::FindSubfieldDefn </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>pszMnemonic</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Find a subfield definition by it's mnemonic tag.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">pszMnemonic</td><td>The name of the field.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>The subfield pointer, or NULL if there isn't any such subfield. </dd></dl> </div> </div> <a class="anchor" id="abd26a6ecf4b1814dcf44399e7bc15e6e"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">char * DDFFieldDefn::GetDefaultValue </td> <td>(</td> <td class="paramtype">int * </td> <td class="paramname"><em>pnSize</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Return default data for field instance. </p> </div> </div> <a class="anchor" id="a4b40f35561f8a4e4d2d5442cca7a9058"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const char* DDFFieldDefn::GetDescription </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 a longer descriptio of this field. </p> <dl class="section return"><dt>Returns</dt><dd>this is an internal copy and shouldn't be freed. </dd></dl> </div> </div> <a class="anchor" id="a5295aa3f4f6eadc4ae5deb5afb03b6f4"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">int DDFFieldDefn::GetFixedWidth </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 width of this field. This function isn't normally used by applications.</p> <dl class="section return"><dt>Returns</dt><dd>The width of the field in bytes, or zero if the field is not apparently of a fixed width. </dd></dl> </div> </div> <a class="anchor" id="a74b88cf7b76eea9fca01f3034a60a375"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const char* DDFFieldDefn::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">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Fetch a pointer to the field name (tag). </p> <dl class="section return"><dt>Returns</dt><dd>this is an internal copy and shouldn't be freed. </dd></dl> </div> </div> <a class="anchor" id="ae9e1df79781078301f83fd09f713e416"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classDDFSubfieldDefn.html">DDFSubfieldDefn</a> * DDFFieldDefn::GetSubfield </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>i</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Fetch a subfield by index.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">i</td><td>The index subfield index. (Between 0 and <a class="el" href="classDDFFieldDefn.html#ab0aca50e5913eda6ae7f058ae3e20971">GetSubfieldCount()</a>-1)</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>The subfield pointer, or NULL if the index is out of range. </dd></dl> </div> </div> <a class="anchor" id="ab0aca50e5913eda6ae7f058ae3e20971"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">int DDFFieldDefn::GetSubfieldCount </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 number of subfields. </p> </div> </div> <a class="anchor" id="a0ac685789e23f809c70fd420d1eb69c6"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">int DDFFieldDefn::IsRepeating </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 repeating flag. </p> <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classDDFField.html#af192de6f3189570fd6dfb31c8fd091ce">DDFField::GetRepeatCount()</a> </dd></dl> <dl class="section return"><dt>Returns</dt><dd>TRUE if the field is marked as repeating. </dd></dl> </div> </div> <a class="anchor" id="ab9a007019110ddd2bedc968a5a7ba0ff"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void DDFFieldDefn::SetRepeatingFlag </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>n</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>this is just for an S-57 hack for swedish data </p> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="iso8211_8h_source.html">iso8211.h</a></li> <li>ddffielddefn.cpp</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>