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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<html>
<head>
<title>libics: Enumerated data types</title>
<link rel="stylesheet" href="libics.css" type="text/css" title="default">
<!--[if lte IE 6]>
<link rel="stylesheet" href="iexplorefix.css" type="text/css" title="default">
<![endif]-->
</head>
<body>
<p class=header>libics v.1.6.8 Online Documentation. ©2000-2010 by Cris Luengo and others.</p>
<div class="navbar">
<ul>
<li><a href=".">libics home</a></li>
<li><a href="Documentation.html" class="selected">Documentation</a>
<ul>
<li><a href="Usage.html">Usage of libics</a></li>
<li><a href="TopLevelFunctions.html">Top-level interface</a></li>
<li><a href="LowLevelFunctions.html">Low-level interface</a></li>
<li><a href="Ics_Header.html">Ics_Header</a></li>
<li><a href="Ics_DataRepresentation.html">Ics_DataRepresentation</a></li>
<li><a href="Ics_ImelRepresentation.html">Ics_ImelRepresentation</a></li>
<li><a href="Ics_Error.html">Ics_Error</a></li>
<li><a href="Enums.html" class="selected">Other enums:</a>
<ul>
<li><a href="#Ics_DataType">Ics_DataType</a></li>
<li><a href="#Ics_Compression">Ics_Compression</a></li>
<li><a href="#Ics_HistoryWhich">Ics_HistoryWhich</a></li>
<li><a href="#Ics_Format">Ics_Format</a></li>
<li><a href="#Ics_FileMode">Ics_FileMode</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="Credits.html">Credits</a></li>
<li><a href="Links.html">Links</a></li>
<li><a href="https://github.com/svi-opensource/libics/releases">Download</a></li>
<li><a href="https://github.com/svi-opensource/libics">GitHub</a></li>
</ul>
</div>
<h1>Enumerated data types</h1>
<h3 class="ident"><a name="Ics_DataType"></a>Ics_DataType</h3>
<p><tt class="typeident">Ics_DataType</tt> is an
<tt class="keyword">enum</tt> that defines the numeric representation
for the imels in the following values:</p>
<ul>
<li><tt class="constant">Ics_unknown</tt></li>
<li><tt class="constant">Ics_uint8</tt>:
<tt class="keyword">unsigned char</tt></li>
<li><tt class="constant">Ics_sint8</tt>:
<tt class="keyword">signed char</tt></li>
<li><tt class="constant">Ics_uint16</tt>:
<tt class="keyword">unsigned short</tt></li>
<li><tt class="constant">Ics_sint16</tt>:
<tt class="keyword">signed short</tt></li>
<li><tt class="constant">Ics_uint32</tt>:
<tt class="keyword">unsigned int</tt></li>
<li><tt class="constant">Ics_sint32</tt>:
<tt class="keyword">signed int</tt></li>
<li><tt class="constant">Ics_uint64</tt>:
<tt class="keyword">unsigned long long</tt></li>
<li><tt class="constant">Ics_sint64</tt>:
<tt class="keyword">signed long long</tt></li>
<li><tt class="constant">Ics_real32</tt>:
<tt class="keyword">float</tt></li>
<li><tt class="constant">Ics_real64</tt>:
<tt class="keyword">double</tt></li>
<li><tt class="constant">Ics_complex32</tt>:
{ <tt class="keyword">float</tt>, <tt class="keyword">float</tt> }</li>
<li><tt class="constant">Ics_complex64</tt>:
{ <tt class="keyword">double</tt>, <tt class="keyword">double</tt> }</li>
</ul>
<h3 class="ident"><a name="Ics_Compression"></a>Ics_Compression</h3>
<p><tt class="typeident">Ics_Compression</tt> is an
<tt class="keyword">enum</tt> that defines the compression method used
to store the imel data. These are the currently defined methods:</p>
<ul>
<li><tt class="constant">IcsCompr_uncompressed</tt></li>
<li><tt class="constant">IcsCompr_compress</tt>: Using the UNIX
<tt class="keyword">compress</tt> utility, which uses LZW compression.
When setting this value for writing, it is automatically translated to
<tt class="constant">IcsCompr_gzip</tt>, which is a better method.
Files written with this method can be read, but only if all data is
read in one go. That is, block-wise reading is not supported. For more
flexibility, it is possible to manually <tt class="keyword">uncompress</tt>
(<tt class="keyword">gunzip</tt> is also able to do this) the .ids file
and edit the <tt class="constant">'.ics'</tt> header to read
<tt class="keyword">compression uncompressed</tt>.</li>
<li><tt class="constant">IcsCompr_gzip</tt>: Using the
<tt class="keyword">gzip</tt> compression method
(the zlib library must be linked to). The compression parameter
is a value between 0 and 9: 1 gives best speed, 9 gives best
compression, 0 gives no compression at all. A good value to use
is 6.</li>
</ul>
<h3 class="ident"><a name="Ics_ByteOrder"></a>Ics_ByteOrder</h3>
<p><tt class="typeident">Ics_ByteOrder</tt> is an
<tt class="keyword">enum</tt> used by
<tt class="funcident"><a href="TopLevelFunctions.html#IcsSetByteOrder">IcsSetByteOrder</a></tt>.
It defines the following values:</p>
<ul>
<li><tt class="constant">IcsByteOrder_littleEndian</tt></li>
<li><tt class="constant">IcsByteOrder_bigEndian</tt></li>
</ul>
<h3 class="ident"><a name="Ics_HistoryWhich"></a>Ics_HistoryWhich</h3>
<p><tt class="typeident">Ics_HistoryWhich</tt> is an
<tt class="keyword">enum</tt> used by
<tt class="funcident"><a href="TopLevelFunctions.html#IcsGetHistoryString">IcsGetHistoryString</a></tt>.
It defines the following values:</p>
<ul>
<li><tt class="constant">IcsWhich_First</tt></li>
<li><tt class="constant">IcsWhich_Next</tt></li>
</ul>
<h3 class="ident"><a name="Ics_Format"></a>Ics_Format</h3>
<p><tt class="typeident">Ics_Format</tt> is an
<tt class="keyword">enum</tt> used by the low-level interface functions
<tt class="funcident"><a href="LowLevelFunctions.html#IcsGetPropsDataType">IcsGetPropsDataType</a></tt>
and
<tt class="funcident"><a href="LowLevelFunctions.html#IcsGetDataTypeProps">IcsGetDataTypeProps</a></tt>.
It defines the numeric representation in the following values:</p>
<ul>
<li><tt class="constant">IcsForm_unknown</tt></li>
<li><tt class="constant">IcsForm_integer</tt></li>
<li><tt class="constant">IcsForm_real</tt></li>
<li><tt class="constant">IcsForm_complex</tt></li>
</ul>
<h3 class="ident"><a name="Ics_FileMode"></a>Ics_FileMode</h3>
<p><tt class="typeident">Ics_FileMode</tt> is an
<tt class="keyword">enum</tt> used internally by the high-level interface
functions to avoid the user doing something unexpected.
It defines the following values:</p>
<ul>
<li><tt class="constant">IcsFileMode_read</tt>: Reading data and metadata allowed.</li>
<li><tt class="constant">IcsFileMode_write</tt>: Writing data and metadata allowed, reading metadata allowed.</li>
<li><tt class="constant">IcsFileMode_update</tt>: Reading and writing metadata allowed, reading data allowed.</li>
</ul>
</body>
</html>
|
