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
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>CODA General</title>
<link href="../css/codadoc.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
</head>
<body>
<div class="wide">
<center>
<a class="qindex" href="index.html">Main Page</a>
<a class="qindex" href="modules.html">Modules</a>
</center>
<hr>
<!-- Generated by Doxygen 1.9.3 -->
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> |
<a href="#var-members">Variables</a> </div>
<div class="headertitle"><div class="title">CODA General</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga23cf6b5f0dccbf849cf656acd3f5b211"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coda__general.html#ga23cf6b5f0dccbf849cf656acd3f5b211">CODA_MAX_NUM_DIMS</a>   8</td></tr>
<tr class="separator:ga23cf6b5f0dccbf849cf656acd3f5b211"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga43bbecf10194ddde79f34f1111b7597c"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="group__coda__general.html#ga5585c4e41c797b14f3dd4ac5f5e20ec7">coda_array_ordering_enum</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coda__general.html#ga43bbecf10194ddde79f34f1111b7597c">coda_array_ordering</a></td></tr>
<tr class="separator:ga43bbecf10194ddde79f34f1111b7597c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8e2552c6f87737610ef2bcce876e9e06"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="group__coda__general.html#gaa2755a0de120036aa9d4ae5adccd769b">coda_format_enum</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coda__general.html#ga8e2552c6f87737610ef2bcce876e9e06">coda_format</a></td></tr>
<tr class="separator:ga8e2552c6f87737610ef2bcce876e9e06"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9db8ea3d16c2944c2e3dcf1952d94bb2"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="group__coda__general.html#gaee4781f4dd13a19806e599480b566c57">coda_filefilter_status_enum</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coda__general.html#ga9db8ea3d16c2944c2e3dcf1952d94bb2">coda_filefilter_status</a></td></tr>
<tr class="separator:ga9db8ea3d16c2944c2e3dcf1952d94bb2"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga5585c4e41c797b14f3dd4ac5f5e20ec7"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coda__general.html#ga5585c4e41c797b14f3dd4ac5f5e20ec7">coda_array_ordering_enum</a> { <br />
  <a class="el" href="group__coda__general.html#gga5585c4e41c797b14f3dd4ac5f5e20ec7a3bb5ab26bb40b1597da2eafbd8e46454">coda_array_ordering_c</a>
, <br />
  <a class="el" href="group__coda__general.html#gga5585c4e41c797b14f3dd4ac5f5e20ec7a6f530dfe688c288f37ff5bbe2ce1e95b">coda_array_ordering_fortran</a>
<br />
}</td></tr>
<tr class="separator:ga5585c4e41c797b14f3dd4ac5f5e20ec7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaee4781f4dd13a19806e599480b566c57"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coda__general.html#gaee4781f4dd13a19806e599480b566c57">coda_filefilter_status_enum</a> { <br />
  <a class="el" href="group__coda__general.html#ggaee4781f4dd13a19806e599480b566c57a6993a6dd9b80e2def92edf04172c5e48">coda_ffs_error</a>
, <br />
  <a class="el" href="group__coda__general.html#ggaee4781f4dd13a19806e599480b566c57ac953286f8deb2ca9ee4676593966e480">coda_ffs_could_not_open_file</a>
, <br />
  <a class="el" href="group__coda__general.html#ggaee4781f4dd13a19806e599480b566c57aadcace5116629c0fa805109cd7894607">coda_ffs_could_not_access_directory</a>
, <br />
  <a class="el" href="group__coda__general.html#ggaee4781f4dd13a19806e599480b566c57abbdd4b1445d884350a1f2b749878c7ef">coda_ffs_unsupported_file</a>
, <br />
  <a class="el" href="group__coda__general.html#ggaee4781f4dd13a19806e599480b566c57aa4bb836accb7c2dc35ceec5e59f3a1f8">coda_ffs_match</a>
, <br />
  <a class="el" href="group__coda__general.html#ggaee4781f4dd13a19806e599480b566c57a1b7f80b816dec50104deeebbe30c1096">coda_ffs_no_match</a>
