1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>ENVISAT Product Reader C API: Main Page</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="custom.css" rel="stylesheet" type="text/css">
</head><body>
<table class="header">
<tr class="header">
<td class="header">
ENVISAT Product Reader API for C
</td>
<td class="header" align="right">
<a href="http://www.brockmann-consult.de/beam">
<img src="../images/beam_header.gif" width="227" height="29" border="0">
</a>
</td>
</tr>
</table>
<br>
<!--<div class="navigation">-->
<!--<div class="tabs">-->
<!--<ul>-->
<!--<li class="current"><a href="index.html"><span>API Details</span></a></li>-->
<!--<li><a href="overview_custom.html"><span>API Overview</span></a></li>-->
<!--</ul>-->
<!--</div>-->
<!--</div>-->
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>Field Array Element Access This group of functions is for getting an array of field elements<br/>
<small>
[<a class="el" href="group__DA.html">Basic Data Access</a>]</small>
</h1>
<p>of a certain data type.
<a href="#_details">More...</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FAEA.html#ga9d903ad539ef6a9a9c8c20c2360256a2">epr_get_field_elems_char</a> (const <a class="el" href="structEPR__Field.html">EPR_SField</a> *field)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="epr__api_8h.html#a65f85814a8290f9797005d3b28e7e5fc">uchar</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FAEA.html#gaeb88230872a33d88efc2c1ce7afc07a8">epr_get_field_elems_uchar</a> (const <a class="el" href="structEPR__Field.html">EPR_SField</a> *field)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const short * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FAEA.html#ga1cafb7f590277963063b69db230e67a5">epr_get_field_elems_short</a> (const <a class="el" href="structEPR__Field.html">EPR_SField</a> *field)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="epr__api_8h.html#ab95f123a6c9bcfee6a343170ef8c5f69">ushort</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FAEA.html#gae9642128e56e5ea64a73df7206d8cbac">epr_get_field_elems_ushort</a> (const <a class="el" href="structEPR__Field.html">EPR_SField</a> *field)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const int * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FAEA.html#gacc373b1521a89d14d38b0a224c8762b3">epr_get_field_elems_int</a> (const <a class="el" href="structEPR__Field.html">EPR_SField</a> *field)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FAEA.html#ga94b0b59977821bfacd9d75f474534583">epr_get_field_elems_uint</a> (const <a class="el" href="structEPR__Field.html">EPR_SField</a> *field)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const float * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FAEA.html#ga5ddf82db54c3665d123c3eb4d525722a">epr_get_field_elems_float</a> (const <a class="el" href="structEPR__Field.html">EPR_SField</a> *field)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const double * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FAEA.html#ga56891c706f3eeed9ea3d42680fe7d04d">epr_get_field_elems_double</a> (const <a class="el" href="structEPR__Field.html">EPR_SField</a> *field)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>of a certain data type. </p>
<p>If the given field is not of the expected type, the functions return <code>NULL</code>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>field</em> </td><td>the field, must not be <code>NULL</code> </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the data array of the expected type or <code>NULL</code> if the field is of a different type </dd></dl>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga9d903ad539ef6a9a9c8c20c2360256a2"></a><!-- doxytag: member="epr_api.h::epr_get_field_elems_char" ref="ga9d903ad539ef6a9a9c8c20c2360256a2" args="(const EPR_SField *field)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* epr_get_field_elems_char </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structEPR__Field.html">EPR_SField</a> * </td>
<td class="paramname"> <em>field</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="gaeb88230872a33d88efc2c1ce7afc07a8"></a><!-- doxytag: member="epr_api.h::epr_get_field_elems_uchar" ref="gaeb88230872a33d88efc2c1ce7afc07a8" args="(const EPR_SField *field)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="epr__api_8h.html#a65f85814a8290f9797005d3b28e7e5fc">uchar</a>* epr_get_field_elems_uchar </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structEPR__Field.html">EPR_SField</a> * </td>
<td class="paramname"> <em>field</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ga1cafb7f590277963063b69db230e67a5"></a><!-- doxytag: member="epr_api.h::epr_get_field_elems_short" ref="ga1cafb7f590277963063b69db230e67a5" args="(const EPR_SField *field)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const short* epr_get_field_elems_short </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structEPR__Field.html">EPR_SField</a> * </td>
<td class="paramname"> <em>field</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="gae9642128e56e5ea64a73df7206d8cbac"></a><!-- doxytag: member="epr_api.h::epr_get_field_elems_ushort" ref="gae9642128e56e5ea64a73df7206d8cbac" args="(const EPR_SField *field)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="epr__api_8h.html#ab95f123a6c9bcfee6a343170ef8c5f69">ushort</a>* epr_get_field_elems_ushort </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structEPR__Field.html">EPR_SField</a> * </td>
<td class="paramname"> <em>field</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="gacc373b1521a89d14d38b0a224c8762b3"></a><!-- doxytag: member="epr_api.h::epr_get_field_elems_int" ref="gacc373b1521a89d14d38b0a224c8762b3" args="(const EPR_SField *field)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const int* epr_get_field_elems_int </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structEPR__Field.html">EPR_SField</a> * </td>
<td class="paramname"> <em>field</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ga94b0b59977821bfacd9d75f474534583"></a><!-- doxytag: member="epr_api.h::epr_get_field_elems_uint" ref="ga94b0b59977821bfacd9d75f474534583" args="(const EPR_SField *field)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a>* epr_get_field_elems_uint </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structEPR__Field.html">EPR_SField</a> * </td>
<td class="paramname"> <em>field</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ga5ddf82db54c3665d123c3eb4d525722a"></a><!-- doxytag: member="epr_api.h::epr_get_field_elems_float" ref="ga5ddf82db54c3665d123c3eb4d525722a" args="(const EPR_SField *field)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const float* epr_get_field_elems_float </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structEPR__Field.html">EPR_SField</a> * </td>
<td class="paramname"> <em>field</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ga56891c706f3eeed9ea3d42680fe7d04d"></a><!-- doxytag: member="epr_api.h::epr_get_field_elems_double" ref="ga56891c706f3eeed9ea3d42680fe7d04d" args="(const EPR_SField *field)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const double* epr_get_field_elems_double </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structEPR__Field.html">EPR_SField</a> * </td>
<td class="paramname"> <em>field</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
</div>
<hr>
<div align="center">
<address>
<p>Generated on Mon Aug 2 15:24:00 2010
<p>ENVISAT Product Reader C API
<p>Written by
<a href="mailto:info@brockmann-consult.de">Brockmann Consult</a>,
© 2002
<a href="http://www.brockmann-consult.de/">
<img src="../images/bc_logo.gif" alt="Brockmann Consult" align="bottom" border=0 width=18 height=18>
</a>
<a href="http://envisat.esa.int/">
<img src="../images/esa_logo.gif" alt="Eropean Space Agency" align="bottom" border=0 width=50 height=18>
</a>
</address>
</div>
</body>
</html>
|