File: structEPR__Field.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 (149 lines) | stat: -rw-r--r-- 7,392 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
<!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_Field Struct Reference</h1><!-- doxytag: class="EPR_Field" -->
<p>Represents a field within a record.  
<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__Field.html#a7d2b19ec233d70a0e55ed9517beeb143">magic</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The magic number for this structure.  <a href="#a7d2b19ec233d70a0e55ed9517beeb143"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="epr__api_8h.html#a8a33830c6c3ad308c874c3057ab1b629">EPR_SFieldInfo</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structEPR__Field.html#acae04f668002cd07018804db3682002c">info</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The corresponding field info for this field.  <a href="#acae04f668002cd07018804db3682002c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structEPR__Field.html#abfd95da8ece9cbc96f077b11613c626d">elems</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The elements of this field.  <a href="#abfd95da8ece9cbc96f077b11613c626d"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Represents a field within a record. </p>
<p>A field is composed of one or more data elements of one of the types defined in the in <code>field_info</code>.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="structEPR__Record.html" title="The EPR_Record structure represents a record instance read from an ENVISAT dataset...">EPR_Record</a> </dd></dl>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="a7d2b19ec233d70a0e55ed9517beeb143"></a><!-- doxytag: member="EPR_Field::magic" ref="a7d2b19ec233d70a0e55ed9517beeb143" 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__Field.html#a7d2b19ec233d70a0e55ed9517beeb143">EPR_Field::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="acae04f668002cd07018804db3682002c"></a><!-- doxytag: member="EPR_Field::info" ref="acae04f668002cd07018804db3682002c" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="epr__api_8h.html#a8a33830c6c3ad308c874c3057ab1b629">EPR_SFieldInfo</a>* <a class="el" href="structEPR__Field.html#acae04f668002cd07018804db3682002c">EPR_Field::info</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The corresponding field info for this field. </p>
<p><b>supplierCardinality</b> 1 </p>

</div>
</div>
<a class="anchor" id="abfd95da8ece9cbc96f077b11613c626d"></a><!-- doxytag: member="EPR_Field::elems" ref="abfd95da8ece9cbc96f077b11613c626d" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void* <a class="el" href="structEPR__Field.html#abfd95da8ece9cbc96f077b11613c626d">EPR_Field::elems</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The elements of this field. </p>
<p>In order to use the data, this member must be casted to one of the following array data types:</p>
<ol type="1">
<li><code>unsigned char*</code> - array of unsigned 8-bit integer elements</li>
<li><code>char*</code> - array of signed 8-bit integer fields</li>
<li><code>unsigned short*</code> - array of unsigned 16-bit integer elements</li>
<li><code>short*</code> - array of signed 16-bit integer elements</li>
<li><code>unsigned int*</code> - array of unsigned 32-bit integer elements</li>
<li><code>int*</code> - array of signed 32-bit integer elements</li>
<li><code>float*</code> - array of signed 32-bit floating point elements</li>
<li><code>double*</code> - array of signed 64-bit floating point elements</li>
<li><code>EPR_STime*</code> - array of MJD elements</li>
</ol>
<p>Dedicated access routine are available The element type is given by <code>info-&gt;data_type_id</code> and the array length by <code>info-&gt;num_elems</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>