EVOLUTION-MANAGER
Edit File: classDDFModule.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>SDTS_AL: DDFModule 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">SDTS_AL </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="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="classDDFModule-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">DDFModule 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:a377d609ceccd4451a0f5f990dde3d91f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDDFModule.html#a377d609ceccd4451a0f5f990dde3d91f">DDFModule</a> ()</td></tr> <tr class="separator:a377d609ceccd4451a0f5f990dde3d91f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9f258a54e4d08c4bf93052045e5ed47a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDDFModule.html#a9f258a54e4d08c4bf93052045e5ed47a">~DDFModule</a> ()</td></tr> <tr class="separator:a9f258a54e4d08c4bf93052045e5ed47a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af4ffa6d8f0d6f06221b94ff8082adf43"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classDDFModule.html#af4ffa6d8f0d6f06221b94ff8082adf43">Open</a> (const char *pszFilename, int bFailQuietly=FALSE)</td></tr> <tr class="separator:af4ffa6d8f0d6f06221b94ff8082adf43"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af67df90389f688c50373bf926e607dc0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDDFModule.html#af67df90389f688c50373bf926e607dc0">Close</a> ()</td></tr> <tr class="separator:af67df90389f688c50373bf926e607dc0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a57b8180f3481b62791d42f021b208763"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDDFModule.html#a57b8180f3481b62791d42f021b208763">Dump</a> (FILE *fp)</td></tr> <tr class="separator:a57b8180f3481b62791d42f021b208763"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:adc0cb91dc1b1880b73d2dfacc57e2516"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classDDFRecord.html">DDFRecord</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDDFModule.html#adc0cb91dc1b1880b73d2dfacc57e2516">ReadRecord</a> (void)</td></tr> <tr class="separator:adc0cb91dc1b1880b73d2dfacc57e2516"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af423b771131f4a4e982cf20549763c10"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDDFModule.html#af423b771131f4a4e982cf20549763c10">Rewind</a> (long nOffset=-1)</td></tr> <tr class="separator:af423b771131f4a4e982cf20549763c10"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a46ac8b2349e89aee4e38871fc9ae7e12"><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="classDDFModule.html#a46ac8b2349e89aee4e38871fc9ae7e12">FindFieldDefn</a> (const char *)</td></tr> <tr class="separator:a46ac8b2349e89aee4e38871fc9ae7e12"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a6ca0488308417018b1ee1d3a9dafa319"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classDDFModule.html#a6ca0488308417018b1ee1d3a9dafa319">GetFieldCount</a> ()</td></tr> <tr class="separator:a6ca0488308417018b1ee1d3a9dafa319"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a243f5a81a7ec7bb34805f7cc5e376092"><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="classDDFModule.html#a243f5a81a7ec7bb34805f7cc5e376092">GetField</a> (int)</td></tr> <tr class="separator:a243f5a81a7ec7bb34805f7cc5e376092"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa244a177dd16cb9857d3d1cf804a0dbf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDDFModule.html#aa244a177dd16cb9857d3d1cf804a0dbf">AddField</a> (<a class="el" href="classDDFFieldDefn.html">DDFFieldDefn</a> *poNewFDefn)</td></tr> <tr class="separator:aa244a177dd16cb9857d3d1cf804a0dbf"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>The primary class for reading ISO 8211 files. This class contains all the information read from the DDR record, and is used to read records from the file. </p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="a377d609ceccd4451a0f5f990dde3d91f"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">DDFModule::DDFModule </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>The constructor. </p> </div> </div> <a class="anchor" id="a9f258a54e4d08c4bf93052045e5ed47a"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">DDFModule::~DDFModule </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>The destructor. </p> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="aa244a177dd16cb9857d3d1cf804a0dbf"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void DDFModule::AddField </td> <td>(</td> <td class="paramtype"><a class="el" href="classDDFFieldDefn.html">DDFFieldDefn</a> * </td> <td class="paramname"><em>poNewFDefn</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Add new field definition.</p> <p>Field definitions may only be added to DDFModules being used for writing, not those being used for reading. Ownership of the <a class="el" href="classDDFFieldDefn.html">DDFFieldDefn</a> object is taken by the <a class="el" href="classDDFModule.html">DDFModule</a>.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">poNewFDefn</td><td>definition to be added to the module. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="af67df90389f688c50373bf926e607dc0"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void DDFModule::Close </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Close an ISO 8211 file. </p> </div> </div> <a class="anchor" id="a57b8180f3481b62791d42f021b208763"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void DDFModule::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 module info to debugging file.</p> <p>A variety of information about the module is written to the debugging file. This includes all the field and subfield definitions read from the header.</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="a46ac8b2349e89aee4e38871fc9ae7e12"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classDDFFieldDefn.html">DDFFieldDefn</a> * DDFModule::FindFieldDefn </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>pszFieldName</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Fetch the definition of the named field.</p> <p>This function will scan the <a class="el" href="classDDFFieldDefn.html">DDFFieldDefn</a>'s on this module, to find one with the indicated field name.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">pszFieldName</td><td>The name of the field to search for. The comparison is case insensitive.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>A pointer to the request <a class="el" href="classDDFFieldDefn.html">DDFFieldDefn</a> object is returned, or NULL if none matching the name are found. The return object remains owned by the <a class="el" href="classDDFModule.html">DDFModule</a>, and should not be deleted by application code. </dd></dl> </div> </div> <a class="anchor" id="a243f5a81a7ec7bb34805f7cc5e376092"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classDDFFieldDefn.html">DDFFieldDefn</a> * DDFModule::GetField </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 field definition by index.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">i</td><td>(from 0 to <a class="el" href="classDDFModule.html#a6ca0488308417018b1ee1d3a9dafa319">GetFieldCount()</a> - 1. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>the returned field pointer or NULL if the index is out of range. </dd></dl> </div> </div> <a class="anchor" id="a6ca0488308417018b1ee1d3a9dafa319"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">int DDFModule::GetFieldCount </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 the number of defined fields. </p> </div> </div> <a class="anchor" id="af4ffa6d8f0d6f06221b94ff8082adf43"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int DDFModule::Open </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>pszFilename</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>bFailQuietly</em> = <code>FALSE</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Open a ISO 8211 (DDF) file for reading.</p> <p>If the open succeeds the data descriptive record (DDR) will have been read, and all the field and subfield definitions will be available.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">pszFilename</td><td>The name of the file to open. </td></tr> <tr><td class="paramname">bFailQuietly</td><td>If FALSE a CPL Error is issued for non-8211 files, otherwise quietly return NULL.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>FALSE if the open fails or TRUE if it succeeds. Errors messages are issued internally with CPLError(). </dd></dl> </div> </div> <a class="anchor" id="adc0cb91dc1b1880b73d2dfacc57e2516"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classDDFRecord.html">DDFRecord</a> * DDFModule::ReadRecord </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Read one record from the file.</p> <dl class="section return"><dt>Returns</dt><dd>A pointer to a <a class="el" href="classDDFRecord.html">DDFRecord</a> object is returned, or NULL if a read error, or end of file occurs. The returned record is owned by the module, and should not be deleted by the application. The record is only valid untill the next <a class="el" href="classDDFModule.html#adc0cb91dc1b1880b73d2dfacc57e2516">ReadRecord()</a> at which point it is overwritten. </dd></dl> </div> </div> <a class="anchor" id="af423b771131f4a4e982cf20549763c10"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void DDFModule::Rewind </td> <td>(</td> <td class="paramtype">long </td> <td class="paramname"><em>nOffset</em> = <code>-1</code></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Return to first record.</p> <p>The next call to <a class="el" href="classDDFModule.html#adc0cb91dc1b1880b73d2dfacc57e2516">ReadRecord()</a> will read the first data record in the file.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">nOffset</td><td>the offset in the file to return to. By default this is -1, a special value indicating that reading should return to the first data record. Otherwise it is an absolute byte offset in the file. </td></tr> </table> </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>ddfmodule.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>