EVOLUTION-MANAGER
Edit File: classSDTSTransfer.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: SDTSTransfer 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="classSDTSTransfer-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">SDTSTransfer Class Reference</div> </div> </div><!--header--> <div class="contents"> <p><code>#include <<a class="el" href="sdts__al_8h_source.html">sdts_al.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:a6aa55051a8c6baa8c24764f0d5e7c279"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSDTSTransfer.html#a6aa55051a8c6baa8c24764f0d5e7c279">Open</a> (const char *)</td></tr> <tr class="separator:a6aa55051a8c6baa8c24764f0d5e7c279"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7161e78c4e3aef778251231bfc95106e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSDTSTransfer.html#a7161e78c4e3aef778251231bfc95106e">FindLayer</a> (const char *)</td></tr> <tr class="separator:a7161e78c4e3aef778251231bfc95106e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af09f821480b80dad10113a0d8dc56b2e"><td class="memItemLeft" align="right" valign="top">SDTSLayerType </td><td class="memItemRight" valign="bottom"><a class="el" href="classSDTSTransfer.html#af09f821480b80dad10113a0d8dc56b2e">GetLayerType</a> (int) const </td></tr> <tr class="separator:af09f821480b80dad10113a0d8dc56b2e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae581dd3a3dcdfb56993197679bf69297"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSDTSTransfer.html#ae581dd3a3dcdfb56993197679bf69297">GetLayerCATDEntry</a> (int) const </td></tr> <tr class="separator:ae581dd3a3dcdfb56993197679bf69297"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac8e7ee7e036c9e57dda573a58fda4923"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classSDTSRasterReader.html">SDTSRasterReader</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classSDTSTransfer.html#ac8e7ee7e036c9e57dda573a58fda4923">GetLayerRasterReader</a> (int)</td></tr> <tr class="separator:ac8e7ee7e036c9e57dda573a58fda4923"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a028d3ec2c7b3bcc719137e632b907ca3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classSDTSIndexedReader.html">SDTSIndexedReader</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classSDTSTransfer.html#a028d3ec2c7b3bcc719137e632b907ca3">GetLayerIndexedReader</a> (int)</td></tr> <tr class="separator:a028d3ec2c7b3bcc719137e632b907ca3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aea48d5c34a76fec1fb347dbf9d59d9e5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classSDTS__CATD.html">SDTS_CATD</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classSDTSTransfer.html#aea48d5c34a76fec1fb347dbf9d59d9e5">GetCATD</a> ()</td></tr> <tr class="separator:aea48d5c34a76fec1fb347dbf9d59d9e5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:acdf4a657985ad712f6c544dff9ab0a64"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classSDTS__XREF.html">SDTS_XREF</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classSDTSTransfer.html#acdf4a657985ad712f6c544dff9ab0a64">GetXREF</a> ()</td></tr> <tr class="separator:acdf4a657985ad712f6c544dff9ab0a64"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a4eeffce018629c3a27102e213255381f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classDDFField.html">DDFField</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classSDTSTransfer.html#a4eeffce018629c3a27102e213255381f">GetAttr</a> (<a class="el" href="classSDTSModId.html">SDTSModId</a> *)</td></tr> <tr class="separator:a4eeffce018629c3a27102e213255381f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac975bfcaaacede92217bd9223299c4a5"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSDTSTransfer.html#ac975bfcaaacede92217bd9223299c4a5">GetBounds</a> (double *pdfMinX, double *pdfMinY, double *pdfMaxX, double *pdfMaxY)</td></tr> <tr class="separator:ac975bfcaaacede92217bd9223299c4a5"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Master class representing an entire SDTS transfer.</p> <p>This class is used to open the transfer, to get a list of available feature layers, and to instantiate readers for those layers. </p> </div><h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a7161e78c4e3aef778251231bfc95106e"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int SDTSTransfer::FindLayer </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>pszModule</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Fetch the <a class="el" href="classSDTSTransfer.html">SDTSTransfer</a> layer number corresponding to a module name.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">pszModule</td><td>the name of the module to search for, such as "PC01".</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>the layer number (between 0 and GetLayerCount()-1 corresponding to the module, or -1 if it doesn't correspond to a layer. </dd></dl> </div> </div> <a class="anchor" id="a4eeffce018629c3a27102e213255381f"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classDDFField.html">DDFField</a> * SDTSTransfer::GetAttr </td> <td>(</td> <td class="paramtype"><a class="el" href="classSDTSModId.html">SDTSModId</a> * </td> <td class="paramname"><em>poModId</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Fetch the attribute fields given a particular module/record id.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">poModId</td><td>an attribute record identifier, normally taken from the aoATID[] array of an SDTSIndexedFeature.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>a pointer to the <a class="el" href="classDDFField.html">DDFField</a> containing the user attribute values as subfields. </dd></dl> </div> </div> <a class="anchor" id="ac975bfcaaacede92217bd9223299c4a5"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int SDTSTransfer::GetBounds </td> <td>(</td> <td class="paramtype">double * </td> <td class="paramname"><em>pdfMinX</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">double * </td> <td class="paramname"><em>pdfMinY</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">double * </td> <td class="paramname"><em>pdfMaxX</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">double * </td> <td class="paramname"><em>pdfMaxY</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Fetch approximate bounds for a transfer by scanning all point layers and raster layers.</p> <p>For TVP datasets (where point layers are scanned) the results can, in theory miss some lines that go outside the bounds of the point layers. However, this isn't common since most TVP sets contain a bounding rectangle whose corners will define the most extreme extents.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">pdfMinX</td><td>western edge of dataset </td></tr> <tr><td class="paramname">pdfMinY</td><td>southern edge of dataset </td></tr> <tr><td class="paramname">pdfMaxX</td><td>eastern edge of dataset </td></tr> <tr><td class="paramname">pdfMaxY</td><td>northern edge of dataset</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>TRUE if success, or FALSE on a failure. </dd></dl> </div> </div> <a class="anchor" id="aea48d5c34a76fec1fb347dbf9d59d9e5"></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="classSDTS__CATD.html">SDTS_CATD</a>* SDTSTransfer::GetCATD </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 catalog object for this transfer.</p> <dl class="section return"><dt>Returns</dt><dd>pointer to the internally managed <a class="el" href="classSDTS__CATD.html">SDTS_CATD</a> for the transfer. </dd></dl> </div> </div> <a class="anchor" id="ae581dd3a3dcdfb56993197679bf69297"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int SDTSTransfer::GetLayerCATDEntry </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>iEntry</em></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Fetch the CATD module index for a layer. This can be used to fetch details about the layer/module from the <a class="el" href="classSDTS__CATD.html">SDTS_CATD</a> object, such as its filename, and description.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">iEntry</td><td>the layer index from 0 to GetLayerCount()-1.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>the module index suitable for use with the various <a class="el" href="classSDTS__CATD.html">SDTS_CATD</a> methods. </dd></dl> </div> </div> <a class="anchor" id="a028d3ec2c7b3bcc719137e632b907ca3"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classSDTSIndexedReader.html">SDTSIndexedReader</a> * SDTSTransfer::GetLayerIndexedReader </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>iEntry</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Returns a pointer to a reader of the appropriate type to the requested layer.</p> <p>Notes: </p> <ul> <li> <p class="startli">The returned reader remains owned by the <a class="el" href="classSDTSTransfer.html">SDTSTransfer</a>, and will be destroyed when the <a class="el" href="classSDTSTransfer.html">SDTSTransfer</a> is destroyed. It should not be destroyed by the application.</p> <p class="endli"></p> </li> <li> <p class="startli">If an indexed reader was already created for this layer using <a class="el" href="classSDTSTransfer.html#a028d3ec2c7b3bcc719137e632b907ca3">GetLayerIndexedReader()</a>, it will be returned instead of creating a new reader. Among other things this means that the returned reader may not be positioned to read from the beginning of the module, and may already have its index filled.</p> <p class="endli"></p> </li> <li> The returned reader will be of a type appropriate to the layer. See <a class="el" href="classSDTSTransfer.html#af09f821480b80dad10113a0d8dc56b2e">SDTSTransfer::GetLayerType()</a> to see what reader classes correspond to what layer types, so it can be cast accordingly (if necessary). </li> </ul> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">iEntry</td><td>the index of the layer to instantiate a reader for. A value between 0 and GetLayerCount()-1.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>a pointer to an appropriate reader or NULL if the method fails. </dd></dl> </div> </div> <a class="anchor" id="ac8e7ee7e036c9e57dda573a58fda4923"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classSDTSRasterReader.html">SDTSRasterReader</a> * SDTSTransfer::GetLayerRasterReader </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>iEntry</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Instantiate an <a class="el" href="classSDTSRasterReader.html">SDTSRasterReader</a> for the indicated layer.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">iEntry</td><td>the index of the layer to instantiate a reader for. A value between 0 and GetLayerCount()-1.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>a pointer to a new <a class="el" href="classSDTSRasterReader.html">SDTSRasterReader</a> object, or NULL if the method fails.</dd></dl> <p>NOTE: The reader returned from <a class="el" href="classSDTSTransfer.html#ac8e7ee7e036c9e57dda573a58fda4923">GetLayerRasterReader()</a> becomes the responsibility of the caller to delete, and isn't automatically deleted when the <a class="el" href="classSDTSTransfer.html">SDTSTransfer</a> is destroyed. This method is different from the <a class="el" href="classSDTSTransfer.html#a028d3ec2c7b3bcc719137e632b907ca3">GetLayerIndexedReader()</a> method in this regard. </p> </div> </div> <a class="anchor" id="af09f821480b80dad10113a0d8dc56b2e"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">SDTSLayerType SDTSTransfer::GetLayerType </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>iEntry</em></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Fetch type of requested feature layer.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">iEntry</td><td>the index of the layer to fetch information on. A value from zero to GetLayerCount()-1.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>the layer type.</dd></dl> <ul> <li> <p class="startli">SLTPoint: A point layer. An <a class="el" href="classSDTSPointReader.html">SDTSPointReader</a> is returned by <a class="el" href="classSDTSTransfer.html#a028d3ec2c7b3bcc719137e632b907ca3">SDTSTransfer::GetLayerIndexedReader()</a>.</p> <p class="endli"></p> </li> <li> <p class="startli">SLTLine: A line layer. An <a class="el" href="classSDTSLineReader.html">SDTSLineReader</a> is returned by <a class="el" href="classSDTSTransfer.html#a028d3ec2c7b3bcc719137e632b907ca3">SDTSTransfer::GetLayerIndexedReader()</a>.</p> <p class="endli"></p> </li> <li> <p class="startli">SLTAttr: An attribute primary or secondary layer. An <a class="el" href="classSDTSAttrReader.html">SDTSAttrReader</a> is returned by <a class="el" href="classSDTSTransfer.html#a028d3ec2c7b3bcc719137e632b907ca3">SDTSTransfer::GetLayerIndexedReader()</a>.</p> <p class="endli"></p> </li> <li> <p class="startli">SLTPoly: A polygon layer. An <a class="el" href="classSDTSPolygonReader.html">SDTSPolygonReader</a> is returned by <a class="el" href="classSDTSTransfer.html#a028d3ec2c7b3bcc719137e632b907ca3">SDTSTransfer::GetLayerIndexedReader()</a>.</p> <p class="endli"></p> </li> <li> SLTRaster: A raster layer. <a class="el" href="classSDTSTransfer.html#a028d3ec2c7b3bcc719137e632b907ca3">SDTSTransfer::GetLayerIndexedReader()</a> is not implemented. Use <a class="el" href="classSDTSTransfer.html#ac8e7ee7e036c9e57dda573a58fda4923">SDTSTransfer::GetLayerRasterReader()</a> instead. </li> </ul> </div> </div> <a class="anchor" id="acdf4a657985ad712f6c544dff9ab0a64"></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="classSDTS__XREF.html">SDTS_XREF</a>* SDTSTransfer::GetXREF </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 external reference object for this transfer.</p> <dl class="section return"><dt>Returns</dt><dd>pointer to the internally managed <a class="el" href="classSDTS__XREF.html">SDTS_XREF</a> for the transfer. </dd></dl> </div> </div> <a class="anchor" id="a6aa55051a8c6baa8c24764f0d5e7c279"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int SDTSTransfer::Open </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>pszFilename</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Open an SDTS transfer, and establish a list of data layers in the transfer.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">pszFilename</td><td>The name of the CATD file within the transfer.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>TRUE if the open success, or FALSE if it fails. </dd></dl> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="sdts__al_8h_source.html">sdts_al.h</a></li> <li>sdtstransfer.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>