<br />
}</td></tr>
<tr class="separator:gaee4781f4dd13a19806e599480b566c57"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa2755a0de120036aa9d4ae5adccd769b"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coda__general.html#gaa2755a0de120036aa9d4ae5adccd769b">coda_format_enum</a> { <br />
  <a class="el" href="group__coda__general.html#ggaa2755a0de120036aa9d4ae5adccd769ba82ed12d5cf11e6816c033afe01fef186">coda_format_ascii</a>
, <br />
  <a class="el" href="group__coda__general.html#ggaa2755a0de120036aa9d4ae5adccd769ba64a39b8036681a5be687bd2695d802fc">coda_format_binary</a>
, <br />
  <a class="el" href="group__coda__general.html#ggaa2755a0de120036aa9d4ae5adccd769ba420800127ed942cffee17b05acfbc0fd">coda_format_xml</a>
, <br />
  <a class="el" href="group__coda__general.html#ggaa2755a0de120036aa9d4ae5adccd769baa712e74795740aa979b048e4bd45140e">coda_format_hdf4</a>
, <br />
  <a class="el" href="group__coda__general.html#ggaa2755a0de120036aa9d4ae5adccd769ba2d7afd4945e73b340e10ea02029e739e">coda_format_hdf5</a>
, <br />
  <a class="el" href="group__coda__general.html#ggaa2755a0de120036aa9d4ae5adccd769ba462b0f462efb92af76f1b1041860a5fa">coda_format_cdf</a>
, <br />
  <a class="el" href="group__coda__general.html#ggaa2755a0de120036aa9d4ae5adccd769ba34c3f5f5b78a7ef64d4bd6b5d5783e85">coda_format_netcdf</a>
, <br />
  <a class="el" href="group__coda__general.html#ggaa2755a0de120036aa9d4ae5adccd769babad3285480df3b2f346acb5633e64c81">coda_format_grib</a>
, <br />
  <a class="el" href="group__coda__general.html#ggaa2755a0de120036aa9d4ae5adccd769baf0aae2ffa9369a858b62781423efa7d5">coda_format_rinex</a>
, <br />
  <a class="el" href="group__coda__general.html#ggaa2755a0de120036aa9d4ae5adccd769baadeaae072e8e19695474a45f7fedf41e">coda_format_sp3</a>
<br />
}</td></tr>
<tr class="separator:gaa2755a0de120036aa9d4ae5adccd769b"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga3e9633ec8b90495664e15581b7c5e20f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coda__general.html#ga3e9633ec8b90495664e15581b7c5e20f">coda_match_filefilter</a> (const char *filefilter, int num_filepaths, const char **filepathlist, int(*callbackfunc)(const char *, <a class="el" href="group__coda__general.html#ga9db8ea3d16c2944c2e3dcf1952d94bb2">coda_filefilter_status</a>, const char *, void *), void *userdata)</td></tr>
<tr class="separator:ga3e9633ec8b90495664e15581b7c5e20f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2ce9fe0cb6bac604e8ec7f44f7b3e9e2"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coda__general.html#ga2ce9fe0cb6bac604e8ec7f44f7b3e9e2">coda_c_index_to_fortran_index</a> (int num_dims, const long dim[], long index)</td></tr>
<tr class="separator:ga2ce9fe0cb6bac604e8ec7f44f7b3e9e2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac8389c5663aa9081fc5c0f288969ff34"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coda__general.html#gac8389c5663aa9081fc5c0f288969ff34">coda_isNaN</a> (double x)</td></tr>
<tr class="separator:gac8389c5663aa9081fc5c0f288969ff34"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga15ef3be4f230cf5e5e8f181592406047"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coda__general.html#ga15ef3be4f230cf5e5e8f181592406047">coda_NaN</a> (void)</td></tr>
<tr class="separator:ga15ef3be4f230cf5e5e8f181592406047"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacde31207e94dc36118fdfa574b14afad"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coda__general.html#gacde31207e94dc36118fdfa574b14afad">coda_isInf</a> (double x)</td></tr>
<tr class="separator:gacde31207e94dc36118fdfa574b14afad"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4757d44679a3943a249583381e0f4ded"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coda__general.html#ga4757d44679a3943a249583381e0f4ded">coda_isPlusInf</a> (double x)</td></tr>
<tr class="separator:ga4757d44679a3943a249583381e0f4ded"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadf74bb04403df2f77c1fd7ea0d865064"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coda__general.html#gadf74bb04403df2f77c1fd7ea0d865064">coda_isMinInf</a> (double x)</td></tr>
<tr class="separator:gadf74bb04403df2f77c1fd7ea0d865064"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa5de36117493ff0ebfeb1b33faac7b08"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coda__general.html#gaa5de36117493ff0ebfeb1b33faac7b08">coda_PlusInf</a> (void)</td></tr>
<tr class="separator:gaa5de36117493ff0ebfeb1b33faac7b08"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1102753578c395f57447ef4e4ac6ebcb"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coda__general.html#ga1102753578c395f57447ef4e4ac6ebcb">coda_MinInf</a> (void)</td></tr>
<tr class="separator:ga1102753578c395f57447ef4e4ac6ebcb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga36e969eed0cb46d34222b65374708573"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coda__general.html#ga36e969eed0cb46d34222b65374708573">coda_str64</a> (int64_t a, char *s)</td></tr>
<tr class="separator:ga36e969eed0cb46d34222b65374708573"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga79b65ef3ffad25590a693f05878d2428"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coda__general.html#ga79b65ef3ffad25590a693f05878d2428">coda_str64u</a> (uint64_t a, char *s)</td></tr>
<tr class="separator:ga79b65ef3ffad25590a693f05878d2428"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabc0fecd1bc7442a533265f5e36d43ce7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coda__general.html#gabc0fecd1bc7442a533265f5e36d43ce7">coda_strfl</a> (double a, char *s)</td></tr>
<tr class="separator:gabc0fecd1bc7442a533265f5e36d43ce7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga128ac196262a6c4b458e09569bd93104"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coda__general.html#ga128ac196262a6c4b458e09569bd93104">coda_set_option_bypass_special_types</a> (int enable)</td></tr>
<tr class="separator:ga128ac196262a6c4b458e09569bd93104"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga60b6e5fc6d33e81c37556b54f183f70e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coda__general.html#ga60b6e5fc6d33e81c37556b54f183f70e">coda_get_option_bypass_special_types</a> (void)</td></tr>
<tr class="separator:ga60b6e5fc6d33e81c37556b54f183f70e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5d7dcdb4e6b3e6fa1bbf1981b14bb371"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coda__general.html#ga5d7dcdb4e6b3e6fa1bbf1981b14bb371">coda_set_option_perform_boundary_checks</a> (int enable)</td></tr>
<tr class="separator:ga5d7dcdb4e6b3e6fa1bbf1981b14bb371"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab083bccaadc71deac76864903b9b09a7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coda__general.html#gab083bccaadc71deac76864903b9b09a7">coda_get_option_perform_boundary_checks</a> (void)</td></tr>
<tr class="separator:gab083bccaadc71deac76864903b9b09a7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5b9aba6faa0583c70bdcd9add6e72cae"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coda__general.html#ga5b9aba6faa0583c70bdcd9add6e72cae">coda_set_option_perform_conversions</a> (int enable)</td></tr>
<tr class="separator:ga5b9aba6faa0583c70bdcd9add6e72cae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga25c1d7d2664eda85fa59a5e072a00b29"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coda__general.html#ga25c1d7d2664eda85fa59a5e072a00b29">coda_get_option_perform_conversions</a> (void)</td></tr>
<tr class="separator:ga25c1d7d2664eda85fa59a5e072a00b29"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga37ed476c701bc72bf3a389ac52cac890"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coda__general.html#ga37ed476c701bc72bf3a389ac52cac890">coda_set_option_use_fast_size_expressions</a> (int enable)</td></tr>
<tr class="separator:ga37ed476c701bc72bf3a389ac52cac890"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1bd740df65b8682bea3225631fbbc506"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coda__general.html#ga1bd740df65b8682bea3225631fbbc506">coda_get_option_use_fast_size_expressions</a> (void)</td></tr>
<tr class="separator:ga1bd740df65b8682bea3225631fbbc506"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1c56d546f9056be24e193b24264b8f1d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coda__general.html#ga1c56d546f9056be24e193b24264b8f1d">coda_set_option_use_mmap</a> (int enable)</td></tr>
<tr class="separator:ga1c56d546f9056be24e193b24264b8f1d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaee6b34e64b90cb41f006e67ee55637c3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coda__general.html#gaee6b34e64b90cb41f006e67ee55637c3">coda_get_option_use_mmap</a> (void)</td></tr>
<tr class="separator:gaee6b34e64b90cb41f006e67ee55637c3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4a7e44bcb241c93a6b29e4c7f8cecadb"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coda__general.html#ga4a7e44bcb241c93a6b29e4c7f8cecadb">coda_set_definition_path</a> (const char *path)</td></tr>
<tr class="separator:ga4a7e44bcb241c93a6b29e4c7f8cecadb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0daf1c73a52691328861759fe07457fa"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coda__general.html#ga0daf1c73a52691328861759fe07457fa">coda_set_definition_path_conditional</a> (const char *file, const char *searchpath, const char *relative_location)</td></tr>
<tr class="separator:ga0daf1c73a52691328861759fe07457fa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8e7601eb0f115a4052e4af96668b3429"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coda__general.html#ga8e7601eb0f115a4052e4af96668b3429">coda_init</a> (void)</td></tr>
<tr class="separator:ga8e7601eb0f115a4052e4af96668b3429"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf238ffee3073c81b6e80fb03d9968386"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coda__general.html#gaf238ffee3073c81b6e80fb03d9968386">coda_done</a> (void)</td></tr>
<tr class="separator:gaf238ffee3073c81b6e80fb03d9968386"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacbf60303b9f9e5b9ffea8a31cfa08072"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coda__general.html#gacbf60303b9f9e5b9ffea8a31cfa08072">coda_free</a> (void *ptr)</td></tr>
<tr class="separator:gacbf60303b9f9e5b9ffea8a31cfa08072"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:ga5fe4faf55474bc440525d4a4301b943d"><td class="memItemLeft" align="right" valign="top">THREAD_LOCAL const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coda__general.html#ga5fe4faf55474bc440525d4a4301b943d">libcoda_version</a></td></tr>
<tr class="separator:ga5fe4faf55474bc440525d4a4301b943d"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p >The CODA General module contains all general and miscellaneous functions and procedures of CODA.</p>
<p >This module also contains the initialization and finalization functions of CODA. Before you call any other function of CODA you should initialize CODA with a call to <a class="el" href="group__coda__general.html#ga8e7601eb0f115a4052e4af96668b3429">coda_init()</a>. This function sets up the Data Dictionary that describes all supported product files by reading all .codadef files from the CODA definition path. After you are finished with CODA you should call <a class="el" href="group__coda__general.html#gaf238ffee3073c81b6e80fb03d9968386">coda_done()</a>. This ensures that all resources that were claimed by <a class="el" href="group__coda__general.html#ga8e7601eb0f115a4052e4af96668b3429">coda_init()</a> are properly deallocated again. You should make sure, however, that all open product files are closed before you call <a class="el" href="group__coda__general.html#gaf238ffee3073c81b6e80fb03d9968386">coda_done()</a> (the function will not close the files for you). After a <a class="el" href="group__coda__general.html#gaf238ffee3073c81b6e80fb03d9968386">coda_done()</a> all product file handles and CODA cursors that still exist will become invalid and will stay invalid even after you call <a class="el" href="group__coda__general.html#ga8e7601eb0f115a4052e4af96668b3429">coda_init()</a> again. Having invalid CODA cursors is not a real problem, as long as you do not use them anymore, but having invalid product file handles means you will be stuck with unfreed memory and unclosed files.</p>
<p >In order to let CODA know where your .codadef files are stored you will either have to set the CODA_DEFINITION environment variable or call the <a class="el" href="group__coda__general.html#ga4a7e44bcb241c93a6b29e4c7f8cecadb">coda_set_definition_path()</a> function (before calling <a class="el" href="group__coda__general.html#ga8e7601eb0f115a4052e4af96668b3429">coda_init()</a>).</p>
<p >If no .codadef files are loaded, CODA will still be able to provide access to HDF4, HDF5, netCDF, and XML products by taking the format definition from the product files itself (for XML this will be a reduced form of access, since 'leaf elements' can not be interpreted as e.g. integer/float/time but will only be accessible as string data). </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ga23cf6b5f0dccbf849cf656acd3f5b211" name="ga23cf6b5f0dccbf849cf656acd3f5b211"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga23cf6b5f0dccbf849cf656acd3f5b211">◆ </a></span>CODA_MAX_NUM_DIMS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define CODA_MAX_NUM_DIMS   8</td>
</tr>
</table>
</div><div class="memdoc">
<p >Maximum number of dimensions of a multidimensional array </p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga43bbecf10194ddde79f34f1111b7597c" name="ga43bbecf10194ddde79f34f1111b7597c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga43bbecf10194ddde79f34f1111b7597c">◆ </a></span>coda_array_ordering</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__coda__general.html#ga43bbecf10194ddde79f34f1111b7597c">coda_array_ordering</a></td>
</tr>
</table>
</div><div class="memdoc">
<p >Ordering of elements within arrays (C or Fortran variant) </p>
</div>
</div>
<a id="ga9db8ea3d16c2944c2e3dcf1952d94bb2" name="ga9db8ea3d16c2944c2e3dcf1952d94bb2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9db8ea3d16c2944c2e3dcf1952d94bb2">◆ </a></span>coda_filefilter_status</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__coda__general.html#ga9db8ea3d16c2944c2e3dcf1952d94bb2">coda_filefilter_status</a></td>
</tr>
</table>
</div><div class="memdoc">
<p >Status code that is passed to the callback function of <a class="el" href="group__coda__general.html#ga3e9633ec8b90495664e15581b7c5e20f">coda_match_filefilter()</a> </p>
</div>
</div>
<a id="ga8e2552c6f87737610ef2bcce876e9e06" name="ga8e2552c6f87737610ef2bcce876e9e06"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8e2552c6f87737610ef2bcce876e9e06">◆ </a></span>coda_format</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__coda__general.html#ga8e2552c6f87737610ef2bcce876e9e06">coda_format</a></td>
</tr>
</table>
</div><div class="memdoc">
<p >The data storage formats that are supported by CODA </p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ga5585c4e41c797b14f3dd4ac5f5e20ec7" name="ga5585c4e41c797b14f3dd4ac5f5e20ec7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5585c4e41c797b14f3dd4ac5f5e20ec7">◆ </a></span>coda_array_ordering_enum</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__coda__general.html#ga5585c4e41c797b14f3dd4ac5f5e20ec7">coda_array_ordering_enum</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga5585c4e41c797b14f3dd4ac5f5e20ec7a3bb5ab26bb40b1597da2eafbd8e46454" name="gga5585c4e41c797b14f3dd4ac5f5e20ec7a3bb5ab26bb40b1597da2eafbd8e46454"></a>coda_array_ordering_c </td><td class="fielddoc"><p >C array ordering (last dimension is fastest running) </p>
</td></tr>
<tr><td class="fieldname"><a id="gga5585c4e41c797b14f3dd4ac5f5e20ec7a6f530dfe688c288f37ff5bbe2ce1e95b" name="gga5585c4e41c797b14f3dd4ac5f5e20ec7a6f530dfe688c288f37ff5bbe2ce1e95b"></a>coda_array_ordering_fortran </td><td class="fielddoc"><p >Fortran array ordering (first dimension is fastest running) </p>
</td></tr>
</table>
</div>
</div>
<a id="gaee4781f4dd13a19806e599480b566c57" name="gaee4781f4dd13a19806e599480b566c57"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaee4781f4dd13a19806e599480b566c57">◆ </a></span>coda_filefilter_status_enum</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__coda__general.html#gaee4781f4dd13a19806e599480b566c57">coda_filefilter_status_enum</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggaee4781f4dd13a19806e599480b566c57a6993a6dd9b80e2def92edf04172c5e48" name="ggaee4781f4dd13a19806e599480b566c57a6993a6dd9b80e2def92edf04172c5e48"></a>coda_ffs_error </td><td class="fielddoc"><p >error: General error (usually file I/O related) </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaee4781f4dd13a19806e599480b566c57ac953286f8deb2ca9ee4676593966e480" name="ggaee4781f4dd13a19806e599480b566c57ac953286f8deb2ca9ee4676593966e480"></a>coda_ffs_could_not_open_file </td><td class="fielddoc"><p >error: Could not open file </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaee4781f4dd13a19806e599480b566c57aadcace5116629c0fa805109cd7894607" name="ggaee4781f4dd13a19806e599480b566c57aadcace5116629c0fa805109cd7894607"></a>coda_ffs_could_not_access_directory </td><td class="fielddoc"><p >error: Could not recurse into directory </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaee4781f4dd13a19806e599480b566c57abbdd4b1445d884350a1f2b749878c7ef" name="ggaee4781f4dd13a19806e599480b566c57abbdd4b1445d884350a1f2b749878c7ef"></a>coda_ffs_unsupported_file </td><td class="fielddoc"><p >File can not be read by CODA </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaee4781f4dd13a19806e599480b566c57aa4bb836accb7c2dc35ceec5e59f3a1f8" name="ggaee4781f4dd13a19806e599480b566c57aa4bb836accb7c2dc35ceec5e59f3a1f8"></a>coda_ffs_match </td><td class="fielddoc"><p >File matches filter </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaee4781f4dd13a19806e599480b566c57a1b7f80b816dec50104deeebbe30c1096" name="ggaee4781f4dd13a19806e599480b566c57a1b7f80b816dec50104deeebbe30c1096"></a>coda_ffs_no_match </td><td class="fielddoc"><p >File does not match filter </p>
</td></tr>
</table>
</div>
</div>
<a id="gaa2755a0de120036aa9d4ae5adccd769b" name="gaa2755a0de120036aa9d4ae5adccd769b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa2755a0de120036aa9d4ae5adccd769b">◆ </a></span>coda_format_enum</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__coda__general.html#gaa2755a0de120036aa9d4ae5adccd769b">coda_format_enum</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggaa2755a0de120036aa9d4ae5adccd769ba82ed12d5cf11e6816c033afe01fef186" name="ggaa2755a0de120036aa9d4ae5adccd769ba82ed12d5cf11e6816c033afe01fef186"></a>coda_format_ascii </td><td class="fielddoc"><p >Data stored in structured ASCII format </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaa2755a0de120036aa9d4ae5adccd769ba64a39b8036681a5be687bd2695d802fc" name="ggaa2755a0de120036aa9d4ae5adccd769ba64a39b8036681a5be687bd2695d802fc"></a>coda_format_binary </td><td class="fielddoc"><p >Data stored in structured binary format </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaa2755a0de120036aa9d4ae5adccd769ba420800127ed942cffee17b05acfbc0fd" name="ggaa2755a0de120036aa9d4ae5adccd769ba420800127ed942cffee17b05acfbc0fd"></a>coda_format_xml </td><td class="fielddoc"><p >Data stored in XML format </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaa2755a0de120036aa9d4ae5adccd769baa712e74795740aa979b048e4bd45140e" name="ggaa2755a0de120036aa9d4ae5adccd769baa712e74795740aa979b048e4bd45140e"></a>coda_format_hdf4 </td><td class="fielddoc"><p >Data stored in HDF4 format </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaa2755a0de120036aa9d4ae5adccd769ba2d7afd4945e73b340e10ea02029e739e" name="ggaa2755a0de120036aa9d4ae5adccd769ba2d7afd4945e73b340e10ea02029e739e"></a>coda_format_hdf5 </td><td class="fielddoc"><p >Data stored in HDF5 format </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaa2755a0de120036aa9d4ae5adccd769ba462b0f462efb92af76f1b1041860a5fa" name="ggaa2755a0de120036aa9d4ae5adccd769ba462b0f462efb92af76f1b1041860a5fa"></a>coda_format_cdf </td><td class="fielddoc"><p >Data stored in CDF format </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaa2755a0de120036aa9d4ae5adccd769ba34c3f5f5b78a7ef64d4bd6b5d5783e85" name="ggaa2755a0de120036aa9d4ae5adccd769ba34c3f5f5b78a7ef64d4bd6b5d5783e85"></a>coda_format_netcdf </td><td class="fielddoc"><p >Data stored in NetCDF format </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaa2755a0de120036aa9d4ae5adccd769babad3285480df3b2f346acb5633e64c81" name="ggaa2755a0de120036aa9d4ae5adccd769babad3285480df3b2f346acb5633e64c81"></a>coda_format_grib </td><td class="fielddoc"><p >Data stored in GRIB format </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaa2755a0de120036aa9d4ae5adccd769baf0aae2ffa9369a858b62781423efa7d5" name="ggaa2755a0de120036aa9d4ae5adccd769baf0aae2ffa9369a858b62781423efa7d5"></a>coda_format_rinex </td><td class="fielddoc"><p >Data stored in RINEX format </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaa2755a0de120036aa9d4ae5adccd769baadeaae072e8e19695474a45f7fedf41e" name="ggaa2755a0de120036aa9d4ae5adccd769baadeaae072e8e19695474a45f7fedf41e"></a>coda_format_sp3 </td><td class="fielddoc"><p >Data stored in SP3 format </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga2ce9fe0cb6bac604e8ec7f44f7b3e9e2" name="ga2ce9fe0cb6bac604e8ec7f44f7b3e9e2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2ce9fe0cb6bac604e8ec7f44f7b3e9e2">◆ </a></span>coda_c_index_to_fortran_index()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long coda_c_index_to_fortran_index </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>num_dims</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const long </td>
<td class="paramname"><em>dim</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>index</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Convert an index for a multidimensional array that is stored in C-style order to an index for an identical array stored in Fortran-style order.</p>
<p >While elements of a multidimensional array are normally referenced via subscripts, CODA also allows referencing through indices (which are one-dimensional). These indices (starting with 0) correspond with the positions of the array elements as they are physically stored. This makes it easy to enumerate all elements of a multi-dimensional array without having to deal with the multidimensional aspects of an array.</p>
<p >However, the mapping of an array of subscripts to an index/storage position (and vice versa) can be defined in essentially two ways.</p>
<p >The first, which is the way it is done in CODA is such that the <em>last</em> element of a subscript array is the one that is the fastest running. For example, for a two dimensional array, the second element would have index 1 and would correspond with the subscript (0, 1). This corresponds to the way multi-dimensional arrays are handled in C and therefore this type of index is called a C-style index.</p>
<p >The alternative way of providing an index is as it is done in Fortran, which has the <em>first</em> element of a subscript array as the fastest running. In the previous example, the second element of the two dimensional array with index 1 would correspond to the subscript (1, 0).</p>
<p >As an example, if we have an array with dimensions (3, 4), then the subscript (0, 2) would refer to the element with index 2 if the array was stored in C-style and would refer to the element with index 6 if it was stored in Fortran-style.</p>
<p >In order for a user to fill a multidimensional array in Fortran-style with data from a multi-dimensional array from a product using CODA (which uses C-style indexing), the user can use this function to provide the index conversions. A small example showing how this would be done with a multi-dimensional array of doubles: </p><div class="fragment"><div class="line"><a class="code hl_function" href="group__coda__cursor.html#gab9e4cc79aea8d6f50f8406c2fddc66c8">coda_cursor_get_num_elements</a>(cursor, &num_elements);</div>
<div class="line"><span class="keywordflow">if</span> (num_elements > 0)</div>
<div class="line">{</div>
<div class="line"> <a class="code hl_function" href="group__coda__cursor.html#gac383bb48a0aef63af6c128e8af96238a">coda_cursor_get_array_dim</a>(cursor, &num_dim, dims);</div>
<div class="line"> <a class="code hl_function" href="group__coda__cursor.html#ga90362bd9b257866af5373f43947925f4">coda_cursor_goto_first_array_element</a>(cursor);</div>
<div class="line"> <span class="keywordflow">for</span> (i = 0; i < num_elements; i++)</div>
<div class="line"> {</div>
<div class="line"> <span class="keywordtype">int</span> fortran_index = <a class="code hl_function" href="group__coda__general.html#ga2ce9fe0cb6bac604e8ec7f44f7b3e9e2">coda_c_index_to_fortran_index</a>(num_dim, dims, i);</div>
<div class="line"> <a class="code hl_function" href="group__coda__cursor.html#gab4aa54ab5f18c8827435c834dc0415f9">coda_cursor_read_double</a>(cursor, &fortran_multidim_array_ptr[fortran_index]);</div>
<div class="line"> <span class="keywordflow">if</span> (i < num_elements - 1)</div>
<div class="line"> {</div>
<div class="line"> <a class="code hl_function" href="group__coda__cursor.html#gaf0251269bb9774efc232cf6771ca9692">coda_cursor_goto_next_array_element</a>(cursor);</div>
<div class="line"> }</div>
<div class="line"> }</div>
<div class="line"> <a class="code hl_function" href="group__coda__cursor.html#gadbb9fba27af87d3b854194316a1f8c08">coda_cursor_goto_parent</a>(cursor);</div>
<div class="line">}</div>
<div class="ttc" id="agroup__coda__cursor_html_ga90362bd9b257866af5373f43947925f4"><div class="ttname"><a href="group__coda__cursor.html#ga90362bd9b257866af5373f43947925f4">coda_cursor_goto_first_array_element</a></div><div class="ttdeci">int coda_cursor_goto_first_array_element(coda_cursor *cursor)</div><div class="ttdef"><b>Definition:</b> coda-cursor.c:859</div></div>
<div class="ttc" id="agroup__coda__cursor_html_gab4aa54ab5f18c8827435c834dc0415f9"><div class="ttname"><a href="group__coda__cursor.html#gab4aa54ab5f18c8827435c834dc0415f9">coda_cursor_read_double</a></div><div class="ttdeci">int coda_cursor_read_double(const coda_cursor *cursor, double *dst)</div><div class="ttdef"><b>Definition:</b> coda-cursor-read.c:2536</div></div>
<div class="ttc" id="agroup__coda__cursor_html_gab9e4cc79aea8d6f50f8406c2fddc66c8"><div class="ttname"><a href="group__coda__cursor.html#gab9e4cc79aea8d6f50f8406c2fddc66c8">coda_cursor_get_num_elements</a></div><div class="ttdeci">int coda_cursor_get_num_elements(const coda_cursor *cursor, long *num_elements)</div><div class="ttdef"><b>Definition:</b> coda-cursor.c:1695</div></div>
<div class="ttc" id="agroup__coda__cursor_html_gac383bb48a0aef63af6c128e8af96238a"><div class="ttname"><a href="group__coda__cursor.html#gac383bb48a0aef63af6c128e8af96238a">coda_cursor_get_array_dim</a></div><div class="ttdeci">int coda_cursor_get_array_dim(const coda_cursor *cursor, int *num_dims, long dim[])</div><div class="ttdef"><b>Definition:</b> coda-cursor.c:2186</div></div>
<div class="ttc" id="agroup__coda__cursor_html_gadbb9fba27af87d3b854194316a1f8c08"><div class="ttname"><a href="group__coda__cursor.html#gadbb9fba27af87d3b854194316a1f8c08">coda_cursor_goto_parent</a></div><div class="ttdeci">int coda_cursor_goto_parent(coda_cursor *cursor)</div><div class="ttdef"><b>Definition:</b> coda-cursor.c:1324</div></div>
<div class="ttc" id="agroup__coda__cursor_html_gaf0251269bb9774efc232cf6771ca9692"><div class="ttname"><a href="group__coda__cursor.html#gaf0251269bb9774efc232cf6771ca9692">coda_cursor_goto_next_array_element</a></div><div class="ttdeci">int coda_cursor_goto_next_array_element(coda_cursor *cursor)</div><div class="ttdef"><b>Definition:</b> coda-cursor.c:1123</div></div>
<div class="ttc" id="agroup__coda__general_html_ga2ce9fe0cb6bac604e8ec7f44f7b3e9e2"><div class="ttname"><a href="group__coda__general.html#ga2ce9fe0cb6bac604e8ec7f44f7b3e9e2">coda_c_index_to_fortran_index</a></div><div class="ttdeci">long coda_c_index_to_fortran_index(int num_dims, const long dim[], long index)</div><div class="ttdef"><b>Definition:</b> coda-utils.c:269</div></div>
</div><!-- fragment --><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__coda__cursor.html#ga08300afc8797ef5bba44b2acb316bdaf">coda_cursor_goto_array_element_by_index()</a> </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">num_dims</td><td>Number of dimensions of the multidimensional array. </td></tr>
<tr><td class="paramname">dim</td><td>Array with the dimensions of the multidimensional array. </td></tr>
<tr><td class="paramname">index</td><td><code>C</code> style index. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li><code>>=0</code>, <code>Fortran</code> style index. </li>
<li><code>-1</code>, Error occurred (check <a class="el" href="group__coda__error.html#gafcb445c7fcab2d4d0af01f0e1c2dc866">coda_errno</a>). </li>
</ul>
</dd></dl>
</div>
</div>
<a id="gaf238ffee3073c81b6e80fb03d9968386" name="gaf238ffee3073c81b6e80fb03d9968386"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf238ffee3073c81b6e80fb03d9968386">◆ </a></span>coda_done()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void coda_done </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Finalizes CODA. This function should be called to let the CODA library free up any resources it has claimed since initialization. It won't however clean up any product file handlers or close any product files that are still open. So you should first close any products that are still open with <a class="el" href="group__coda__product.html#gad81f6fd1300679fe3715d78953d96cc8">coda_close()</a> before calling this function.</p>
<p >It is valid to perform multiple calls to <a class="el" href="group__coda__general.html#ga8e7601eb0f115a4052e4af96668b3429">coda_init()</a> after each other. Only the first call to <a class="el" href="group__coda__general.html#ga8e7601eb0f115a4052e4af96668b3429">coda_init()</a> will do the actual initialization and all following calls to <a class="el" href="group__coda__general.html#ga8e7601eb0f115a4052e4af96668b3429">coda_init()</a> will only increase an initialization counter. Each call to <a class="el" href="group__coda__general.html#ga8e7601eb0f115a4052e4af96668b3429">coda_init()</a> needs to be matched by a call to <a class="el" href="group__coda__general.html#gaf238ffee3073c81b6e80fb03d9968386">coda_done()</a> at clean-up time (i.e. the amount of calls to <a class="el" href="group__coda__general.html#gaf238ffee3073c81b6e80fb03d9968386">coda_done()</a> needs to be equal to the amount of calls to <a class="el" href="group__coda__general.html#ga8e7601eb0f115a4052e4af96668b3429">coda_init()</a>). Only the last <a class="el" href="group__coda__general.html#gaf238ffee3073c81b6e80fb03d9968386">coda_done()</a> call (when the initialization counter has reached 0) will do the actual clean-up of CODA. The clean-up will also reset any definition path that was set with <a class="el" href="group__coda__general.html#ga4a7e44bcb241c93a6b29e4c7f8cecadb">coda_set_definition_path()</a> or <a class="el" href="group__coda__general.html#ga0daf1c73a52691328861759fe07457fa">coda_set_definition_path_conditional()</a>.</p>
<p >Calling a CODA function other than <a class="el" href="group__coda__general.html#ga8e7601eb0f115a4052e4af96668b3429">coda_init()</a> after the final <a class="el" href="group__coda__general.html#gaf238ffee3073c81b6e80fb03d9968386">coda_done()</a> will result in undefined behavior. After reinitializing CODA again, accessing a product that was left open from a previous CODA 'session' will also result in undefined behavior. </p>
</div>
</div>
<a id="gacbf60303b9f9e5b9ffea8a31cfa08072" name="gacbf60303b9f9e5b9ffea8a31cfa08072"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacbf60303b9f9e5b9ffea8a31cfa08072">◆ </a></span>coda_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void coda_free </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>ptr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Free a memory block that was allocated by the CODA library. In some environments the library that performs the malloc is also the one that needs to perform the free. With this function memory that was allocated within the CODA library can be deallocated for such environments. It should be used in the following cases:</p><ul>
<li>to deallocate the memory for the 'value' variables of <a class="el" href="group__coda__expression.html#ga55319b1ccc2afae12eb6512e950cf079">coda_expression_eval_string()</a> <dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ptr</td><td>The pointer whose memory should be freed. </td></tr>
</table>
</dd>
</dl>
</li>
</ul>
</div>
</div>
<a id="ga60b6e5fc6d33e81c37556b54f183f70e" name="ga60b6e5fc6d33e81c37556b54f183f70e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga60b6e5fc6d33e81c37556b54f183f70e">◆ </a></span>coda_get_option_bypass_special_types()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int coda_get_option_bypass_special_types </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Retrieve the current setting for the special types bypass option. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__coda__general.html#ga128ac196262a6c4b458e09569bd93104">coda_set_option_bypass_special_types()</a> </dd></dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li><code>0</code>, Bypassing of special types is disabled. </li>
<li><code>1</code>, Bypassing of special types is enabled. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="gab083bccaadc71deac76864903b9b09a7" name="gab083bccaadc71deac76864903b9b09a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab083bccaadc71deac76864903b9b09a7">◆ </a></span>coda_get_option_perform_boundary_checks()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int coda_get_option_perform_boundary_checks </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Retrieve the current setting for the boundary check option. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__coda__general.html#ga5d7dcdb4e6b3e6fa1bbf1981b14bb371">coda_set_option_perform_boundary_checks()</a> </dd></dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li><code>0</code>, Boundary checking is disabled. </li>
<li><code>1</code>, Boundary checking is enabled. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="ga25c1d7d2664eda85fa59a5e072a00b29" name="ga25c1d7d2664eda85fa59a5e072a00b29"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga25c1d7d2664eda85fa59a5e072a00b29">◆ </a></span>coda_get_option_perform_conversions()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int coda_get_option_perform_conversions </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Retrieve the current setting for the value/unit conversion option. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__coda__general.html#ga5b9aba6faa0583c70bdcd9add6e72cae">coda_set_option_perform_conversions()</a> </dd></dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li><code>0</code>, Unit/value conversions are disabled. </li>
<li><code>1</code>, Unit/value conversions are enabled. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="ga1bd740df65b8682bea3225631fbbc506" name="ga1bd740df65b8682bea3225631fbbc506"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1bd740df65b8682bea3225631fbbc506">◆ </a></span>coda_get_option_use_fast_size_expressions()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int coda_get_option_use_fast_size_expressions </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Retrieve the current setting for the use of fast size expressions option. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__coda__general.html#ga37ed476c701bc72bf3a389ac52cac890">coda_set_option_use_fast_size_expressions()</a> </dd></dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li><code>0</code>, Unit/value conversions are disabled. </li>
<li><code>1</code>, Unit/value conversions are enabled. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="gaee6b34e64b90cb41f006e67ee55637c3" name="gaee6b34e64b90cb41f006e67ee55637c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaee6b34e64b90cb41f006e67ee55637c3">◆ </a></span>coda_get_option_use_mmap()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int coda_get_option_use_mmap </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Retrieve the current setting for the use of memory mapping of files. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__coda__general.html#ga1c56d546f9056be24e193b24264b8f1d">coda_set_option_use_mmap()</a> </dd></dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li><code>0</code>, Memory mapping of files is disabled. </li>
<li><code>1</code>, Memory mapping of files is enabled. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="ga8e7601eb0f115a4052e4af96668b3429" name="ga8e7601eb0f115a4052e4af96668b3429"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8e7601eb0f115a4052e4af96668b3429">◆ </a></span>coda_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int coda_init </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Initializes CODA. This function should be called before any other CODA function is called (except for <a class="el" href="group__coda__general.html#ga4a7e44bcb241c93a6b29e4c7f8cecadb">coda_set_definition_path()</a>).</p>
<p >If you want to use CODA to access non self-describing products (i.e. where the definition is provided via a .codadef file), you will have the set the CODA definition path to the location of your .codadef files before you call <a class="el" href="group__coda__general.html#ga8e7601eb0f115a4052e4af96668b3429">coda_init()</a>. This can be done either via <a class="el" href="group__coda__general.html#ga4a7e44bcb241c93a6b29e4c7f8cecadb">coda_set_definition_path()</a> or via the CODA_DEFINITION environment variable.</p>
<p >It is valid to perform multiple calls to <a class="el" href="group__coda__general.html#ga8e7601eb0f115a4052e4af96668b3429">coda_init()</a> after each other. Only the first call to <a class="el" href="group__coda__general.html#ga8e7601eb0f115a4052e4af96668b3429">coda_init()</a> will do the actual initialization and all following calls to <a class="el" href="group__coda__general.html#ga8e7601eb0f115a4052e4af96668b3429">coda_init()</a> will only increase an initialization counter (this also means that it is important that you set the CODA definition path before the first call to <a class="el" href="group__coda__general.html#ga8e7601eb0f115a4052e4af96668b3429">coda_init()</a> is performed; changing the CODA definition path afterwards will have no effect). Each call to <a class="el" href="group__coda__general.html#ga8e7601eb0f115a4052e4af96668b3429">coda_init()</a> needs to be matched by a call to <a class="el" href="group__coda__general.html#gaf238ffee3073c81b6e80fb03d9968386">coda_done()</a> at clean-up time (i.e. the amount of calls to <a class="el" href="group__coda__general.html#gaf238ffee3073c81b6e80fb03d9968386">coda_done()</a> needs to be equal to the amount of calls to <a class="el" href="group__coda__general.html#ga8e7601eb0f115a4052e4af96668b3429">coda_init()</a>). Only the last <a class="el" href="group__coda__general.html#gaf238ffee3073c81b6e80fb03d9968386">coda_done()</a> call (when the initialization counter has reached 0) will do the actual clean-up of CODA. </p><dl class="section return"><dt>Returns</dt><dd><ul>
<li><code>0</code>, Success. </li>
<li><code>-1</code>, Error occurred (check <a class="el" href="group__coda__error.html#gafcb445c7fcab2d4d0af01f0e1c2dc866">coda_errno</a>). </li>
</ul>
</dd></dl>
</div>
</div>
<a id="gacde31207e94dc36118fdfa574b14afad" name="gacde31207e94dc36118fdfa574b14afad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacde31207e94dc36118fdfa574b14afad">◆ </a></span>coda_isInf()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int coda_isInf </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Find out whether a double value equals inf (either positive or negative infinity). </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>A double value. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li><code>1</code>, The double value equals inf. </li>
<li><code>0</code>, The double value does not equal inf. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="gadf74bb04403df2f77c1fd7ea0d865064" name="gadf74bb04403df2f77c1fd7ea0d865064"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadf74bb04403df2f77c1fd7ea0d865064">◆ </a></span>coda_isMinInf()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int coda_isMinInf </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Find out whether a double value equals -inf (negative infinity). </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>A double value. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li><code>1</code>, The double value equals -inf. </li>
<li><code>0</code>, The double value does not equal -inf. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="gac8389c5663aa9081fc5c0f288969ff34" name="gac8389c5663aa9081fc5c0f288969ff34"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac8389c5663aa9081fc5c0f288969ff34">◆ </a></span>coda_isNaN()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int coda_isNaN </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Find out whether a double value equals NaN (Not a Number). </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>A double value. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li><code>1</code>, The double value equals NaN. </li>
<li><code>0</code>, The double value does not equal NaN. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="ga4757d44679a3943a249583381e0f4ded" name="ga4757d44679a3943a249583381e0f4ded"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4757d44679a3943a249583381e0f4ded">◆ </a></span>coda_isPlusInf()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int coda_isPlusInf </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Find out whether a double value equals +inf (positive infinity). </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>A double value. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li><code>1</code>, The double value equals +inf. </li>
<li><code>0</code>, The double value does not equal +inf. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="ga3e9633ec8b90495664e15581b7c5e20f" name="ga3e9633ec8b90495664e15581b7c5e20f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3e9633ec8b90495664e15581b7c5e20f">◆ </a></span>coda_match_filefilter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int coda_match_filefilter </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>filefilter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>num_filepaths</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char ** </td>
<td class="paramname"><em>filepathlist</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int(*)(const char *, <a class="el" href="group__coda__general.html#ga9db8ea3d16c2944c2e3dcf1952d94bb2">coda_filefilter_status</a>, const char *, void *) </td>
<td class="paramname"><em>callbackfunc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>userdata</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Find product files matching a specific filter. With this function you can match a series of files or directories against a specific filter. The filter needs to be provided as a string. For information about its format please look at the documentation of the codafind tool which is also included with the CODA package. If you leave <em>filefilter</em> empty or pass a NULL pointer then each file that can be opened by CODA will be matched positively (this has the same effect as if you had passed a filefilter "true").</p>
<p >The names of the files and directories need to be passed as an array of full/relative paths. If an entry is a directory then all files and directories that are contained inside will be added to the filter matching. Directories within directories are processed recursively.</p>
<p >For each file that is processed a callback function, which will have to be provided by the user, will be called. The callback function will be passed the path of the file, a status value indicating the match result, optionally an error string in case an error happened, and the <em>userdata</em> pointer that was passed to the <a class="el" href="group__coda__general.html#ga3e9633ec8b90495664e15581b7c5e20f">coda_match_filefilter()</a> function. The return value of the callback function determines whether the rest of the files/directories should be processed. If you return 0 from the callback function then processing will continue normally. If you return a different value, then the <a class="el" href="group__coda__general.html#ga3e9633ec8b90495664e15581b7c5e20f">coda_match_filefilter()</a> function will stop further processing and return the same return value to your program as you have returned from the callback function. It is recommended not to use -1 as return value in your callback function, since <a class="el" href="group__coda__general.html#ga3e9633ec8b90495664e15581b7c5e20f">coda_match_filefilter()</a> will already return -1 if it encounters an error internally.</p>
<p >A small example of a callback function is given below </p><div class="fragment"><div class="line"><span class="keywordtype">int</span> callback(<span class="keyword">const</span> <span class="keywordtype">char</span> *filepath, <a class="code hl_typedef" href="group__coda__general.html#ga9db8ea3d16c2944c2e3dcf1952d94bb2">coda_filefilter_status</a> status, <span class="keyword">const</span> <span class="keywordtype">char</span> *error, <span class="keywordtype">void</span> *userdata)</div>
<div class="line">{</div>
<div class="line"> <span class="keywordflow">switch</span> (status)</div>
<div class="line"> {</div>
<div class="line"> <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="group__coda__general.html#ggaee4781f4dd13a19806e599480b566c57aa4bb836accb7c2dc35ceec5e59f3a1f8">coda_ffs_match</a>:</div>
<div class="line"> printf(<span class="stringliteral">"File \"%s\" matches filter!\n"</span>, filepath);</div>
<div class="line"> <span class="keywordflow">break</span>;</div>
<div class="line"> <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="group__coda__general.html#ggaee4781f4dd13a19806e599480b566c57abbdd4b1445d884350a1f2b749878c7ef">coda_ffs_unsupported_file</a>:</div>
<div class="line"> <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="group__coda__general.html#ggaee4781f4dd13a19806e599480b566c57a1b7f80b816dec50104deeebbe30c1096">coda_ffs_no_match</a>:</div>
<div class="line"> <span class="comment">// don't print anything if the file does not positively match the filter</span></div>
<div class="line"> <span class="keywordflow">break</span>;</div>
<div class="line"> <span class="keywordflow">default</span>:</div>
<div class="line"> <span class="keywordflow">if</span> (error != NULL)</div>
<div class="line"> {</div>
<div class="line"> printf(<span class="stringliteral">"ERROR: %s\n"</span>, error);</div>
<div class="line"> }</div>
<div class="line"> <span class="keywordflow">break</span>;</div>
<div class="line"> }</div>
<div class="line"> <span class="keywordflow">return</span> 0; <span class="comment">// if possible continue processing the other files</span></div>
<div class="line">}</div>
<div class="ttc" id="agroup__coda__general_html_ga9db8ea3d16c2944c2e3dcf1952d94bb2"><div class="ttname"><a href="group__coda__general.html#ga9db8ea3d16c2944c2e3dcf1952d94bb2">coda_filefilter_status</a></div><div class="ttdeci">enum coda_filefilter_status_enum coda_filefilter_status</div><div class="ttdef"><b>Definition:</b> coda.h:316</div></div>
<div class="ttc" id="agroup__coda__general_html_ggaee4781f4dd13a19806e599480b566c57a1b7f80b816dec50104deeebbe30c1096"><div class="ttname"><a href="group__coda__general.html#ggaee4781f4dd13a19806e599480b566c57a1b7f80b816dec50104deeebbe30c1096">coda_ffs_no_match</a></div><div class="ttdeci">@ coda_ffs_no_match</div><div class="ttdef"><b>Definition:</b> coda.h:236</div></div>
<div class="ttc" id="agroup__coda__general_html_ggaee4781f4dd13a19806e599480b566c57aa4bb836accb7c2dc35ceec5e59f3a1f8"><div class="ttname"><a href="group__coda__general.html#ggaee4781f4dd13a19806e599480b566c57aa4bb836accb7c2dc35ceec5e59f3a1f8">coda_ffs_match</a></div><div class="ttdeci">@ coda_ffs_match</div><div class="ttdef"><b>Definition:</b> coda.h:235</div></div>
<div class="ttc" id="agroup__coda__general_html_ggaee4781f4dd13a19806e599480b566c57abbdd4b1445d884350a1f2b749878c7ef"><div class="ttname"><a href="group__coda__general.html#ggaee4781f4dd13a19806e599480b566c57abbdd4b1445d884350a1f2b749878c7ef">coda_ffs_unsupported_file</a></div><div class="ttdeci">@ coda_ffs_unsupported_file</div><div class="ttdef"><b>Definition:</b> coda.h:234</div></div>
</div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filefilter</td><td>String containing the filter. </td></tr>
<tr><td class="paramname">num_filepaths</td><td>Number of filepaths in <em>filepathlist</em> (0 < <em>num_filepaths</em>). </td></tr>
<tr><td class="paramname">filepathlist</td><td>Array of strings containing relative or absolute paths to a series of files and/or directories that should be matched against the filefilter. </td></tr>
<tr><td class="paramname">callbackfunc</td><td>A pointer to a function that should be called with the match result of a file that has been processed. </td></tr>
<tr><td class="paramname">userdata</td><td>A pointer to a user definable data block that will be passed along to the user callback function. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li><code>0</code>, Success. </li>
<li><code>-1</code>, Error occurred (check <a class="el" href="group__coda__error.html#gafcb445c7fcab2d4d0af01f0e1c2dc866">coda_errno</a>). </li>
<li>other, The return value from the last call to the callback function. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="ga1102753578c395f57447ef4e4ac6ebcb" name="ga1102753578c395f57447ef4e4ac6ebcb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1102753578c395f57447ef4e4ac6ebcb">◆ </a></span>coda_MinInf()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double coda_MinInf </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Retrieve a double value that respresents -inf (negative infinity). </p><dl class="section return"><dt>Returns</dt><dd>The double value '-inf'. </dd></dl>
</div>
</div>
<a id="ga15ef3be4f230cf5e5e8f181592406047" name="ga15ef3be4f230cf5e5e8f181592406047"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga15ef3be4f230cf5e5e8f181592406047">◆ </a></span>coda_NaN()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double coda_NaN </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Retrieve a double value that respresents NaN (Not a Number). </p><dl class="section return"><dt>Returns</dt><dd>The double value 'NaN'. </dd></dl>
</div>
</div>
<a id="gaa5de36117493ff0ebfeb1b33faac7b08" name="gaa5de36117493ff0ebfeb1b33faac7b08"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa5de36117493ff0ebfeb1b33faac7b08">◆ </a></span>coda_PlusInf()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double coda_PlusInf </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Retrieve a double value that respresents +inf (positive infinity). </p><dl class="section return"><dt>Returns</dt><dd>The double value '+inf'. </dd></dl>
</div>
</div>
<a id="ga4a7e44bcb241c93a6b29e4c7f8cecadb" name="ga4a7e44bcb241c93a6b29e4c7f8cecadb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4a7e44bcb241c93a6b29e4c7f8cecadb">◆ </a></span>coda_set_definition_path()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int coda_set_definition_path </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>path</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Set the searchpath for CODA product definition files. This function should be called before <a class="el" href="group__coda__general.html#ga8e7601eb0f115a4052e4af96668b3429">coda_init()</a> is called.</p>
<p >The path should be a searchpath for CODA .codadef files similar like the PATH environment variable of your system. Path components should be separated by ';' on Windows and by ':' on other systems.</p>
<p >The path may contain both references to files and directories. CODA will load all .codadef files in the path. Any specified files should be valid .codadef files. For directories, CODA will (non-recursively) search the directory for all .codadef files.</p>
<p >If multiple files for the same product class exist in the path, CODA will only use the one with the highest revision number (this is normally equal to a last modification date that is stored in a .codadef file). If there are two files for the same product class with identical revision numbers, CODA will use the definitions of the first .codadef file in the path and ingore the second one.</p>
<p >Specifying a path using this function will prevent CODA from using the CODA_DEFINITION environment variable. If you still want CODA to acknowledge the CODA_DEFINITION environment variable then use something like this in your code: </p><div class="fragment"><div class="line"><span class="keywordflow">if</span> (getenv(<span class="stringliteral">"CODA_DEFINITION"</span>) == NULL)</div>
<div class="line">{</div>
<div class="line"> <a class="code hl_function" href="group__coda__general.html#ga4a7e44bcb241c93a6b29e4c7f8cecadb">coda_set_definition_path</a>(<span class="stringliteral">"<your path>"</span>);</div>
<div class="line">}</div>
<div class="ttc" id="agroup__coda__general_html_ga4a7e44bcb241c93a6b29e4c7f8cecadb"><div class="ttname"><a href="group__coda__general.html#ga4a7e44bcb241c93a6b29e4c7f8cecadb">coda_set_definition_path</a></div><div class="ttdeci">int coda_set_definition_path(const char *path)</div><div class="ttdef"><b>Definition:</b> coda.c:365</div></div>
</div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>Search path for .codadef files </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li><code>0</code>, Success. </li>
<li><code>-1</code>, Error occurred (check <a class="el" href="group__coda__error.html#gafcb445c7fcab2d4d0af01f0e1c2dc866">coda_errno</a>). </li>
</ul>
</dd></dl>
</div>
</div>
<a id="ga0daf1c73a52691328861759fe07457fa" name="ga0daf1c73a52691328861759fe07457fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0daf1c73a52691328861759fe07457fa">◆ </a></span>coda_set_definition_path_conditional()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int coda_set_definition_path_conditional </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>searchpath</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>relative_location</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Set the directory for CODA product definition files based on the location of another file. This function should be called before <a class="el" href="group__coda__general.html#ga8e7601eb0f115a4052e4af96668b3429">coda_init()</a> is called.</p>
<p >This function will try to find the file with filename <em>file</em> in the provided searchpath <em>searchpath</em>. The first directory in the searchpath where the file <em>file</em> exists will be appended with the relative directory <em>relative_location</em> to determine the CODA product definition path. This path will be used as CODA definition path. If the file could not be found in the searchpath then the CODA definition path will not be set.</p>
<p >If the CODA_DEFINITION environment variable was set then this function will not perform a search or set the definition path (i.e. the CODA definition path will be taken from the CODA_DEFINITION variable).</p>
<p >If you provide NULL for <em>searchpath</em> then the PATH environment variable will be used as searchpath. For instance, you can use coda_set_definition_path_conditional(argv[0], NULL, "../somedir") to set the CODA definition path to a location relative to the location of your executable.</p>
<p >The searchpath, if provided, should have a similar format as the PATH environment variable of your system. Path components should be separated by ';' on Windows and by ':' on other systems.</p>
<p >The <em>relative_location</em> parameter can point either to a directory (in which case all .codadef files in this directory will be used) or to a single .codadef file.</p>
<p >Note that this function differs from <a class="el" href="group__coda__general.html#ga4a7e44bcb241c93a6b29e4c7f8cecadb">coda_set_definition_path()</a> in two important ways:</p><ul>
<li>it will not modify the definition path if the CODA_DEFINITION variable was set</li>
<li>it will set the definition path to just a single location (either a single file or a single directory)</li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file</td><td>Filename of the file to search for </td></tr>
<tr><td class="paramname">searchpath</td><td>Search path where to look for the file <em>file</em> (can be NULL) </td></tr>
<tr><td class="paramname">relative_location</td><td>Filepath relative to the directory from <em>searchpath</em> where <em>file</em> was found that should be used to determine the CODA definition path. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li><code>0</code>, Success. </li>
<li><code>-1</code>, Error occurred (check <a class="el" href="group__coda__error.html#gafcb445c7fcab2d4d0af01f0e1c2dc866">coda_errno</a>). </li>
</ul>
</dd></dl>
</div>
</div>
<a id="ga128ac196262a6c4b458e09569bd93104" name="ga128ac196262a6c4b458e09569bd93104"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga128ac196262a6c4b458e09569bd93104">◆ </a></span>coda_set_option_bypass_special_types()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int coda_set_option_bypass_special_types </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>enable</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Enable/Disable the use of special types. The CODA type system contains a series of special types that were introduced to make it easier for the user to read certain types of information. Examples of special types are the 'time', 'complex', and 'no data' types. Each special data type is an abstraction on top of another non-special data type. Sometimes you want to access a file using just the non-special data types (e.g. if you want to get to the raw time data in a file). CODA already contains the <a class="el" href="group__coda__cursor.html#gaa58abc3d22330e5d322c9f8147a99d2e">coda_cursor_use_base_type_of_special_type()</a> function that allows you to reinterpret the current special data type using the base type of the special type. However, if you enable the bypassing of special types option then CODA automatically calls the <a class="el" href="group__coda__cursor.html#gaa58abc3d22330e5d322c9f8147a99d2e">coda_cursor_use_base_type_of_special_type()</a> for you whenever you move a cursor to a data item that is of a special type. By default bypassing of special types is disabled. </p><dl class="section note"><dt>Note</dt><dd>Bypassing of special types only works on CODA cursors and not on coda_type objects (e.g. if a record field is of a special type the <a class="el" href="group__coda__types.html#ga9d857c5b8a203b23e40e6be4f0e651c0">coda_type_get_record_field_type()</a> function will still give you the special type and not the non-special base type). </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">enable</td><td><ul>
<li>0: Disable bypassing of special types. </li>
<li>1: Enable bypassing of special types. </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li><code>0</code>, Success. </li>
<li><code>-1</code>, Error occurred (check <a class="el" href="group__coda__error.html#gafcb445c7fcab2d4d0af01f0e1c2dc866">coda_errno</a>). </li>
</ul>
</dd></dl>
</div>
</div>
<a id="ga5d7dcdb4e6b3e6fa1bbf1981b14bb371" name="ga5d7dcdb4e6b3e6fa1bbf1981b14bb371"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5d7dcdb4e6b3e6fa1bbf1981b14bb371">◆ </a></span>coda_set_option_perform_boundary_checks()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int coda_set_option_perform_boundary_checks </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>enable</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Enable/Disable boundary checking. By default all functions in libcoda perform boundary checks. However some boundary checks are quite compute intensive. In order to increase performance you can turn off those compute intensive boundary checks with this option. The boundary checks that are affected by this option are the ones in <a class="el" href="group__coda__cursor.html#ga08300afc8797ef5bba44b2acb316bdaf">coda_cursor_goto_array_element_by_index()</a> and <a class="el" href="group__coda__cursor.html#gaf0251269bb9774efc232cf6771ca9692">coda_cursor_goto_next_array_element()</a>. Some internal functions of libcoda also call these functions so you might see speed improvements for other functions too if you disable the boundary checks. Mind that this option does not control the out-of-bounds check for trying to read beyond the end of the product (i.e. <a class="el" href="group__coda__error.html#ga545ffb4620708efc1eb885c97b299df2">CODA_ERROR_OUT_OF_BOUNDS_READ</a>). </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">enable</td><td><ul>
<li>0: Disable boundary checking. </li>
<li>1: Enable boundary checking. </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li><code>0</code>, Success. </li>
<li><code>-1</code>, Error occurred (check <a class="el" href="group__coda__error.html#gafcb445c7fcab2d4d0af01f0e1c2dc866">coda_errno</a>). </li>
</ul>
</dd></dl>
</div>
</div>
<a id="ga5b9aba6faa0583c70bdcd9add6e72cae" name="ga5b9aba6faa0583c70bdcd9add6e72cae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5b9aba6faa0583c70bdcd9add6e72cae">◆ </a></span>coda_set_option_perform_conversions()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int coda_set_option_perform_conversions </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>enable</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Enable/Disable unit/value conversions. This options allows conversions to be performed as specified in the data-dictionary. If this option is enabled (the default), values that have a conversion specified will be converted to a value of type double and scaled according to the conversion parameters when read.</p>
<p >Both the type, unit, and value-as-read are influenced by this option for types that have an associated conversion. If conversions are disabled, the type, unit, and value will reflect how data is actually stored in the product file (i.e. without conversion).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">enable</td><td><ul>
<li>0: Disable unit/value conversions. </li>
<li>1: Enable unit/value conversions. </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li><code>0</code>, Success. </li>
<li><code>-1</code>, Error occurred (check <a class="el" href="group__coda__error.html#gafcb445c7fcab2d4d0af01f0e1c2dc866">coda_errno</a>). </li>
</ul>
</dd></dl>
</div>
</div>
<a id="ga37ed476c701bc72bf3a389ac52cac890" name="ga37ed476c701bc72bf3a389ac52cac890"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga37ed476c701bc72bf3a389ac52cac890">◆ </a></span>coda_set_option_use_fast_size_expressions()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int coda_set_option_use_fast_size_expressions </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>enable</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Enable/Disable the use of fast size expressions. Sometimes product files contain information that can be used to directly retrieve the size (or offset) of a data element. If this information is redundant (i.e. the size and/or offset can also be determined in another way) then CODA has a choice whether to use this information or not.</p>
<p >For instance, CODA normally calculates the size of a record by calculating the sizes of all the fields and adding them up. But if one of the first fields of the record contains the total size of the record, CODA can also use the (often) faster approach of determining the record size by using the contents of this field.</p>
<p >If the use of fast size expressions is enabled (the default), CODA will use the 'faster' method of retrieving the size/offset information for a data element (e.g. use the contents of the record field that contains the record size). Note that this faster method only occurs when the data element, such as the record, also has a 'fast expression' associated with it (if this is the case then this expression is shown in the Product Format Definition documentation for the data element).</p>
<p >If this option is disabled then CODA will only use the traditional method for calculating the size (or offset) and thus ignore any 'fast expressions' that may exist.</p>
<p >Sometimes the size (or offset) information in a product is incorrect. If this is the case, you can disable the use of fast size expressions with this option so CODA might still access the product correctly.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">enable</td><td><ul>
<li>0: Disable the use of fast size expressions. </li>
<li>1: Enable the use of fast size expressions. </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li><code>0</code>, Success. </li>
<li><code>-1</code>, Error occurred (check <a class="el" href="group__coda__error.html#gafcb445c7fcab2d4d0af01f0e1c2dc866">coda_errno</a>). </li>
</ul>
</dd></dl>
</div>
</div>
<a id="ga1c56d546f9056be24e193b24264b8f1d" name="ga1c56d546f9056be24e193b24264b8f1d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1c56d546f9056be24e193b24264b8f1d">◆ </a></span>coda_set_option_use_mmap()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int coda_set_option_use_mmap </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>enable</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Enable/Disable the use of memory mapping of files. By default CODA uses a technique called 'memory mapping' to open and access data from product files. The memory mapping approach is a very fast approach that uses the mmap() function to (as the term suggests) map a file in memory. Accessing data from a file using mmap() greatly outperforms the alternative approach of reading data using the open()/read() combination (often by a factor of 5 and sometimes even more).</p>
<p >The downside of mapping a file into memory is that it takes away valuable address space. When you run a 32-bit Operating System your maximum addressable memory range is 4GB (or 2GB) and if you simultaneously try to keep a few large product files open your memory space can quickly become full. Opening additional files will then produce 'out of memory' errors. Note that this 'out of memory' situation has nothing to do with the amount of RAM you have installed in your computer. It is only related to the size of a memory pointer on your system, which is limited to 4GB for a 32 bits pointer.</p>
<p >If you are using CODA in a situation where you need to have multiple large product files open at the same time you can turn off the use of memory mapping by using this function. Disabling the use of mmap() means that CODA will fall back to the mechanism of open()/read().</p>
<p >In addition, the open()/read() functionality in CODA is able to handle files that are over 4GB in size. If you are running a 32-bit operating system or if your system does not support a 64-bit version of mmap then you can still access such large files by disabling the mmap functionality and falling back to the open()/read() mechanism.</p>
<dl class="section note"><dt>Note</dt><dd>If you change the memory mapping usage option, the new setting will only be applicable for files that will be opened after you changed the option. Any files that were already open will keep using the mechanism with which they were opened.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">enable</td><td><ul>
<li>0: Disable the use of memory mapping. </li>
<li>1: Enable the use of memory mapping. </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li><code>0</code>, Success. </li>
<li><code>-1</code>, Error occurred (check <a class="el" href="group__coda__error.html#gafcb445c7fcab2d4d0af01f0e1c2dc866">coda_errno</a>). </li>
</ul>
</dd></dl>
</div>
</div>
<a id="ga36e969eed0cb46d34222b65374708573" name="ga36e969eed0cb46d34222b65374708573"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga36e969eed0cb46d34222b65374708573">◆ </a></span>coda_str64()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void coda_str64 </td>
<td>(</td>
<td class="paramtype">int64_t </td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>s</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Write 64 bit signed integer to a string. The string <em>s</em> will be 0 terminated. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">a</td><td>A signed 64 bit integer value. </td></tr>
<tr><td class="paramname">s</td><td>A character buffer that is at least 21 bytes long. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga79b65ef3ffad25590a693f05878d2428" name="ga79b65ef3ffad25590a693f05878d2428"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga79b65ef3ffad25590a693f05878d2428">◆ </a></span>coda_str64u()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void coda_str64u </td>
<td>(</td>
<td class="paramtype">uint64_t </td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>s</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Write 64 bit unsigned integer to a string. The string <em>s</em> will be 0 terminated. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">a</td><td>An unsigned 64 bit integer value. </td></tr>
<tr><td class="paramname">s</td><td>A character buffer that is at least 20 bytes long. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gabc0fecd1bc7442a533265f5e36d43ce7" name="gabc0fecd1bc7442a533265f5e36d43ce7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabc0fecd1bc7442a533265f5e36d43ce7">◆ </a></span>coda_strfl()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void coda_strfl </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>s</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Write floating point value to a string. This will write the floating point value to a string using the printf '%.16g' format. However, if the floating point is NaN or Inf it will write 'nan', '+inf', or '-inf' (instead of the platform specific alternative that printf might have used). The string <em>s</em> will be 0 terminated. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">a</td><td>A floating point value. </td></tr>
<tr><td class="paramname">s</td><td>A character buffer that is at least 24 bytes long. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="ga5fe4faf55474bc440525d4a4301b943d" name="ga5fe4faf55474bc440525d4a4301b943d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5fe4faf55474bc440525d4a4301b943d">◆ </a></span>libcoda_version</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">THREAD_LOCAL const char* libcoda_version</td>
</tr>
</table>
</div><div class="memdoc">
<p >Current version of CODA as a string. </p>
</div>
</div>
</div><!-- contents -->
<div class="footer">
<hr><p>Copyright © 2007-2022 <b>s<span class="soft-red">[</span>&<span class="soft-red">]</span>t</b>, The Netherlands.
</p>
</div>
</div>
</body>
</html>
|
