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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
|
<!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 Access<br/>
<small>
[<a class="el" href="group__DA.html">Basic Data Access</a>]</small>
</h1><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 <a class="el" href="structEPR__Field.html">EPR_SField</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FA.html#ga6f5a8bbb038cbcaca9d75fc22c1204c3">epr_get_field</a> (const <a class="el" href="structEPR__Record.html">EPR_SRecord</a> *record, const char *field_name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets a field from the given record. <a href="#ga6f5a8bbb038cbcaca9d75fc22c1204c3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FA.html#ga93b14244616cd7ffb9d6038aef6d0c77">epr_get_num_fields</a> (const <a class="el" href="structEPR__Record.html">EPR_SRecord</a> *record)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the number of fields contained in the given record. <a href="#ga93b14244616cd7ffb9d6038aef6d0c77"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structEPR__Field.html">EPR_SField</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FA.html#ga5f6844631334e22200408b4c4ffcb04b">epr_get_field_at</a> (const <a class="el" href="structEPR__Record.html">EPR_SRecord</a> *record, <a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> field_index)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets a field at the specified position within the record. <a href="#ga5f6844631334e22200408b4c4ffcb04b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FA.html#ga6210bfaf424cbf72491df1312fa006c4">epr_get_field_unit</a> (const <a class="el" href="structEPR__Field.html">EPR_SField</a> *field)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the unit of the field. <a href="#ga6210bfaf424cbf72491df1312fa006c4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FA.html#ga4a4cd9f2fb58c1f3c33a12b3cea8355a">epr_get_field_description</a> (const <a class="el" href="structEPR__Field.html">EPR_SField</a> *field)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the description of the field. <a href="#ga4a4cd9f2fb58c1f3c33a12b3cea8355a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FA.html#ga961646523556438b33243c622bd7fe7d">epr_get_field_num_elems</a> (const <a class="el" href="structEPR__Field.html">EPR_SField</a> *field)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the number of elements of the field. <a href="#ga961646523556438b33243c622bd7fe7d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FA.html#ga1dda4184ca49daa83f6455f2321cd1f7">epr_get_field_name</a> (const <a class="el" href="structEPR__Field.html">EPR_SField</a> *field)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the name of the field. <a href="#ga1dda4184ca49daa83f6455f2321cd1f7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="epr__api_8h.html#a6d49712ee5ebd1df9b9a69a037a97996">EPR_EDataTypeId</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FA.html#gaa4ea84981ea9457a620e18130ac45359">epr_get_field_type</a> (const <a class="el" href="structEPR__Field.html">EPR_SField</a> *field)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the type of the field. <a href="#gaa4ea84981ea9457a620e18130ac45359"></a><br/></td></tr>
</table>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga6f5a8bbb038cbcaca9d75fc22c1204c3"></a><!-- doxytag: member="epr_api.h::epr_get_field" ref="ga6f5a8bbb038cbcaca9d75fc22c1204c3" args="(const EPR_SRecord *record, const char *field_name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structEPR__Field.html">EPR_SField</a>* epr_get_field </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structEPR__Record.html">EPR_SRecord</a> * </td>
<td class="paramname"> <em>record</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>field_name</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets a field from the given record. </p>
<p>The field is here identified through the given name. <br/>
It contains the field info and all corresponding values.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>record</em> </td><td>the record identifier, must not be <code>NULL</code> </td></tr>
<tr><td valign="top"></td><td valign="top"><em>field_name</em> </td><td>the the name of required field, must not be <code>NULL</code>. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the field or <code>NULL</code> if an error occured. </dd></dl>
</div>
</div>
<a class="anchor" id="ga93b14244616cd7ffb9d6038aef6d0c77"></a><!-- doxytag: member="epr_api.h::epr_get_num_fields" ref="ga93b14244616cd7ffb9d6038aef6d0c77" args="(const EPR_SRecord *record)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> epr_get_num_fields </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structEPR__Record.html">EPR_SRecord</a> * </td>
<td class="paramname"> <em>record</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the number of fields contained in the given record. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>record</em> </td><td>the record to be analysed, must not be <code>NULL</code> </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the fields number or <code>0</code> if an error occured. </dd></dl>
</div>
</div>
<a class="anchor" id="ga5f6844631334e22200408b4c4ffcb04b"></a><!-- doxytag: member="epr_api.h::epr_get_field_at" ref="ga5f6844631334e22200408b4c4ffcb04b" args="(const EPR_SRecord *record, uint field_index)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structEPR__Field.html">EPR_SField</a>* epr_get_field_at </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structEPR__Record.html">EPR_SRecord</a> * </td>
<td class="paramname"> <em>record</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td>
<td class="paramname"> <em>field_index</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets a field at the specified position within the record. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>record</em> </td><td>the record from the field shall be returned, must not be <code>NULL</code> </td></tr>
<tr><td valign="top"></td><td valign="top"><em>field_index</em> </td><td>the zero-based index (position within record) of the field </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the field or <code>NULL</code> if an error occured. </dd></dl>
</div>
</div>
<a class="anchor" id="ga6210bfaf424cbf72491df1312fa006c4"></a><!-- doxytag: member="epr_api.h::epr_get_field_unit" ref="ga6210bfaf424cbf72491df1312fa006c4" args="(const EPR_SField *field)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* epr_get_field_unit </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">
<p>Gets the unit of the field. </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 from which the unit shall be returned, must not be <code>NULL</code> </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the field unit or <code>NULL</code> if an error occured. </dd></dl>
</div>
</div>
<a class="anchor" id="ga4a4cd9f2fb58c1f3c33a12b3cea8355a"></a><!-- doxytag: member="epr_api.h::epr_get_field_description" ref="ga4a4cd9f2fb58c1f3c33a12b3cea8355a" args="(const EPR_SField *field)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* epr_get_field_description </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">
<p>Gets the description of the field. </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>field from which the description shall be returned, must not be <code>NULL</code></td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the field description or <code>NULL</code> if an error occured. </dd></dl>
</div>
</div>
<a class="anchor" id="ga961646523556438b33243c622bd7fe7d"></a><!-- doxytag: member="epr_api.h::epr_get_field_num_elems" ref="ga961646523556438b33243c622bd7fe7d" args="(const EPR_SField *field)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> epr_get_field_num_elems </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">
<p>Gets the number of elements of the field. </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>field to be analysed, must not be <code>NULL</code></td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the number of elements of the field or <code>0</code> if an error occured. </dd></dl>
</div>
</div>
<a class="anchor" id="ga1dda4184ca49daa83f6455f2321cd1f7"></a><!-- doxytag: member="epr_api.h::epr_get_field_name" ref="ga1dda4184ca49daa83f6455f2321cd1f7" args="(const EPR_SField *field)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* epr_get_field_name </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">
<p>Gets the name of the field. </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>field to be analysed, must not be <code>NULL</code></td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the field name or <code>NULL</code> if an error occured. </dd></dl>
</div>
</div>
<a class="anchor" id="gaa4ea84981ea9457a620e18130ac45359"></a><!-- doxytag: member="epr_api.h::epr_get_field_type" ref="gaa4ea84981ea9457a620e18130ac45359" args="(const EPR_SField *field)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="epr__api_8h.html#a6d49712ee5ebd1df9b9a69a037a97996">EPR_EDataTypeId</a> epr_get_field_type </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">
<p>Gets the type of the field. </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>field to be analysed, must not be <code>NULL</code></td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the field type or <code>0</code> if an error occured. </dd></dl>
</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>
|
