File: tide_db_header.h

package info (click to toggle)
libtcd 2.2.2-2.1
  • links: PTS
  • area: main
  • in suites: bookworm, bullseye
  • size: 1,652 kB
  • sloc: sh: 8,798; ansic: 3,795; makefile: 58
file content (489 lines) | stat: -rw-r--r-- 11,813 bytes parent folder | download | duplicates (3)
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
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
/* $Id: tide_db_header.h 1092 2006-11-16 03:02:42Z flaterco $ */

/*****************************************************************************\

                            DISTRIBUTION STATEMENT

    This source file is unclassified, distribution unlimited, public
    domain.  It is distributed in the hope that it will be useful, but
    WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

\*****************************************************************************/




/***************************************************************************\

    Module Name:        TIDE DB option header file

    Programmer(s):      Jan C. Depner

    Date Written:       July 2002

    Purpose:            This header file defines all of the format options
                        that are stored in the TIDE DB file header.  To add a
                        new option you simply add it to the header_data
                        structure, then put a definition in the keys structure.
                        The keys structure contains a keyphrase such as
                        "[DATE]", a format like "%s", a datatype (see the
                        union in the TIDE_HEADER_DATA structure, a pointer to
                        the location at which to store the value(s), a count
                        if it is a repeating field (array), and a version
                        dependency flag (major.minor * 10).



*****************************************************************************

    This header file uses the NAVO standard data types.  You must set one of
    the following options on the compile command line:

    NVDOS, NVHPUX, NVIRIX, NVCLIX, NVLinux, NVSUNOS, NVWINNT, or NVWIN3X

The only one referenced in libtcd is NVWIN3X. -- DWF, 2004-09-29

\***************************************************************************/


#ifndef __TIDE_HEADER__
#define __TIDE_HEADER__

#include "tcd.h"


typedef struct
{
    NV_CHAR                    *keyphrase;
    NV_CHAR                    *datatype;
    union
    {
        NV_CHAR                *cstr;
        NV_INT32               *i32;
        NV_U_INT32             *ui32;
    } address;
} KEY;


typedef struct
{
    DB_HEADER_PUBLIC  pub;
    NV_CHAR           **constituent;
    NV_FLOAT64        *speed;
    NV_FLOAT32        **equilibrium;
    NV_FLOAT32        **node_factor;
    NV_CHAR           **level_unit;
    NV_CHAR           **dir_unit;
    NV_CHAR           **restriction;
    NV_CHAR           **tzfile;
    NV_CHAR           **country;
    NV_CHAR           **datum;
    NV_CHAR           **legalese;
    NV_U_INT32        header_size;
    NV_U_INT32        speed_bits;
    NV_U_INT32        speed_scale;
    NV_INT32          speed_offset;
    NV_U_INT32        equilibrium_bits;
    NV_U_INT32        equilibrium_scale;
    NV_INT32          equilibrium_offset;
    NV_U_INT32        node_bits;
    NV_U_INT32        node_scale;
    NV_INT32          node_offset;
    NV_U_INT32        amplitude_bits;
    NV_U_INT32        amplitude_scale;
    NV_U_INT32        epoch_bits;
    NV_U_INT32        epoch_scale;
    NV_U_INT32        constituent_bits;
    NV_U_INT32        record_type_bits;
    NV_U_INT32        latitude_scale;
    NV_U_INT32        latitude_bits;
    NV_U_INT32        longitude_scale;
    NV_U_INT32        longitude_bits;
    NV_U_INT32        record_size_bits;
    NV_U_INT32        station_bits;
    NV_U_INT32        level_unit_bits;
    NV_U_INT32        dir_unit_bits;
    NV_U_INT32        restriction_bits;
    NV_U_INT32        max_restriction_types;
    NV_U_INT32        tzfile_bits;
    NV_U_INT32        max_tzfiles;
    NV_U_INT32        country_bits;
    NV_U_INT32        max_countries;
    NV_U_INT32        datum_bits;
    NV_U_INT32        max_datum_types;
    NV_U_INT32        legalese_bits;
    NV_U_INT32        max_legaleses;
    NV_U_INT32        datum_offset_bits;
    NV_U_INT32        datum_offset_scale;
    NV_U_INT32        date_bits;
    NV_U_INT32        months_on_station_bits;
    NV_U_INT32        confidence_value_bits;
    NV_U_INT32        time_bits;
    NV_U_INT32        level_add_bits;
    NV_U_INT32        level_add_scale;
    NV_U_INT32        level_multiply_bits;
    NV_U_INT32        level_multiply_scale;
    NV_U_INT32        direction_bits;
    NV_U_INT32        constituent_size;
    NV_U_INT32        level_unit_size;
    NV_U_INT32        dir_unit_size;
    NV_U_INT32        restriction_size;
    NV_U_INT32        tzfile_size;
    NV_U_INT32        country_size;
    NV_U_INT32        datum_size;
    NV_U_INT32        legalese_size;
    NV_U_INT32        end_of_file;

    /* Need these to read V1 files. */
    NV_U_INT32        pedigree_bits;
    NV_U_INT32        pedigree_size;
} TIDE_HEADER_DATA;


