<!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"/>
<title>SDTS_AL: DDFField Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2-20100208 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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 class="tabs">
<ul>
<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>
<div class="contents">
<h1>DDFField Class Reference</h1><!-- doxytag: class="DDFField" -->
<p><code>#include <<a class="el" href="iso8211_8h_source.html">iso8211.h</a>></code></p>
<p><a href="classDDFField-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDDFField.html#ac4b9941d3d0ba357f8265b8e698b2f36">Dump</a> (FILE *fp)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDDFField.html#a778da0e37f57a48e1c39e4ee3cf1ca83">GetSubfieldData</a> (<a class="el" href="classDDFSubfieldDefn.html">DDFSubfieldDefn</a> *, int *=NULL, int=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDDFField.html#a1663390fe6bbb95a112ad9e5db46ad09">GetInstanceData</a> (int nInstance, int *pnSize)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDDFField.html#a1e7577f4577b917eaeb0fa06702367c4">GetData</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classDDFField.html#a10da0719702d80b6ce7a2ebc0a756483">GetDataSize</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classDDFField.html#af192de6f3189570fd6dfb31c8fd091ce">GetRepeatCount</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classDDFFieldDefn.html">DDFFieldDefn</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDDFField.html#ae2dc98dc9f24cd548a8b0c7461f4179d">GetFieldDefn</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This object represents one field in a <a class="el" href="classDDFRecord.html">DDFRecord</a>. This models an instance of the fields data, rather than it's data definition which is handled by the <a class="el" href="classDDFFieldDefn.html">DDFFieldDefn</a> class. Note that a <a class="el" href="classDDFField.html">DDFField</a> doesn't have DDFSubfield children as you would expect. To extract subfield values use <a class="el" href="classDDFField.html#a778da0e37f57a48e1c39e4ee3cf1ca83">GetSubfieldData()</a> to find the right data pointer and then use ExtractIntData(), ExtractFloatData() or ExtractStringData(). </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ac4b9941d3d0ba357f8265b8e698b2f36"></a><!-- doxytag: member="DDFField::Dump" ref="ac4b9941d3d0ba357f8265b8e698b2f36" args="(FILE *fp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DDFField::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 contents to debugging file.</p>
<p>A variety of information about this field, and all it's subfields is written to the given debugging file handle. Note that field definition information (ala <a class="el" href="classDDFFieldDefn.html">DDFFieldDefn</a>) isn't written.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>fp</em> </td><td>The standard io file handle to write to. ie. stderr </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a1e7577f4577b917eaeb0fa06702367c4"></a><!-- doxytag: member="DDFField::GetData" ref="a1e7577f4577b917eaeb0fa06702367c4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* DDFField::GetData </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the pointer to the entire data block for this record. This is an internal copy, and shouldn't be freed by the application. </p>
</div>
</div>
<a class="anchor" id="a10da0719702d80b6ce7a2ebc0a756483"></a><!-- doxytag: member="DDFField::GetDataSize" ref="a10da0719702d80b6ce7a2ebc0a756483" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int DDFField::GetDataSize </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the number of bytes in the data block returned by <a class="el" href="classDDFField.html#a1e7577f4577b917eaeb0fa06702367c4">GetData()</a>. </p>
</div>
</div>
<a class="anchor" id="ae2dc98dc9f24cd548a8b0c7461f4179d"></a><!-- doxytag: member="DDFField::GetFieldDefn" ref="ae2dc98dc9f24cd548a8b0c7461f4179d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classDDFFieldDefn.html">DDFFieldDefn</a>* DDFField::GetFieldDefn </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Fetch the corresponding <a class="el" href="classDDFFieldDefn.html">DDFFieldDefn</a>. </p>
</div>
</div>
<a class="anchor" id="a1663390fe6bbb95a112ad9e5db46ad09"></a><!-- doxytag: member="DDFField::GetInstanceData" ref="a1663390fe6bbb95a112ad9e5db46ad09" args="(int nInstance, int *pnSize)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * DDFField::GetInstanceData </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>nInstance</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"> <em>pnInstanceSize</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get field instance data and size.</p>
<p>The returned data pointer and size values are suitable for use with <a class="el" href="classDDFRecord.html#a6d4c805ce592dc1bc70e601858f4da1b">DDFRecord::SetFieldRaw()</a>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>nInstance</em> </td><td>a value from 0 to <a class="el" href="classDDFField.html#af192de6f3189570fd6dfb31c8fd091ce">GetRepeatCount()</a>-1. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pnInstanceSize</em> </td><td>a location to put the size (in bytes) of the field instance data returned. This size will include the unit terminator (if any), but not the field terminator. This size pointer may be NULL if not needed.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the data pointer, or NULL on error. </dd></dl>
</div>
</div>
<a class="anchor" id="af192de6f3189570fd6dfb31c8fd091ce"></a><!-- doxytag: member="DDFField::GetRepeatCount" ref="af192de6f3189570fd6dfb31c8fd091ce" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int DDFField::GetRepeatCount </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>How many times do the subfields of this record repeat? This will always be one for non-repeating fields.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of times that the subfields of this record occur in this record. This will be one for non-repeating fields.</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a href="example.html">8211view example program</a> for demonstation of handling repeated fields properly. </dd></dl>
</div>
</div>
<a class="anchor" id="a778da0e37f57a48e1c39e4ee3cf1ca83"></a><!-- doxytag: member="DDFField::GetSubfieldData" ref="a778da0e37f57a48e1c39e4ee3cf1ca83" args="(DDFSubfieldDefn *, int *=NULL, int=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * DDFField::GetSubfieldData </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classDDFSubfieldDefn.html">DDFSubfieldDefn</a> * </td>
<td class="paramname"> <em>poSFDefn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"> <em>pnMaxBytes</em> = <code>NULL</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>iSubfieldIndex</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Fetch raw data pointer for a particular subfield of this field.</p>
<p>The passed <a class="el" href="classDDFSubfieldDefn.html">DDFSubfieldDefn</a> (poSFDefn) should be acquired from the <a class="el" href="classDDFFieldDefn.html">DDFFieldDefn</a> corresponding with this field. This is normally done once before reading any records. This method involves a series of calls to DDFSubfield::GetDataLength() in order to track through the <a class="el" href="classDDFField.html">DDFField</a> data to that belonging to the requested subfield. This can be relatively expensive.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>poSFDefn</em> </td><td>The definition of the subfield for which the raw data pointer is desired. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pnMaxBytes</em> </td><td>The maximum number of bytes that can be accessed from the returned data pointer is placed in this int, unless it is NULL. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>iSubfieldIndex</em> </td><td>The instance of this subfield to fetch. Use zero (the default) for the first instance.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A pointer into the DDFField's data that belongs to the subfield. This returned pointer is invalidated by the next record read (DDFRecord::ReadRecord()) and the returned pointer should not be freed by the application. </dd></dl>
</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>ddffield.cpp</li>
</ul>
</div>
<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.6.2-20100208.
</body>
</html>
