File: structEPR__Record.html

package info (click to toggle)
epr-api 2.3~dev20150708-13
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 3,132 kB
  • sloc: ansic: 14,310; sh: 194; makefile: 145; xml: 125
file content (154 lines) | stat: -rw-r--r-- 8,104 bytes parent folder | download | duplicates (6)
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
<!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">&nbsp;
            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&nbsp;Details</span></a></li>-->
      <!--<li><a href="overview_custom.html"><span>API&nbsp;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&nbsp;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&nbsp;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&nbsp;Structures</span></a></li>
      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>EPR_Record Struct Reference</h1><!-- doxytag: class="EPR_Record" -->
<p>The <code><a class="el" href="structEPR__Record.html" title="The EPR_Record structure represents a record instance read from an ENVISAT dataset...">EPR_Record</a></code> structure represents a record instance read from an ENVISAT dataset.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="epr__api_8h_source.html">epr_api.h</a>&gt;</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>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structEPR__Record.html#af52aa94f578878a421ebb372590e8753">magic</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The magic number for this structure.  <a href="#af52aa94f578878a421ebb372590e8753"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="epr__api_8h.html#af1c32dbbca2283b8e1290a414042ad03">EPR_SRecordInfo</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structEPR__Record.html#a19e19ac18cc40473ed1bc9edaaef73de">info</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The corresponding record info for this record (a 'soft' pointer).  <a href="#a19e19ac18cc40473ed1bc9edaaef73de"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structEPR__Record.html#a832ce998c9f757a3265a17b949f5e9f6">num_fields</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The number of fields contained in this record.  <a href="#a832ce998c9f757a3265a17b949f5e9f6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structEPR__Field.html">EPR_SField</a> **&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structEPR__Record.html#a776000d7371a4bddbb9e4e6e7abbbdb1">fields</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The record fields.  <a href="#a776000d7371a4bddbb9e4e6e7abbbdb1"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The <code><a class="el" href="structEPR__Record.html" title="The EPR_Record structure represents a record instance read from an ENVISAT dataset...">EPR_Record</a></code> structure represents a record instance read from an ENVISAT dataset. </p>
<p>A record is composed of multiple fields.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="structEPR__Field.html" title="Represents a field within a record.">EPR_Field</a> </dd></dl>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="af52aa94f578878a421ebb372590e8753"></a><!-- doxytag: member="EPR_Record::magic" ref="af52aa94f578878a421ebb372590e8753" 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__Record.html#af52aa94f578878a421ebb372590e8753">EPR_Record::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="a19e19ac18cc40473ed1bc9edaaef73de"></a><!-- doxytag: member="EPR_Record::info" ref="a19e19ac18cc40473ed1bc9edaaef73de" 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__Record.html#a19e19ac18cc40473ed1bc9edaaef73de">EPR_Record::info</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The corresponding record info for this record (a 'soft' pointer). </p>

</div>
</div>
<a class="anchor" id="a832ce998c9f757a3265a17b949f5e9f6"></a><!-- doxytag: member="EPR_Record::num_fields" ref="a832ce998c9f757a3265a17b949f5e9f6" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> <a class="el" href="structEPR__Record.html#a832ce998c9f757a3265a17b949f5e9f6">EPR_Record::num_fields</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The number of fields contained in this record. </p>
<p>The value is always equal <code>info-&gt;field_infos-&gt;length</code> and is provided here for convenience only. </p>

</div>
</div>
<a class="anchor" id="a776000d7371a4bddbb9e4e6e7abbbdb1"></a><!-- doxytag: member="EPR_Record::fields" ref="a776000d7371a4bddbb9e4e6e7abbbdb1" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structEPR__Field.html">EPR_SField</a>** <a class="el" href="structEPR__Record.html#a776000d7371a4bddbb9e4e6e7abbbdb1">EPR_Record::fields</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The record fields. </p>
<p>An array of <code>EPR_Field*</code> of length <code>info-&gt;num_fields</code> </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>,
        &copy;&nbsp;2002&nbsp;&nbsp;&nbsp;&nbsp;
        <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>
        &nbsp;&nbsp;&nbsp;&nbsp;
        <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>