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
|
<!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 class="current"><a href="annotated.html"><span>Data Structures</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>Data Structures</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>EPR_DatasetId Struct Reference</h1><!-- doxytag: class="EPR_DatasetId" -->
<p>The <code><a class="el" href="structEPR__DatasetId.html" title="The EPR_DatasetId structure contains information about a dataset within an ENVISAT...">EPR_DatasetId</a></code> structure contains information about a dataset within an ENVISAT product file which has been opened with the <code><a class="el" href="group__ProductIO.html#ga53b5258027c1b3d7ea3cdd221686eb53" title="Opens the ENVISAT product file with the given file path, reads MPH, SPH and all...">epr_open_product()</a></code> API function.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="epr__api_8h_source.html">epr_api.h</a>></code></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="epr__api_8h.html#aabba722c6276921eb7ff4095db12ddd0">EPR_Magic</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structEPR__DatasetId.html#a6a646b38318963cd6a0b7b77bc3fd147">magic</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The magic number for this structure. <a href="#a6a646b38318963cd6a0b7b77bc3fd147"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structEPR__ProductId.html">EPR_SProductId</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structEPR__DatasetId.html#a4ea5884d40b506e07af5883137c0952e">product_id</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The ID of the product to which this dataset belongs to. <a href="#a4ea5884d40b506e07af5883137c0952e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structEPR__DatasetId.html#a13cc0ba37004b12d9481ce075cd44b3f">dsd_name</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The name as presented to the user in a dsd selection dialog. <a href="#a13cc0ba37004b12d9481ce075cd44b3f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structEPR__DSD.html">EPR_SDSD</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structEPR__DatasetId.html#a0f21e17f5c0f2da0851045b1ef0c2ef3">dsd</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The dataset descriptor obtained from the current product. <a href="#a0f21e17f5c0f2da0851045b1ef0c2ef3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structEPR__DatasetId.html#aedf05183e5bd80c53cf317bb52db5c5c">dataset_name</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The name as presented to the user in a dataset selection dialog. <a href="#aedf05183e5bd80c53cf317bb52db5c5c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct RecordDescriptor * </td><td class="memItemRight" valign="bottom"><a class="el" href="structEPR__DatasetId.html#afa1fb7584691f733723cc68f0a57037e">record_descriptor</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The record descriptor found in the DDDB for this dataset. <a href="#afa1fb7584691f733723cc68f0a57037e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="epr__api_8h.html#af1c32dbbca2283b8e1290a414042ad03">EPR_SRecordInfo</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structEPR__DatasetId.html#a8eb83a07f432f69523378da3955143ec">record_info</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The record info which describes a record of this dataset. <a href="#a8eb83a07f432f69523378da3955143ec"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structEPR__DatasetId.html#a1486ef0dbb0bf9c8e3a1eac20aac1792">description</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A short description of the band's contents. <a href="#a1486ef0dbb0bf9c8e3a1eac20aac1792"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The <code><a class="el" href="structEPR__DatasetId.html" title="The EPR_DatasetId structure contains information about a dataset within an ENVISAT...">EPR_DatasetId</a></code> structure contains information about a dataset within an ENVISAT product file which has been opened with the <code><a class="el" href="group__ProductIO.html#ga53b5258027c1b3d7ea3cdd221686eb53" title="Opens the ENVISAT product file with the given file path, reads MPH, SPH and all...">epr_open_product()</a></code> API function. </p>
<p>A new <code><a class="el" href="structEPR__DatasetId.html" title="The EPR_DatasetId structure contains information about a dataset within an ENVISAT...">EPR_DatasetId</a></code> instance can be obtained with the <code><a class="el" href="group__DATASET.html#gae397532cac41bcbc52a24018d04ff715" title="Gets the dataset_id coresponding to the specified dataset name.">epr_get_dataset_id()</a></code> or <code><a class="el" href="group__DATASET.html#ga78f0cb948a974afaaa58af4e4cb87619" title="Gets the dataset_id at the specified position within the product.">epr_get_dataset_id_at()</a></code> API functions.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__ProductIO.html#ga53b5258027c1b3d7ea3cdd221686eb53" title="Opens the ENVISAT product file with the given file path, reads MPH, SPH and all...">epr_open_product</a> </dd>
<dd>
<a class="el" href="group__DATASET.html#gae397532cac41bcbc52a24018d04ff715" title="Gets the dataset_id coresponding to the specified dataset name.">epr_get_dataset_id</a> </dd>
<dd>
<a class="el" href="group__DATASET.html#ga78f0cb948a974afaaa58af4e4cb87619" title="Gets the dataset_id at the specified position within the product.">epr_get_dataset_id_at</a> </dd></dl>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="a6a646b38318963cd6a0b7b77bc3fd147"></a><!-- doxytag: member="EPR_DatasetId::magic" ref="a6a646b38318963cd6a0b7b77bc3fd147" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="epr__api_8h.html#aabba722c6276921eb7ff4095db12ddd0">EPR_Magic</a> <a class="el" href="structEPR__DatasetId.html#a6a646b38318963cd6a0b7b77bc3fd147">EPR_DatasetId::magic</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The magic number for this structure. </p>
<p>IMPORTANT: This must always be the first member of this structure. </p>
</div>
</div>
<a class="anchor" id="a4ea5884d40b506e07af5883137c0952e"></a><!-- doxytag: member="EPR_DatasetId::product_id" ref="a4ea5884d40b506e07af5883137c0952e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structEPR__ProductId.html">EPR_SProductId</a>* <a class="el" href="structEPR__DatasetId.html#a4ea5884d40b506e07af5883137c0952e">EPR_DatasetId::product_id</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The ID of the product to which this dataset belongs to. </p>
</div>
</div>
<a class="anchor" id="a13cc0ba37004b12d9481ce075cd44b3f"></a><!-- doxytag: member="EPR_DatasetId::dsd_name" ref="a13cc0ba37004b12d9481ce075cd44b3f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* <a class="el" href="structEPR__DatasetId.html#a13cc0ba37004b12d9481ce075cd44b3f">EPR_DatasetId::dsd_name</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The name as presented to the user in a dsd selection dialog. </p>
</div>
</div>
<a class="anchor" id="a0f21e17f5c0f2da0851045b1ef0c2ef3"></a><!-- doxytag: member="EPR_DatasetId::dsd" ref="a0f21e17f5c0f2da0851045b1ef0c2ef3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structEPR__DSD.html">EPR_SDSD</a>* <a class="el" href="structEPR__DatasetId.html#a0f21e17f5c0f2da0851045b1ef0c2ef3">EPR_DatasetId::dsd</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The dataset descriptor obtained from the current product. </p>
</div>
</div>
<a class="anchor" id="aedf05183e5bd80c53cf317bb52db5c5c"></a><!-- doxytag: member="EPR_DatasetId::dataset_name" ref="aedf05183e5bd80c53cf317bb52db5c5c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* <a class="el" href="structEPR__DatasetId.html#aedf05183e5bd80c53cf317bb52db5c5c">EPR_DatasetId::dataset_name</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The name as presented to the user in a dataset selection dialog. </p>
</div>
</div>
<a class="anchor" id="afa1fb7584691f733723cc68f0a57037e"></a><!-- doxytag: member="EPR_DatasetId::record_descriptor" ref="afa1fb7584691f733723cc68f0a57037e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct RecordDescriptor* <a class="el" href="structEPR__DatasetId.html#afa1fb7584691f733723cc68f0a57037e">EPR_DatasetId::record_descriptor</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The record descriptor found in the DDDB for this dataset. </p>
</div>
</div>
<a class="anchor" id="a8eb83a07f432f69523378da3955143ec"></a><!-- doxytag: member="EPR_DatasetId::record_info" ref="a8eb83a07f432f69523378da3955143ec" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="epr__api_8h.html#af1c32dbbca2283b8e1290a414042ad03">EPR_SRecordInfo</a>* <a class="el" href="structEPR__DatasetId.html#a8eb83a07f432f69523378da3955143ec">EPR_DatasetId::record_info</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The record info which describes a record of this dataset. </p>
</div>
</div>
<a class="anchor" id="a1486ef0dbb0bf9c8e3a1eac20aac1792"></a><!-- doxytag: member="EPR_DatasetId::description" ref="a1486ef0dbb0bf9c8e3a1eac20aac1792" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* <a class="el" href="structEPR__DatasetId.html#a1486ef0dbb0bf9c8e3a1eac20aac1792">EPR_DatasetId::description</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A short description of the band's contents. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="epr__api_8h_source.html">epr_api.h</a></li>
</ul>
</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>
|
