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
|
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>General — HARP 1.16 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="next" title="Geometry" href="libharp_geometry.html" />
<link rel="prev" title="Error" href="libharp_error.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> HARP
</a>
<div class="version">
1.16
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="conventions/index.html">Conventions</a></li>
<li class="toctree-l1"><a class="reference internal" href="algorithms/index.html">Algorithms</a></li>
<li class="toctree-l1"><a class="reference internal" href="operations.html">Operations</a></li>
<li class="toctree-l1"><a class="reference internal" href="ingestions/index.html">Ingestion definitions</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="libharp.html">C library</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="libharp.html#introduction">Introduction</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="libharp.html#modules">Modules</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="libharp_collocation.html">Collocation</a></li>
<li class="toctree-l3"><a class="reference internal" href="libharp_dataset.html">Dataset</a></li>
<li class="toctree-l3"><a class="reference internal" href="libharp_documentation.html">Documentation</a></li>
<li class="toctree-l3"><a class="reference internal" href="libharp_error.html">Error</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">General</a></li>
<li class="toctree-l3"><a class="reference internal" href="libharp_geometry.html">Geometry</a></li>
<li class="toctree-l3"><a class="reference internal" href="libharp_product.html">Product</a></li>
<li class="toctree-l3"><a class="reference internal" href="libharp_product_metadata.html">Product Metadata</a></li>
<li class="toctree-l3"><a class="reference internal" href="libharp_variable.html">Variable</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="idl.html">IDL interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="matlab.html">MATLAB interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="python.html">Python interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="R.html">R interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="tools.html">Command line tools</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">HARP</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> »</li>
<li><a href="libharp.html">C library</a> »</li>
<li>General</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="general">
<h1>General</h1>
<dl>
<dt class="sig sig-object cpp">
<span class="target" id="group__harp__general"></span><em><span class="pre">group</span></em> <span class="sig-name descname"><span class="pre">harp_general</span></span></dt>
<dd><p>The HARP General module contains all general and miscellaneous functions and procedures of HARP. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-defines">Defines</p>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.HARP_NUM_DATA_TYPES">
<span class="target" id="group__harp__general_1ga9d447bb4e021c2cc273ade8d9c7a9086"></span><span class="sig-name descname"><span class="n"><span class="pre">HARP_NUM_DATA_TYPES</span></span></span><br /></dt>
<dd></dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.HARP_NUM_DIM_TYPES">
<span class="target" id="group__harp__general_1ga745afa2b5da35e983684ec9d5c6b8641"></span><span class="sig-name descname"><span class="n"><span class="pre">HARP_NUM_DIM_TYPES</span></span></span><br /></dt>
<dd></dd></dl>
</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-typedefs">Typedefs</p>
<dl class="cpp type">
<dt class="sig sig-object cpp" id="_CPPv414harp_data_type">
<span id="_CPPv314harp_data_type"></span><span id="_CPPv214harp_data_type"></span><span id="harp_data_type"></span><span class="target" id="group__harp__general_1ga3e6679493bcea7a86f5db857b724d626"></span><span class="k"><span class="pre">typedef</span></span><span class="w"> </span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv419harp_data_type_enum" title="harp_data_type_enum"><span class="n"><span class="pre">harp_data_type_enum</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_data_type</span></span></span><br /></dt>
<dd></dd></dl>
<dl class="cpp type">
<dt class="sig sig-object cpp" id="_CPPv411harp_scalar">
<span id="_CPPv311harp_scalar"></span><span id="_CPPv211harp_scalar"></span><span id="harp_scalar"></span><span class="target" id="group__harp__general_1ga614d2a182d07f61a78f6c07f206be65b"></span><span class="k"><span class="pre">typedef</span></span><span class="w"> </span><span class="k"><span class="pre">union</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv417harp_scalar_union" title="harp_scalar_union"><span class="n"><span class="pre">harp_scalar_union</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_scalar</span></span></span><br /></dt>
<dd></dd></dl>
<dl class="cpp type">
<dt class="sig sig-object cpp" id="_CPPv410harp_array">
<span id="_CPPv310harp_array"></span><span id="_CPPv210harp_array"></span><span id="harp_array"></span><span class="target" id="group__harp__general_1gab28d0895c88c16552c09a614a3af128d"></span><span class="k"><span class="pre">typedef</span></span><span class="w"> </span><span class="k"><span class="pre">union</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv416harp_array_union" title="harp_array_union"><span class="n"><span class="pre">harp_array_union</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_array</span></span></span><br /></dt>
<dd></dd></dl>
<dl class="cpp type">
<dt class="sig sig-object cpp" id="_CPPv419harp_dimension_type">
<span id="_CPPv319harp_dimension_type"></span><span id="_CPPv219harp_dimension_type"></span><span id="harp_dimension_type"></span><span class="target" id="group__harp__general_1ga09aa1869c3441f715812f30cd30bc4e0"></span><span class="k"><span class="pre">typedef</span></span><span class="w"> </span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv424harp_dimension_type_enum" title="harp_dimension_type_enum"><span class="n"><span class="pre">harp_dimension_type_enum</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_dimension_type</span></span></span><br /></dt>
<dd></dd></dl>
</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-enums">Enums</p>
<dl class="cpp enum">
<dt class="sig sig-object cpp" id="_CPPv419harp_data_type_enum">
<span id="_CPPv319harp_data_type_enum"></span><span id="_CPPv219harp_data_type_enum"></span><span class="target" id="group__harp__general_1ga580990f8c0e1539578c35c71394c13b8"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_data_type_enum</span></span></span><br /></dt>
<dd><p><em>Values:</em></p>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N19harp_data_type_enum14harp_type_int8E">
<span id="_CPPv3N19harp_data_type_enum14harp_type_int8E"></span><span id="_CPPv2N19harp_data_type_enum14harp_type_int8E"></span><span class="target" id="group__harp__general_1gga580990f8c0e1539578c35c71394c13b8a6ea1a29087267f166b4051a18c462567"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_type_int8</span></span></span><br /></dt>
<dd><p>BYTE </p>
</dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N19harp_data_type_enum15harp_type_int16E">
<span id="_CPPv3N19harp_data_type_enum15harp_type_int16E"></span><span id="_CPPv2N19harp_data_type_enum15harp_type_int16E"></span><span class="target" id="group__harp__general_1gga580990f8c0e1539578c35c71394c13b8a356bfcd65137fcd06a83b8738bf8565a"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_type_int16</span></span></span><br /></dt>
<dd><p>INTEGER </p>
</dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N19harp_data_type_enum15harp_type_int32E">
<span id="_CPPv3N19harp_data_type_enum15harp_type_int32E"></span><span id="_CPPv2N19harp_data_type_enum15harp_type_int32E"></span><span class="target" id="group__harp__general_1gga580990f8c0e1539578c35c71394c13b8ac67b47d1c1d3f3b3d567d0e593c625ca"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_type_int32</span></span></span><br /></dt>
<dd><p>LONG </p>
</dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N19harp_data_type_enum15harp_type_floatE">
<span id="_CPPv3N19harp_data_type_enum15harp_type_floatE"></span><span id="_CPPv2N19harp_data_type_enum15harp_type_floatE"></span><span class="target" id="group__harp__general_1gga580990f8c0e1539578c35c71394c13b8a16defd7698fa568a45f3924889f1df4d"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_type_float</span></span></span><br /></dt>
<dd><p>FLOAT </p>
</dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N19harp_data_type_enum16harp_type_doubleE">
<span id="_CPPv3N19harp_data_type_enum16harp_type_doubleE"></span><span id="_CPPv2N19harp_data_type_enum16harp_type_doubleE"></span><span class="target" id="group__harp__general_1gga580990f8c0e1539578c35c71394c13b8a9bf51666946a319e65285fba8c9f841c"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_type_double</span></span></span><br /></dt>
<dd><p>DOUBLE </p>
</dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N19harp_data_type_enum16harp_type_stringE">
<span id="_CPPv3N19harp_data_type_enum16harp_type_stringE"></span><span id="_CPPv2N19harp_data_type_enum16harp_type_stringE"></span><span class="target" id="group__harp__general_1gga580990f8c0e1539578c35c71394c13b8a4905027039bfc016c4747810c8041f00"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_type_string</span></span></span><br /></dt>
<dd><p>STRING </p>
</dd></dl>
</dd></dl>
<dl class="cpp enum">
<dt class="sig sig-object cpp" id="_CPPv424harp_dimension_type_enum">
<span id="_CPPv324harp_dimension_type_enum"></span><span id="_CPPv224harp_dimension_type_enum"></span><span class="target" id="group__harp__general_1ga8ba37626d488a9335d5f0a6f233bf744"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_dimension_type_enum</span></span></span><br /></dt>
<dd><p><em>Values:</em></p>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N24harp_dimension_type_enum26harp_dimension_independentE">
<span id="_CPPv3N24harp_dimension_type_enum26harp_dimension_independentE"></span><span id="_CPPv2N24harp_dimension_type_enum26harp_dimension_independentE"></span><span class="target" id="group__harp__general_1gga8ba37626d488a9335d5f0a6f233bf744a212acf3790da31ff1d3e4ec6d351fb54"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_dimension_independent</span></span></span><br /></dt>
<dd></dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N24harp_dimension_type_enum19harp_dimension_timeE">
<span id="_CPPv3N24harp_dimension_type_enum19harp_dimension_timeE"></span><span id="_CPPv2N24harp_dimension_type_enum19harp_dimension_timeE"></span><span class="target" id="group__harp__general_1gga8ba37626d488a9335d5f0a6f233bf744ad3689d56a28fcb601b2e5e87c1344ce8"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_dimension_time</span></span></span><br /></dt>
<dd></dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N24harp_dimension_type_enum23harp_dimension_latitudeE">
<span id="_CPPv3N24harp_dimension_type_enum23harp_dimension_latitudeE"></span><span id="_CPPv2N24harp_dimension_type_enum23harp_dimension_latitudeE"></span><span class="target" id="group__harp__general_1gga8ba37626d488a9335d5f0a6f233bf744a5d9ca65f783666a65ef1b4db004157ce"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_dimension_latitude</span></span></span><br /></dt>
<dd></dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N24harp_dimension_type_enum24harp_dimension_longitudeE">
<span id="_CPPv3N24harp_dimension_type_enum24harp_dimension_longitudeE"></span><span id="_CPPv2N24harp_dimension_type_enum24harp_dimension_longitudeE"></span><span class="target" id="group__harp__general_1gga8ba37626d488a9335d5f0a6f233bf744a78850d1e9182848e7a244440c60f1336"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_dimension_longitude</span></span></span><br /></dt>
<dd></dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N24harp_dimension_type_enum23harp_dimension_verticalE">
<span id="_CPPv3N24harp_dimension_type_enum23harp_dimension_verticalE"></span><span id="_CPPv2N24harp_dimension_type_enum23harp_dimension_verticalE"></span><span class="target" id="group__harp__general_1gga8ba37626d488a9335d5f0a6f233bf744a5ac5074d38b2138eb18fd0cb0f4a58bd"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_dimension_vertical</span></span></span><br /></dt>
<dd></dd></dl>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N24harp_dimension_type_enum23harp_dimension_spectralE">
<span id="_CPPv3N24harp_dimension_type_enum23harp_dimension_spectralE"></span><span id="_CPPv2N24harp_dimension_type_enum23harp_dimension_spectralE"></span><span class="target" id="group__harp__general_1gga8ba37626d488a9335d5f0a6f233bf744a48489fcca5d4dca5f70ffb9975d9ebe6"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_dimension_spectral</span></span></span><br /></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-functions">Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv426harp_set_udunits2_xml_pathPKc">
<span id="_CPPv326harp_set_udunits2_xml_pathPKc"></span><span id="_CPPv226harp_set_udunits2_xml_pathPKc"></span><span id="harp_set_udunits2_xml_path__cCP"></span><span class="target" id="group__harp__general_1ga92af8b1a8aaca9b9e665d35a0dad0895"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_set_udunits2_xml_path</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">path</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>Set the location of the udunits2 unit conversion xml configuration file.</p>
<p>This function should be called before <a class="reference internal" href="#group__harp__general_1gad1f344feb3bea74322283efca649a045"><span class="std std-ref">harp_init()</span></a> is called.</p>
<p>The HARP C library uses the udunits2 library to perform unit conversions. The xml configuration files for udunits2 are included with a HARP installation and a default absolute path to these xml files is built into the library.</p>
<p>If the HARP installation ends up in a different location on disk compared to what was provided at build time then you will either need to set the UDUNITS2_XML_PATH environment variable or call one of the functions <a class="reference internal" href="#group__harp__general_1ga92af8b1a8aaca9b9e665d35a0dad0895"><span class="std std-ref">harp_set_udunits2_xml_path()</span></a> or <a class="reference internal" href="#group__harp__general_1gab35a6e458ae75f777ceef7006244183d"><span class="std std-ref">harp_set_udunits2_xml_path_conditional()</span></a> to set the path programmatically.</p>
<p>The path should be an absolute path to the udunits2.xml file that was included with the HARP installation.</p>
<p>Specifying a path using this function will prevent HARP from using the UDUNITS2_XML_PATH environment variable. If you still want HARP to acknowledge the UDUNITS2_XML_PATH environment variable then use something like this in your code: <div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">getenv</span><span class="p">(</span><span class="s">"UDUNITS2_XML_PATH"</span><span class="p">)</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="nb">NULL</span><span class="p">)</span><span class="w"></span>
<span class="p">{</span><span class="w"></span>
<span class="w"> </span><span class="n">harp_set_udunits2_xml_path</span><span class="p">(</span><span class="s">"<your path>"</span><span class="p">);</span><span class="w"></span>
<span class="p">}</span><span class="w"></span>
</pre></div>
</div>
</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>path</strong> – Absolute path to the udunits2.xml file </p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">0</span></code>, Success. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-1</span></code>, Error occurred (check <a class="reference internal" href="libharp_error.html#group__harp__error_1gab2eeb46528306c6799632d1e800c4c36"><span class="std std-ref">harp_errno</span></a>). </p></li>
</ul>
</p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv438harp_set_udunits2_xml_path_conditionalPKcPKcPKc">
<span id="_CPPv338harp_set_udunits2_xml_path_conditionalPKcPKcPKc"></span><span id="_CPPv238harp_set_udunits2_xml_path_conditionalPKcPKcPKc"></span><span id="harp_set_udunits2_xml_path_conditional__cCP.cCP.cCP"></span><span class="target" id="group__harp__general_1gab35a6e458ae75f777ceef7006244183d"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_set_udunits2_xml_path_conditional</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">file</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">searchpath</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">relative_location</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>Set the location of the udunits2 xml configuration file based on the location of another file.</p>
<p>This function should be called before <a class="reference internal" href="#group__harp__general_1gad1f344feb3bea74322283efca649a045"><span class="std std-ref">harp_init()</span></a> is called.</p>
<p>The HARP C library uses the udunits2 library to perform unit conversions. The xml configuration files for udunits2 are included with a HARP installation and a default absolute path to the main xml file is built into the library.</p>
<p>If the HARP installation ends up in a different location on disk compared to what was provided at build time then you will either need to set the UDUNITS2_XML_PATH environment variable or call one of the functions <a class="reference internal" href="#group__harp__general_1ga92af8b1a8aaca9b9e665d35a0dad0895"><span class="std std-ref">harp_set_udunits2_xml_path()</span></a> or <a class="reference internal" href="#group__harp__general_1gab35a6e458ae75f777ceef7006244183d"><span class="std std-ref">harp_set_udunits2_xml_path_conditional()</span></a> to set the path programmatically.</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 location <em>relative_location</em> to determine the udunits2 xml path. If the file to search for could not be found in the searchpath then the HARP udunits2 xml path will not be set.</p>
<p>If the UDUNITS2_XML_PATH environment variable was set then this function will not perform a search or set the udunits2 xml path (i.e. the udunits2 xml path will be taken from the UDUNITS2_XML_PATH 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 harp_set_udunits2_xml_path_conditional(argv[0], NULL, “../somedir/udunits2.xml”) to set the udunits2 xml 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 should point to the udunits2.xml file itself (and not the directory that the file is in).</p>
<p>Note that this function differs from <a class="reference internal" href="#group__harp__general_1ga92af8b1a8aaca9b9e665d35a0dad0895"><span class="std std-ref">harp_set_udunits2_xml_path()</span></a> in that it will not modify the udunits2 xml path if the UDUNITS2_XML_PATH variable was set.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>file</strong> – Filename of the file to search for </p></li>
<li><p><strong>searchpath</strong> – Search path where to look for the file <em>file</em> (can be NULL) </p></li>
<li><p><strong>relative_location</strong> – Filepath relative to the directory from <em>searchpath</em> where <em>file</em> was found that provides the location of the udunits2.xml file. </p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">0</span></code>, Success. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-1</span></code>, Error occurred (check <a class="reference internal" href="libharp_error.html#group__harp__error_1gab2eeb46528306c6799632d1e800c4c36"><span class="std std-ref">harp_errno</span></a>). </p></li>
</ul>
</p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv417harp_convert_unitPKcPKclPd">
<span id="_CPPv317harp_convert_unitPKcPKclPd"></span><span id="_CPPv217harp_convert_unitPKcPKclPd"></span><span id="harp_convert_unit__cCP.cCP.l.doubleP"></span><span class="target" id="group__harp__general_1gaf2f2e7ffc3090f796385669ed69f92e9"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_convert_unit</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">from_unit</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">to_unit</span></span>, <span class="kt"><span class="pre">long</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">num_values</span></span>, <span class="kt"><span class="pre">double</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">value</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>Perform unit conversion on data</p>
<p>Apply unit conversion on a range of floating point values. Conversion will be performed in-place. If there is no conversion available from the current unit to the new unit then an error will be raised. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>from_unit</strong> – Existing unit of the data that should be converted (use udunits2 compliant units). </p></li>
<li><p><strong>to_unit</strong> – Unit to which the data should be converted (use udunits2 compliant units). </p></li>
<li><p><strong>num_values</strong> – Number of floating point values in <em>value</em>. </p></li>
<li><p><strong>value</strong> – Array of floating point values that should be converted. </p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">0</span></code>, Success. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-1</span></code>, Error occurred (check <a class="reference internal" href="libharp_error.html#group__harp__error_1gab2eeb46528306c6799632d1e800c4c36"><span class="std std-ref">harp_errno</span></a>). </p></li>
</ul>
</p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv413harp_basenamePKc">
<span id="_CPPv313harp_basenamePKc"></span><span id="_CPPv213harp_basenamePKc"></span><span id="harp_basename__cCP"></span><span class="target" id="group__harp__general_1gab3604231ffff1237b8ed245ae30eac53"></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">harp_basename</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">path</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>Remove everything but the last pathname component from <em>path</em>. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>path</strong> – Path to compute the basename of. </p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Pointer to the last pathname component of <em>path</em>, i.e. everything from the end of <em>path</em> up to the first pathname component separation character (’' or ‘/’ on Windows, ‘/’ otherwise). </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv423harp_get_data_type_name14harp_data_type">
<span id="_CPPv323harp_get_data_type_name14harp_data_type"></span><span id="_CPPv223harp_get_data_type_name14harp_data_type"></span><span id="harp_get_data_type_name__harp_data_type"></span><span class="target" id="group__harp__general_1ga9c1402a37824f5e7489c427e8e8e81f2"></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">harp_get_data_type_name</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv414harp_data_type" title="harp_data_type"><span class="n"><span class="pre">harp_data_type</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">data_type</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>Returns the name of a data type. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>data_type</strong> – HARP basic data type </p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>if the data type is known a string containing the name of the type, otherwise the string “unknown”. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv422harp_get_size_for_type14harp_data_type">
<span id="_CPPv322harp_get_size_for_type14harp_data_type"></span><span id="_CPPv222harp_get_size_for_type14harp_data_type"></span><span id="harp_get_size_for_type__harp_data_type"></span><span class="target" id="group__harp__general_1ga04e7afdfba69e2ee2596bfed9dc87355"></span><span class="kt"><span class="pre">long</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_get_size_for_type</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv414harp_data_type" title="harp_data_type"><span class="n"><span class="pre">harp_data_type</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">data_type</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>Retrieve the byte size for a HARP data type. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>data_type</strong> – Data type for which to retrieve the size. </p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>The size of the data type in bytes. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv428harp_get_fill_value_for_type14harp_data_type">
<span id="_CPPv328harp_get_fill_value_for_type14harp_data_type"></span><span id="_CPPv228harp_get_fill_value_for_type14harp_data_type"></span><span id="harp_get_fill_value_for_type__harp_data_type"></span><span class="target" id="group__harp__general_1ga00efcbd66b05ad34562435771e600341"></span><a class="reference internal" href="#_CPPv411harp_scalar" title="harp_scalar"><span class="n"><span class="pre">harp_scalar</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_get_fill_value_for_type</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv414harp_data_type" title="harp_data_type"><span class="n"><span class="pre">harp_data_type</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">data_type</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>Retrieve the fill value for a HARP data type. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>data_type</strong> – Data type for which to retrieve the fill value. </p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>The fill value for the data type. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv427harp_get_valid_min_for_type14harp_data_type">
<span id="_CPPv327harp_get_valid_min_for_type14harp_data_type"></span><span id="_CPPv227harp_get_valid_min_for_type14harp_data_type"></span><span id="harp_get_valid_min_for_type__harp_data_type"></span><span class="target" id="group__harp__general_1ga854ceb4ea5b4953cfa94a0b738bdbee5"></span><a class="reference internal" href="#_CPPv411harp_scalar" title="harp_scalar"><span class="n"><span class="pre">harp_scalar</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_get_valid_min_for_type</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv414harp_data_type" title="harp_data_type"><span class="n"><span class="pre">harp_data_type</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">data_type</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>Retrieve the minimum valid value for a HARP data type. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>data_type</strong> – Data type for which to retrieve the minimum valid value. </p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>The minimum valid value of the data type. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv427harp_get_valid_max_for_type14harp_data_type">
<span id="_CPPv327harp_get_valid_max_for_type14harp_data_type"></span><span id="_CPPv227harp_get_valid_max_for_type14harp_data_type"></span><span id="harp_get_valid_max_for_type__harp_data_type"></span><span class="target" id="group__harp__general_1ga0161b0bb8622db439ce702d125855de9"></span><a class="reference internal" href="#_CPPv411harp_scalar" title="harp_scalar"><span class="n"><span class="pre">harp_scalar</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_get_valid_max_for_type</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv414harp_data_type" title="harp_data_type"><span class="n"><span class="pre">harp_data_type</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">data_type</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>Retrieve the maximum valid value for a HARP data type. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>data_type</strong> – Data type for which to retrieve the maximum valid value. </p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>The maximum valid value of the data type. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv427harp_is_fill_value_for_type14harp_data_type11harp_scalar">
<span id="_CPPv327harp_is_fill_value_for_type14harp_data_type11harp_scalar"></span><span id="_CPPv227harp_is_fill_value_for_type14harp_data_type11harp_scalar"></span><span id="harp_is_fill_value_for_type__harp_data_type.harp_scalar"></span><span class="target" id="group__harp__general_1gaffeedbea853fee203d4555664225e261"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_is_fill_value_for_type</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv414harp_data_type" title="harp_data_type"><span class="n"><span class="pre">harp_data_type</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">data_type</span></span>, <a class="reference internal" href="#_CPPv411harp_scalar" title="harp_scalar"><span class="n"><span class="pre">harp_scalar</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">value</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>Test if <em>value</em> equals the fill value for the specified data type. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data_type</strong> – Data type corresponding to the value of <em>value</em>. </p></li>
<li><p><strong>value</strong> – Value to test. </p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">0</span></code>, Value is not equal to the fill value. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">1</span></code>, Value equals the fill value. </p></li>
</ul>
</p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv426harp_is_valid_min_for_type14harp_data_type11harp_scalar">
<span id="_CPPv326harp_is_valid_min_for_type14harp_data_type11harp_scalar"></span><span id="_CPPv226harp_is_valid_min_for_type14harp_data_type11harp_scalar"></span><span id="harp_is_valid_min_for_type__harp_data_type.harp_scalar"></span><span class="target" id="group__harp__general_1ga43fde638ad814bb4a88c2e63ab06deca"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_is_valid_min_for_type</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv414harp_data_type" title="harp_data_type"><span class="n"><span class="pre">harp_data_type</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">data_type</span></span>, <a class="reference internal" href="#_CPPv411harp_scalar" title="harp_scalar"><span class="n"><span class="pre">harp_scalar</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">value</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>Test if <em>value</em> equals the minimum valid value for the specified data type. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data_type</strong> – Data type corresponding to the value of <em>value</em>. </p></li>
<li><p><strong>value</strong> – Value to test. </p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">0</span></code>, Value is not equal to the minimum valid value. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">1</span></code>, Value equals the minimum valid value. </p></li>
</ul>
</p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv426harp_is_valid_max_for_type14harp_data_type11harp_scalar">
<span id="_CPPv326harp_is_valid_max_for_type14harp_data_type11harp_scalar"></span><span id="_CPPv226harp_is_valid_max_for_type14harp_data_type11harp_scalar"></span><span id="harp_is_valid_max_for_type__harp_data_type.harp_scalar"></span><span class="target" id="group__harp__general_1gace82158c05757551242151c4cb8709f6"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_is_valid_max_for_type</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv414harp_data_type" title="harp_data_type"><span class="n"><span class="pre">harp_data_type</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">data_type</span></span>, <a class="reference internal" href="#_CPPv411harp_scalar" title="harp_scalar"><span class="n"><span class="pre">harp_scalar</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">value</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>Test if <em>value</em> equals the maximum valid value for the specified data type. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data_type</strong> – Data type corresponding to the value of <em>value</em>. </p></li>
<li><p><strong>value</strong> – Value to test. </p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">0</span></code>, Value is not equal to the maximum valid value. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">1</span></code>, Value equals the maximum valid value. </p></li>
</ul>
</p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv413harp_isfinited">
<span id="_CPPv313harp_isfinited"></span><span id="_CPPv213harp_isfinited"></span><span id="harp_isfinite__double"></span><span class="target" id="group__harp__general_1gab2573bc2856e63bf0f13c342c97fcc74"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_isfinite</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">double</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">x</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>Find out whether a double value is a finite number (i.e. not NaN and not infinite). </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>x</strong> – A double value. </p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">1</span></code>, The double value is a finite number. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">0</span></code>, The double value is not a finite number. </p></li>
</ul>
</p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv410harp_isnand">
<span id="_CPPv310harp_isnand"></span><span id="_CPPv210harp_isnand"></span><span id="harp_isnan__double"></span><span class="target" id="group__harp__general_1gabc115e3ba02afd21054b75ccb025a8a3"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_isnan</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">double</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">x</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>Find out whether a double value equals NaN (Not a Number). </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>x</strong> – A double value. </p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">1</span></code>, The double value equals NaN. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">0</span></code>, The double value does not equal NaN. </p></li>
</ul>
</p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv48harp_nanv">
<span id="_CPPv38harp_nanv"></span><span id="_CPPv28harp_nanv"></span><span id="harp_nan__void"></span><span class="target" id="group__harp__general_1ga10caef8ce343d5b5bec3b8240441ef86"></span><span class="kt"><span class="pre">double</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_nan</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">void</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>Retrieve a double value that respresents NaN (Not a Number). </p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The double value ‘NaN’. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv410harp_isinfd">
<span id="_CPPv310harp_isinfd"></span><span id="_CPPv210harp_isinfd"></span><span id="harp_isinf__double"></span><span class="target" id="group__harp__general_1ga29b220390a28440d8f4f8e50afcdbd0a"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_isinf</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">double</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">x</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>Find out whether a double value equals inf (either positive or negative infinity). </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>x</strong> – A double value. </p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">1</span></code>, The double value equals inf. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">0</span></code>, The double value does not equal inf. </p></li>
</ul>
</p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv414harp_isplusinfd">
<span id="_CPPv314harp_isplusinfd"></span><span id="_CPPv214harp_isplusinfd"></span><span id="harp_isplusinf__double"></span><span class="target" id="group__harp__general_1gae3a1e45bedf7743577d367ba7edb9f27"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_isplusinf</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">double</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">x</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>Find out whether a double value equals +inf (positive infinity). </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>x</strong> – A double value. </p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">1</span></code>, The double value equals +inf. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">0</span></code>, The double value does not equal +inf. </p></li>
</ul>
</p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv413harp_ismininfd">
<span id="_CPPv313harp_ismininfd"></span><span id="_CPPv213harp_ismininfd"></span><span id="harp_ismininf__double"></span><span class="target" id="group__harp__general_1gad3a45b9aefba353096685388531e7012"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_ismininf</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">double</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">x</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>Find out whether a double value equals -inf (negative infinity). </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>x</strong> – A double value. </p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">1</span></code>, The double value equals -inf. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">0</span></code>, The double value does not equal -inf. </p></li>
</ul>
</p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv412harp_plusinfv">
<span id="_CPPv312harp_plusinfv"></span><span id="_CPPv212harp_plusinfv"></span><span id="harp_plusinf__void"></span><span class="target" id="group__harp__general_1gadbfd3aa6ed1b7743899a67399971620f"></span><span class="kt"><span class="pre">double</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_plusinf</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">void</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>Retrieve a double value that respresents +inf (positive infinity). </p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The double value ‘+inf’. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv411harp_mininfv">
<span id="_CPPv311harp_mininfv"></span><span id="_CPPv211harp_mininfv"></span><span id="harp_mininf__void"></span><span class="target" id="group__harp__general_1ga0d6fdf4326a386b00e7f68851b450581"></span><span class="kt"><span class="pre">double</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_mininf</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">void</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>Retrieve a double value that respresents -inf (negative infinity). </p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The double value ‘-inf’. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv429harp_set_coda_definition_pathPKc">
<span id="_CPPv329harp_set_coda_definition_pathPKc"></span><span id="_CPPv229harp_set_coda_definition_pathPKc"></span><span id="harp_set_coda_definition_path__cCP"></span><span class="target" id="group__harp__general_1gab1b7664358a26d101ff84cafbfe486db"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_set_coda_definition_path</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">path</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>Set the search path for CODA product definition files. This function should be called before <a class="reference internal" href="#group__harp__general_1gad1f344feb3bea74322283efca649a045"><span class="std std-ref">harp_init()</span></a> is called.</p>
<p>The CODA C library is used by the HARP C library for import of products that do not use the HARP format. To access data in a product, the CODA C library requires a definition of the internal structure of the product file (unless the product is stored in a self-describing file format). This information is stored in CODA product definition (.codadef) files.</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 ignore 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: <div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">getenv</span><span class="p">(</span><span class="s">"CODA_DEFINITION"</span><span class="p">)</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="nb">NULL</span><span class="p">)</span><span class="w"></span>
<span class="p">{</span><span class="w"></span>
<span class="w"> </span><span class="n">harp_set_coda_definition_path</span><span class="p">(</span><span class="s">"<your path>"</span><span class="p">);</span><span class="w"></span>
<span class="p">}</span><span class="w"></span>
</pre></div>
</div>
</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>path</strong> – Search path for .codadef files </p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">0</span></code>, Success. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-1</span></code>, Error occurred (check <a class="reference internal" href="libharp_error.html#group__harp__error_1gab2eeb46528306c6799632d1e800c4c36"><span class="std std-ref">harp_errno</span></a>). </p></li>
</ul>
</p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv441harp_set_coda_definition_path_conditionalPKcPKcPKc">
<span id="_CPPv341harp_set_coda_definition_path_conditionalPKcPKcPKc"></span><span id="_CPPv241harp_set_coda_definition_path_conditionalPKcPKcPKc"></span><span id="harp_set_coda_definition_path_conditional__cCP.cCP.cCP"></span><span class="target" id="group__harp__general_1ga679243ffdd37971e1d8ff63d498df560"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_set_coda_definition_path_conditional</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">file</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">searchpath</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">relative_location</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>Set the directory for CODA product definition files based on the location of another file. This function should be called before <a class="reference internal" href="#group__harp__general_1gad1f344feb3bea74322283efca649a045"><span class="std std-ref">harp_init()</span></a> is called.</p>
<p>The CODA C library is used by the HARP C library for import of products that do not use the HARP format. To access data in a product, the CODA C library requires a definition of the internal structure of the product file (unless the product is stored in a self-describing file format). This information is stored in CODA product definition (.codadef) files.</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 harp_set_coda_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="reference internal" href="#group__harp__general_1gab1b7664358a26d101ff84cafbfe486db"><span class="std std-ref">harp_set_coda_definition_path()</span></a> in two important ways:<ul class="simple">
<li><p>it will not modify the definition path if the CODA_DEFINITION variable was set</p></li>
<li><p>it will set the definition path to just a single location (either a single file or a single directory)</p></li>
</ul>
</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>file</strong> – Filename of the file to search for </p></li>
<li><p><strong>searchpath</strong> – Search path where to look for the file <em>file</em> (can be NULL) </p></li>
<li><p><strong>relative_location</strong> – 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. </p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">0</span></code>, Success. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-1</span></code>, Error occurred (check <a class="reference internal" href="libharp_error.html#group__harp__error_1gab2eeb46528306c6799632d1e800c4c36"><span class="std std-ref">harp_errno</span></a>). </p></li>
</ul>
</p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv443harp_set_option_create_collocation_datetimei">
<span id="_CPPv343harp_set_option_create_collocation_datetimei"></span><span id="_CPPv243harp_set_option_create_collocation_datetimei"></span><span id="harp_set_option_create_collocation_datetime__i"></span><span class="target" id="group__harp__general_1ga95b3fd9454431662647a0bad099c2aba"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_set_option_create_collocation_datetime</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">enable</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>Enable/Disable the creation of collocation_datetime variables Enabling this option will create a collocation_datetime variable when a collocate_left or collocation_right operation is performed. The collocation_datetime variable will contain the datetime of the sample from the other dataset for the collocated pair. The variable will only be created if the collocation result file contains a datetime_diff column. By default the creation of the collocation_datetime variable is disabled. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>enable</strong> – <ul class="simple">
<li><p>0: Disable creation of collocation_datetime variables. </p></li>
<li><p>1: Enable creation of collocation_datetime variables. </p></li>
</ul>
</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">0</span></code>, Success. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-1</span></code>, Error occurred (check <a class="reference internal" href="libharp_error.html#group__harp__error_1gab2eeb46528306c6799632d1e800c4c36"><span class="std std-ref">harp_errno</span></a>). </p></li>
</ul>
</p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv443harp_get_option_create_collocation_datetimev">
<span id="_CPPv343harp_get_option_create_collocation_datetimev"></span><span id="_CPPv243harp_get_option_create_collocation_datetimev"></span><span id="harp_get_option_create_collocation_datetime__void"></span><span class="target" id="group__harp__general_1gad1eef31adb573b95e1eaa0d1f93192d7"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_get_option_create_collocation_datetime</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">void</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>Retrieve the current setting for the creation of collocation_datetime variables option. <div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#group__harp__general_1ga95b3fd9454431662647a0bad099c2aba"><span class="std std-ref">harp_set_option_create_collocation_datetime()</span></a> </p>
</div>
</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">0</span></code>, Creation of collocation_datetime variables is disabled. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">1</span></code>, Ceation of collocation_datetime variables is enabled. </p></li>
</ul>
</p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv433harp_set_option_enable_aux_afgl86i">
<span id="_CPPv333harp_set_option_enable_aux_afgl86i"></span><span id="_CPPv233harp_set_option_enable_aux_afgl86i"></span><span id="harp_set_option_enable_aux_afgl86__i"></span><span class="target" id="group__harp__general_1ga38646e2cec16b6d94f143af90de664af"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_set_option_enable_aux_afgl86</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">enable</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>Enable/Disable the use of AFGL86 climatology in variable conversions Enabling this option will allow the derived variable functions to create variables using the built-in AFGL86 profiles. If datetime, latitude, and altitude variables are available then altitude regridded versions of the following climatological quantities can be created:<ul class="simple">
<li><p>pressure</p></li>
<li><p>temperature</p></li>
<li><p>number_density (of air)</p></li>
<li><p>CH4_number_density</p></li>
<li><p>CO_number_density</p></li>
<li><p>CO2_number_density</p></li>
<li><p>H2O_number_density</p></li>
<li><p>N2O_number_density</p></li>
<li><p>NO2_number_density</p></li>
<li><p>O2_number_density</p></li>
<li><p>O3_number_density By default the use of AFGL86 is disabled. The use of AFGL86 can also be enabled by setting the HARP_AUX_AFGL86 environment variable. </p></li>
</ul>
</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>enable</strong> – <ul class="simple">
<li><p>0: Disable use of AFGL86. </p></li>
<li><p>1: Enable use of AFGL86. </p></li>
</ul>
</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">0</span></code>, Success. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-1</span></code>, Error occurred (check <a class="reference internal" href="libharp_error.html#group__harp__error_1gab2eeb46528306c6799632d1e800c4c36"><span class="std std-ref">harp_errno</span></a>). </p></li>
</ul>
</p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv433harp_get_option_enable_aux_afgl86v">
<span id="_CPPv333harp_get_option_enable_aux_afgl86v"></span><span id="_CPPv233harp_get_option_enable_aux_afgl86v"></span><span id="harp_get_option_enable_aux_afgl86__void"></span><span class="target" id="group__harp__general_1gadef7f0b01e01812bc2707d5ce186cb7f"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_get_option_enable_aux_afgl86</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">void</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>Retrieve the current setting for the usage of AFGL86 option. <div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#group__harp__general_1ga38646e2cec16b6d94f143af90de664af"><span class="std std-ref">harp_set_option_enable_aux_afgl86()</span></a> </p>
</div>
</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">0</span></code>, Use of AFGL86 is disabled. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">1</span></code>, Use of AFGL86 is enabled. </p></li>
</ul>
</p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv434harp_set_option_enable_aux_usstd76i">
<span id="_CPPv334harp_set_option_enable_aux_usstd76i"></span><span id="_CPPv234harp_set_option_enable_aux_usstd76i"></span><span id="harp_set_option_enable_aux_usstd76__i"></span><span class="target" id="group__harp__general_1ga70782e2ade60c7f06549d379b523e203"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_set_option_enable_aux_usstd76</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">enable</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>Enable/Disable the use of US Standard 76 climatology in variable conversions Enabling this option will allow the derived variable functions to create variables using the built-in US Standard 76 profiles. If an altitude variable is available then altitude regridded versions of the following climatological quantities can be created:<ul class="simple">
<li><p>pressure</p></li>
<li><p>temperature</p></li>
<li><p>number_density (of air)</p></li>
<li><p>CH4_number_density</p></li>
<li><p>CO_number_density</p></li>
<li><p>CO2_number_density</p></li>
<li><p>H2O_number_density</p></li>
<li><p>N2O_number_density</p></li>
<li><p>NO2_number_density</p></li>
<li><p>O2_number_density</p></li>
<li><p>O3_number_density By default the use of US Standard 76 is disabled. The use of US Standard 76 can also be enabled by setting the HARP_AUX_USSTD76 environment variable. </p></li>
</ul>
</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>enable</strong> – <ul class="simple">
<li><p>0: Disable use of US Standard 76. </p></li>
<li><p>1: Enable use of US Standard 76. </p></li>
</ul>
</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">0</span></code>, Success. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-1</span></code>, Error occurred (check <a class="reference internal" href="libharp_error.html#group__harp__error_1gab2eeb46528306c6799632d1e800c4c36"><span class="std std-ref">harp_errno</span></a>). </p></li>
</ul>
</p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv434harp_get_option_enable_aux_usstd76v">
<span id="_CPPv334harp_get_option_enable_aux_usstd76v"></span><span id="_CPPv234harp_get_option_enable_aux_usstd76v"></span><span id="harp_get_option_enable_aux_usstd76__void"></span><span class="target" id="group__harp__general_1ga7327c3e52a6e791c454966519f74ea10"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_get_option_enable_aux_usstd76</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">void</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>Retrieve the current setting for the usage of US Standard 76 option. <div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#group__harp__general_1ga70782e2ade60c7f06549d379b523e203"><span class="std std-ref">harp_set_option_enable_aux_usstd76()</span></a> </p>
</div>
</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">0</span></code>, Use of US Standard 76 is disabled. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">1</span></code>, Use of US Standard 76 is enabled. </p></li>
</ul>
</p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv432harp_set_option_hdf5_compressioni">
<span id="_CPPv332harp_set_option_hdf5_compressioni"></span><span id="_CPPv232harp_set_option_hdf5_compressioni"></span><span id="harp_set_option_hdf5_compression__i"></span><span class="target" id="group__harp__general_1ga37df50bf61d353f47a60cda03c920f36"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_set_option_hdf5_compression</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">level</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>Set the compression level to use for storing variables in HDF5 files. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>level</strong> – The compression level (1=low, …, 9=high) or 0 to disable compression. </p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">0</span></code>, Success. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-1</span></code>, Error occurred (check <a class="reference internal" href="libharp_error.html#group__harp__error_1gab2eeb46528306c6799632d1e800c4c36"><span class="std std-ref">harp_errno</span></a>). </p></li>
</ul>
</p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv432harp_get_option_hdf5_compressionv">
<span id="_CPPv332harp_get_option_hdf5_compressionv"></span><span id="_CPPv232harp_get_option_hdf5_compressionv"></span><span id="harp_get_option_hdf5_compression__void"></span><span class="target" id="group__harp__general_1ga6de1b72347e2a6e4c5ee86f098f32376"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_get_option_hdf5_compression</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">void</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>Retrieve the compression level that is used for storing variables in HDF5 files. <div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#group__harp__general_1ga37df50bf61d353f47a60cda03c920f36"><span class="std std-ref">harp_set_option_hdf5_compression()</span></a> </p>
</div>
</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>0=disabled, 1=low, …, 9=high </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv437harp_set_option_propagate_uncertaintyi">
<span id="_CPPv337harp_set_option_propagate_uncertaintyi"></span><span id="_CPPv237harp_set_option_propagate_uncertaintyi"></span><span id="harp_set_option_propagate_uncertainty__i"></span><span class="target" id="group__harp__general_1ga31e452a3e090b3d9cc143f86553b76db"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_set_option_propagate_uncertainty</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">method</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>Set how to propagate uncertainty. This is only applicable for operations that support propagation of uncertainties. And then only if there is a choice. The propagation can either assume uncertainties to be fully uncorrelated (the default) or fully correlated. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>method</strong> – <ul class="simple">
<li><p>0: Assume uncertainties to be uncorrelated. </p></li>
<li><p>1: Assume uncertainties to be fully correlated. </p></li>
</ul>
</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">0</span></code>, Success. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-1</span></code>, Error occurred (check <a class="reference internal" href="libharp_error.html#group__harp__error_1gab2eeb46528306c6799632d1e800c4c36"><span class="std std-ref">harp_errno</span></a>). </p></li>
</ul>
</p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv437harp_get_option_propagate_uncertaintyv">
<span id="_CPPv337harp_get_option_propagate_uncertaintyv"></span><span id="_CPPv237harp_get_option_propagate_uncertaintyv"></span><span id="harp_get_option_propagate_uncertainty__void"></span><span class="target" id="group__harp__general_1ga9fea5f821a70646daeb1915bf2ae3ddb"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_get_option_propagate_uncertainty</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">void</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>Retrieve the current setting for how to propagate uncertainty. <div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#group__harp__general_1ga31e452a3e090b3d9cc143f86553b76db"><span class="std std-ref">harp_set_option_propagate_uncertainty()</span></a> </p>
</div>
</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">0</span></code> Assume uncertainties to be uncorrelated. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">1</span></code> Assume uncertainties to be fully correlated. </p></li>
</ul>
</p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv436harp_set_option_regrid_out_of_boundsi">
<span id="_CPPv336harp_set_option_regrid_out_of_boundsi"></span><span id="_CPPv236harp_set_option_regrid_out_of_boundsi"></span><span id="harp_set_option_regrid_out_of_bounds__i"></span><span class="target" id="group__harp__general_1ga83bdb60fc511d16c19e7c51d48aae84d"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_set_option_regrid_out_of_bounds</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">method</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>Set how to treat out of bound values during regridding operations. This is only applicable for point interpolation regridding. Any point that falls outside the target grid can be either set to NaN (the default), set to the nearest edge value, or set based on extrapolation (of two nearest points). This global HARP option determines which of the three cases will be used. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>method</strong> – <ul class="simple">
<li><p>0: Set values outside source grid to NaN </p></li>
<li><p>1: Set value outside source grid to edge value (=min/max of source grid) </p></li>
<li><p>2: Extrapolate based on nearest two edge values </p></li>
</ul>
</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">0</span></code>, Success. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-1</span></code>, Error occurred (check <a class="reference internal" href="libharp_error.html#group__harp__error_1gab2eeb46528306c6799632d1e800c4c36"><span class="std std-ref">harp_errno</span></a>). </p></li>
</ul>
</p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv436harp_get_option_regrid_out_of_boundsv">
<span id="_CPPv336harp_get_option_regrid_out_of_boundsv"></span><span id="_CPPv236harp_get_option_regrid_out_of_boundsv"></span><span id="harp_get_option_regrid_out_of_bounds__void"></span><span class="target" id="group__harp__general_1ga6119ed7d2ec68bdddb35845cd663fbef"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_get_option_regrid_out_of_bounds</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">void</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>Retrieve the current setting for treating out of bound values during regridding operations. <div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#group__harp__general_1ga83bdb60fc511d16c19e7c51d48aae84d"><span class="std std-ref">harp_set_option_regrid_out_of_bounds()</span></a> </p>
</div>
</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">0</span></code> Set values outside source grid to NaN </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">1</span></code> Set value outside source grid to edge value (=min/max of source grid) </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">2</span></code> Extrapolate based on nearest two edge values </p></li>
</ul>
</p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv49harp_initv">
<span id="_CPPv39harp_initv"></span><span id="_CPPv29harp_initv"></span><span id="harp_init__void"></span><span class="target" id="group__harp__general_1gad1f344feb3bea74322283efca649a045"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_init</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">void</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>Initializes the HARP C library. This function should be called before any other HARP C library function is called (except for <a class="reference internal" href="#group__harp__general_1gab1b7664358a26d101ff84cafbfe486db"><span class="std std-ref">harp_set_coda_definition_path()</span></a>, <a class="reference internal" href="#group__harp__general_1ga679243ffdd37971e1d8ff63d498df560"><span class="std std-ref">harp_set_coda_definition_path_conditional()</span></a>, and <a class="reference internal" href="libharp_error.html#group__harp__error_1ga88c982481989852993829a34cd310b7d"><span class="std std-ref">harp_set_warning_handler()</span></a>).</p>
<p>HARP may at some point after calling <a class="reference internal" href="#group__harp__general_1gad1f344feb3bea74322283efca649a045"><span class="std std-ref">harp_init()</span></a> also initialize the underlying CODA C library that is used for ingestion of products that are not using the HARP format. The CODA C library may require access to .codadef files that describe the formats of certain product files. In order to tell CODA where these .codadef files are located you will have to either set the CODA_DEFINITION environment variable to the proper path, or set the path programmatically using the <a class="reference internal" href="#group__harp__general_1gab1b7664358a26d101ff84cafbfe486db"><span class="std std-ref">harp_set_coda_definition_path()</span></a> or <a class="reference internal" href="#group__harp__general_1ga679243ffdd37971e1d8ff63d498df560"><span class="std std-ref">harp_set_coda_definition_path_conditional()</span></a> function, before calling <a class="reference internal" href="#group__harp__general_1gad1f344feb3bea74322283efca649a045"><span class="std std-ref">harp_init()</span></a> for the first time.</p>
<p>If you use CODA functions directly in combination with HARP functions you should call coda_init() and coda_done() explicitly yourself and not rely on HARP having performed the coda_init() for you.</p>
<p>It is valid to perform multiple calls to <a class="reference internal" href="#group__harp__general_1gad1f344feb3bea74322283efca649a045"><span class="std std-ref">harp_init()</span></a> after each other. Only the first call to <a class="reference internal" href="#group__harp__general_1gad1f344feb3bea74322283efca649a045"><span class="std std-ref">harp_init()</span></a> will do the actual initialization and all following calls to <a class="reference internal" href="#group__harp__general_1gad1f344feb3bea74322283efca649a045"><span class="std std-ref">harp_init()</span></a> will only increase an initialization counter. Each call to <a class="reference internal" href="#group__harp__general_1gad1f344feb3bea74322283efca649a045"><span class="std std-ref">harp_init()</span></a> needs to be matched by a call to <a class="reference internal" href="#group__harp__general_1ga450874cf522aa206ac0101a013b372c0"><span class="std std-ref">harp_done()</span></a> at clean-up time (i.e. the number of calls to <a class="reference internal" href="#group__harp__general_1ga450874cf522aa206ac0101a013b372c0"><span class="std std-ref">harp_done()</span></a> needs to be equal to the number of calls to <a class="reference internal" href="#group__harp__general_1gad1f344feb3bea74322283efca649a045"><span class="std std-ref">harp_init()</span></a>). Only the final <a class="reference internal" href="#group__harp__general_1ga450874cf522aa206ac0101a013b372c0"><span class="std std-ref">harp_done()</span></a> call (when the initialization counter has reached 0) will perform the actual clean-up of the HARP C library.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">0</span></code>, Success. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-1</span></code>, Error occurred (check <a class="reference internal" href="libharp_error.html#group__harp__error_1gab2eeb46528306c6799632d1e800c4c36"><span class="std std-ref">harp_errno</span></a>). </p></li>
</ul>
</p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv49harp_donev">
<span id="_CPPv39harp_donev"></span><span id="_CPPv29harp_donev"></span><span id="harp_done__void"></span><span class="target" id="group__harp__general_1ga450874cf522aa206ac0101a013b372c0"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_done</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">void</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>Finalizes the HARP C library. This function should be called to let the HARP C library free up any resources it has claimed since initialization.</p>
<p>It is valid to perform multiple calls to <a class="reference internal" href="#group__harp__general_1gad1f344feb3bea74322283efca649a045"><span class="std std-ref">harp_init()</span></a> after each other. Only the first call to <a class="reference internal" href="#group__harp__general_1gad1f344feb3bea74322283efca649a045"><span class="std std-ref">harp_init()</span></a> will do the actual initialization and all following calls to <a class="reference internal" href="#group__harp__general_1gad1f344feb3bea74322283efca649a045"><span class="std std-ref">harp_init()</span></a> will only increase an initialization counter. Each call to <a class="reference internal" href="#group__harp__general_1gad1f344feb3bea74322283efca649a045"><span class="std std-ref">harp_init()</span></a> needs to be matched by a call to <a class="reference internal" href="#group__harp__general_1ga450874cf522aa206ac0101a013b372c0"><span class="std std-ref">harp_done()</span></a> at clean-up time (i.e. the number of calls to <a class="reference internal" href="#group__harp__general_1ga450874cf522aa206ac0101a013b372c0"><span class="std std-ref">harp_done()</span></a> needs to be equal to the number of calls to <a class="reference internal" href="#group__harp__general_1gad1f344feb3bea74322283efca649a045"><span class="std std-ref">harp_init()</span></a>). Only the final <a class="reference internal" href="#group__harp__general_1ga450874cf522aa206ac0101a013b372c0"><span class="std std-ref">harp_done()</span></a> call (when the initialization counter has reached 0) will perform the actual clean-up of the HARP C library.</p>
<p>Calling a HARP function other than <a class="reference internal" href="#group__harp__general_1gad1f344feb3bea74322283efca649a045"><span class="std std-ref">harp_init()</span></a> after the final <a class="reference internal" href="#group__harp__general_1ga450874cf522aa206ac0101a013b372c0"><span class="std std-ref">harp_done()</span></a> call will result in undefined behavior. </p>
</dd></dl>
</div>
<dl class="cpp union">
<dt class="sig sig-object cpp" id="_CPPv417harp_scalar_union">
<span id="_CPPv317harp_scalar_union"></span><span id="_CPPv217harp_scalar_union"></span><span class="target" id="unionharp__scalar__union"></span><span class="k"><span class="pre">union</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_scalar_union</span></span></span><br /></dt>
<dd><div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N17harp_scalar_union9int8_dataE">
<span id="_CPPv3N17harp_scalar_union9int8_dataE"></span><span id="_CPPv2N17harp_scalar_union9int8_dataE"></span><span id="harp_scalar_union::int8_data__int8_t"></span><span class="target" id="unionharp__scalar__union_1a4a9d2eff66135fc91fe8ed0c9f3bba3f"></span><span class="n"><span class="pre">int8_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">int8_data</span></span></span><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N17harp_scalar_union10int16_dataE">
<span id="_CPPv3N17harp_scalar_union10int16_dataE"></span><span id="_CPPv2N17harp_scalar_union10int16_dataE"></span><span id="harp_scalar_union::int16_data__int16_t"></span><span class="target" id="unionharp__scalar__union_1a1590290ec326241b74bbb86c676645a7"></span><span class="n"><span class="pre">int16_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">int16_data</span></span></span><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N17harp_scalar_union10int32_dataE">
<span id="_CPPv3N17harp_scalar_union10int32_dataE"></span><span id="_CPPv2N17harp_scalar_union10int32_dataE"></span><span id="harp_scalar_union::int32_data__int32_t"></span><span class="target" id="unionharp__scalar__union_1ae5e457267f7135c20fae36ab117fcad9"></span><span class="n"><span class="pre">int32_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">int32_data</span></span></span><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N17harp_scalar_union10float_dataE">
<span id="_CPPv3N17harp_scalar_union10float_dataE"></span><span id="_CPPv2N17harp_scalar_union10float_dataE"></span><span id="harp_scalar_union::float_data__float"></span><span class="target" id="unionharp__scalar__union_1ac7ebd021cb43cb1a0fcd0efaeaac1ac6"></span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">float_data</span></span></span><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N17harp_scalar_union11double_dataE">
<span id="_CPPv3N17harp_scalar_union11double_dataE"></span><span id="_CPPv2N17harp_scalar_union11double_dataE"></span><span id="harp_scalar_union::double_data__double"></span><span class="target" id="unionharp__scalar__union_1a84caf21d09365fd3888e0b65027fafc5"></span><span class="kt"><span class="pre">double</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">double_data</span></span></span><br /></dt>
<dd></dd></dl>
</div>
</dd></dl>
<dl class="cpp union">
<dt class="sig sig-object cpp" id="_CPPv416harp_array_union">
<span id="_CPPv316harp_array_union"></span><span id="_CPPv216harp_array_union"></span><span class="target" id="unionharp__array__union"></span><span class="k"><span class="pre">union</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_array_union</span></span></span><br /></dt>
<dd><div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N16harp_array_union9int8_dataE">
<span id="_CPPv3N16harp_array_union9int8_dataE"></span><span id="_CPPv2N16harp_array_union9int8_dataE"></span><span id="harp_array_union::int8_data__int8_tP"></span><span class="target" id="unionharp__array__union_1a1dbbdb8f868b8f374d30f1df311d1952"></span><span class="n"><span class="pre">int8_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">int8_data</span></span></span><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N16harp_array_union10int16_dataE">
<span id="_CPPv3N16harp_array_union10int16_dataE"></span><span id="_CPPv2N16harp_array_union10int16_dataE"></span><span id="harp_array_union::int16_data__int16_tP"></span><span class="target" id="unionharp__array__union_1a5e881b66f87b9f481a1d1cf0140f933a"></span><span class="n"><span class="pre">int16_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">int16_data</span></span></span><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N16harp_array_union10int32_dataE">
<span id="_CPPv3N16harp_array_union10int32_dataE"></span><span id="_CPPv2N16harp_array_union10int32_dataE"></span><span id="harp_array_union::int32_data__int32_tP"></span><span class="target" id="unionharp__array__union_1a104a9d196af01f0286935be7e4dcfc0c"></span><span class="n"><span class="pre">int32_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">int32_data</span></span></span><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N16harp_array_union10float_dataE">
<span id="_CPPv3N16harp_array_union10float_dataE"></span><span id="_CPPv2N16harp_array_union10float_dataE"></span><span id="harp_array_union::float_data__floatP"></span><span class="target" id="unionharp__array__union_1a4927bb7a0ea0f2dc44ab0fbe6caa54f1"></span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">float_data</span></span></span><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N16harp_array_union11double_dataE">
<span id="_CPPv3N16harp_array_union11double_dataE"></span><span id="_CPPv2N16harp_array_union11double_dataE"></span><span id="harp_array_union::double_data__doubleP"></span><span class="target" id="unionharp__array__union_1acb6b371c87f9636e98cdf390d6620fde"></span><span class="kt"><span class="pre">double</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">double_data</span></span></span><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N16harp_array_union11string_dataE">
<span id="_CPPv3N16harp_array_union11string_dataE"></span><span id="_CPPv2N16harp_array_union11string_dataE"></span><span id="harp_array_union::string_data__cPP"></span><span class="target" id="unionharp__array__union_1a50127147d54ae038835226b75231d187"></span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">string_data</span></span></span><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N16harp_array_union3ptrE">
<span id="_CPPv3N16harp_array_union3ptrE"></span><span id="_CPPv2N16harp_array_union3ptrE"></span><span id="harp_array_union::ptr__voidP"></span><span class="target" id="unionharp__array__union_1add9af9569af79ec26dd741fb226b38ba"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">ptr</span></span></span><br /></dt>
<dd></dd></dl>
</div>
</dd></dl>
</dd></dl>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="libharp_error.html" class="btn btn-neutral float-left" title="Error" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="libharp_geometry.html" class="btn btn-neutral float-right" title="Geometry" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2015-2022 S[&]T, The Netherlands.</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
|