static TIDE_HEADER_DATA        hd;

/* "The initializer for a union with no constructor is either a single
   expression of the same type, or a brace-enclosed initializer for
   the first member of the union." -- Ellis & Stroustrup, The Annotated
   C++ Reference Manual, 1990, Section 8.4.1. */

static KEY                     keys[] =
{
    {
        "[VERSION]",
        "cstr",
        {(NV_CHAR *) hd.pub.version},
    },
    {
        "[MAJOR REV]",
        "ui32",
        {(NV_CHAR *) &hd.pub.major_rev},
    },
    {
        "[MINOR REV]",
        "ui32",
        {(NV_CHAR *) &hd.pub.minor_rev},
    },
    {
        "[LAST MODIFIED]",
        "cstr",
        {(NV_CHAR *) hd.pub.last_modified},
    },
    {
        "[NUMBER OF RECORDS]",
        "ui32",
        {(NV_CHAR *) &hd.pub.number_of_records},
    },
    {
        "[START YEAR]",
        "i32",
        {(NV_CHAR *) &hd.pub.start_year},
    },
    {
        "[NUMBER OF YEARS]",
        "ui32",
        {(NV_CHAR *) &hd.pub.number_of_years},
    },
    {
        "[CONSTITUENTS]",
        "ui32",
        {(NV_CHAR *) &hd.pub.constituents},
    },
    {
        "[LEVEL UNIT TYPES]",
        "ui32",
        {(NV_CHAR *) &hd.pub.level_unit_types},
    },
    {
        "[DIRECTION UNIT TYPES]",
        "ui32",
        {(NV_CHAR *) &hd.pub.dir_unit_types},
    },
    {
        "[RESTRICTION TYPES]",
        "ui32",
        {(NV_CHAR *) &hd.pub.restriction_types},
    },
    {
        "[PEDIGREE TYPES]",
        "ui32",
        {(NV_CHAR *) &hd.pub.pedigree_types},
    },
    {
        "[TZFILES]",
        "ui32",
        {(NV_CHAR *) &hd.pub.tzfiles},
    },
    {
        "[COUNTRIES]",
        "ui32",
        {(NV_CHAR *) &hd.pub.countries},
    },
    {
        "[DATUM TYPES]",
        "ui32",
        {(NV_CHAR *) &hd.pub.datum_types},
    },
    {
        "[LEGALESES]",
        "ui32",
        {(NV_CHAR *) &hd.pub.legaleses},
    },
    {
        "[HEADER SIZE]",
        "ui32",
        {(NV_CHAR *) &hd.header_size},
    },
    {
        "[SPEED BITS]",
        "ui32",
        {(NV_CHAR *) &hd.speed_bits},
    },
    {
        "[SPEED SCALE]",
        "ui32",
        {(NV_CHAR *) &hd.speed_scale},
    },
    {
        "[SPEED OFFSET]",
        "i32",
        {(NV_CHAR *) &hd.speed_offset},
    },
    {
        "[EQUILIBRIUM BITS]",
        "ui32",
        {(NV_CHAR *) &hd.equilibrium_bits},
    },
    {
        "[EQUILIBRIUM SCALE]",
        "ui32",
        {(NV_CHAR *) &hd.equilibrium_scale},
    },
    {
        "[EQUILIBRIUM OFFSET]",
        "i32",
        {(NV_CHAR *) &hd.equilibrium_offset},
    },
    {
        "[NODE BITS]",
        "ui32",
        {(NV_CHAR *) &hd.node_bits},
    },
    {
        "[NODE SCALE]",
        "ui32",
        {(NV_CHAR *) &hd.node_scale},
    },
    {
        "[NODE OFFSET]",
        "i32",
        {(NV_CHAR *) &hd.node_offset},
    },
    {
        "[AMPLITUDE BITS]",
        "ui32",
        {(NV_CHAR *) &hd.amplitude_bits},
    },
    {
        "[AMPLITUDE SCALE]",
        "ui32",
        {(NV_CHAR *) &hd.amplitude_scale},
    },
    {
        "[EPOCH BITS]",
        "ui32",
        {(NV_CHAR *) &hd.epoch_bits},
    },
    {
        "[EPOCH SCALE]",
        "ui32",
        {(NV_CHAR *) &hd.epoch_scale},
    },
    {
        "[CONSTITUENT BITS]",
        "ui32",
        {(NV_CHAR *) &hd.constituent_bits},
    },
    {
        "[LEVEL UNIT BITS]",
        "ui32",
        {(NV_CHAR *) &hd.level_unit_bits},
    },
    {
        "[DIRECTION UNIT BITS]",
        "ui32",
        {(NV_CHAR *) &hd.dir_unit_bits},
    },
    {
        "[RESTRICTION BITS]",
        "ui32",
        {(NV_CHAR *) &hd.restriction_bits},
    },
    {
        "[PEDIGREE BITS]",
        "ui32",
        {(NV_CHAR *) &hd.pedigree_bits},
    },
    {
        "[TZFILE BITS]",
        "ui32",
        {(NV_CHAR *) &hd.tzfile_bits},
    },
    {
        "[COUNTRY BITS]",
        "ui32",
        {(NV_CHAR *) &hd.country_bits},
    },
    {
        "[DATUM BITS]",
        "ui32",
        {(NV_CHAR *) &hd.datum_bits},
    },
    {
        "[LEGALESE BITS]",
        "ui32",
        {(NV_CHAR *) &hd.legalese_bits},
    },
    {
        "[RECORD TYPE BITS]",
        "ui32",
        {(NV_CHAR *) &hd.record_type_bits},
    },
    {
        "[LATITUDE SCALE]",
        "ui32",
        {(NV_CHAR *) &hd.latitude_scale},
    },
    {
        "[LATITUDE BITS]",
        "ui32",
        {(NV_CHAR *) &hd.latitude_bits},
    },
    {
        "[LONGITUDE SCALE]",
        "ui32",
        {(NV_CHAR *) &hd.longitude_scale},
    },
    {
        "[LONGITUDE BITS]",
        "ui32",
        {(NV_CHAR *) &hd.longitude_bits},
    },
    {
        "[RECORD SIZE BITS]",
        "ui32",
        {(NV_CHAR *) &hd.record_size_bits},
    },
    {
        "[STATION BITS]",
        "ui32",
        {(NV_CHAR *) &hd.station_bits},
    },
    {
        "[DATUM OFFSET BITS]",
        "ui32",
        {(NV_CHAR *) &hd.datum_offset_bits},
    },
    {
        "[DATUM OFFSET SCALE]",
        "ui32",
        {(NV_CHAR *) &hd.datum_offset_scale},
    },
    {
        "[DATE BITS]",
        "ui32",
        {(NV_CHAR *) &hd.date_bits},
    },
    {
        "[MONTHS ON STATION BITS]",
        "ui32",
        {(NV_CHAR *) &hd.months_on_station_bits},
    },
    {
        "[CONFIDENCE VALUE BITS]",
        "ui32",
        {(NV_CHAR *) &hd.confidence_value_bits},
    },
    {
        "[TIME BITS]",
        "ui32",
        {(NV_CHAR *) &hd.time_bits},
    },
    {
        "[LEVEL ADD BITS]",
        "ui32",
        {(NV_CHAR *) &hd.level_add_bits},
    },
    {
        "[LEVEL ADD SCALE]",
        "ui32",
        {(NV_CHAR *) &hd.level_add_scale},
    },
    {
        "[LEVEL MULTIPLY BITS]",
        "ui32",
        {(NV_CHAR *) &hd.level_multiply_bits},
    },
    {
        "[LEVEL MULTIPLY SCALE]",
        "ui32",
        {(NV_CHAR *) &hd.level_multiply_scale},
    },
    {
        "[DIRECTION BITS]",
        "ui32",
        {(NV_CHAR *) &hd.direction_bits},
    },
    {
        "[CONSTITUENT SIZE]",
        "ui32",
        {(NV_CHAR *) &hd.constituent_size},
    },
    {
        "[LEVEL UNIT SIZE]",
        "ui32",
        {(NV_CHAR *) &hd.level_unit_size},
    },
    {
        "[DIRECTION UNIT SIZE]",
        "ui32",
        {(NV_CHAR *) &hd.dir_unit_size},
    },
    {
        "[RESTRICTION SIZE]",
        "ui32",
        {(NV_CHAR *) &hd.restriction_size},
    },
    {
        "[PEDIGREE SIZE]",
        "ui32",
        {(NV_CHAR *) &hd.pedigree_size},
    },
    {
        "[TZFILE SIZE]",
        "ui32",
        {(NV_CHAR *) &hd.tzfile_size},
    },
    {
        "[COUNTRY SIZE]",
        "ui32",
        {(NV_CHAR *) &hd.country_size},
    },
    {
        "[DATUM SIZE]",
        "ui32",
        {(NV_CHAR *) &hd.datum_size},
    },
    {
        "[LEGALESE SIZE]",
        "ui32",
        {(NV_CHAR *) &hd.legalese_size},
    },
    {
        "[END OF FILE]",
        "ui32",
        {(NV_CHAR *) &hd.end_of_file},
    }
};
#endif