rsspice 0.1.0

Pure Rust port of the SPICE Toolkit for space geometry
Documentation
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
//
// GENERATED FILE
//

use super::*;
use crate::SpiceContext;
use f2rust_std::*;

const CDOFF: i32 = 24;
const CDSCSZ: i32 = 11;
const CLSIDX: i32 = 1;
const TYPIDX: i32 = (CLSIDX + 1);
const LENIDX: i32 = (TYPIDX + 1);
const SIZIDX: i32 = (LENIDX + 1);
const NAMIDX: i32 = (SIZIDX + 1);
const IXTIDX: i32 = (NAMIDX + 1);
const IXPIDX: i32 = (IXTIDX + 1);
const NFLIDX: i32 = (IXPIDX + 1);
const ORDIDX: i32 = (NFLIDX + 1);
const METIDX: i32 = (ORDIDX + 1);
const SDSCSZ: i32 = 24;
const EKTIDX: i32 = 1;
const SNOIDX: i32 = (EKTIDX + 1);
const IMDIDX: i32 = (SNOIDX + 1);
const TNMIDX: i32 = (IMDIDX + 1);
const NCIDX: i32 = (TNMIDX + 1);
const NRIDX: i32 = (NCIDX + 1);
const RTIDX: i32 = (NRIDX + 1);
const CPTIDX: i32 = (RTIDX + 1);
const DPTIDX: i32 = (CPTIDX + 1);
const IPTIDX: i32 = (DPTIDX + 1);
const MFLIDX: i32 = (IPTIDX + 1);
const IFLIDX: i32 = (MFLIDX + 1);
const SHDIDX: i32 = (IFLIDX + 1);
const CFHIDX: i32 = (SHDIDX + 1);
const CSNIDX: i32 = (CFHIDX + 1);
const LCPIDX: i32 = (CSNIDX + 1);
const LDPIDX: i32 = (LCPIDX + 1);
const LIPIDX: i32 = (LDPIDX + 1);
const LCWIDX: i32 = (LIPIDX + 1);
const LDWIDX: i32 = (LCWIDX + 1);
const LIWIDX: i32 = (LDWIDX + 1);
const NMLIDX: i32 = (LIWIDX + 1);
const CHR: i32 = 1;
const DP: i32 = 2;
const INT: i32 = 3;
const TIME: i32 = 4;

/// EK, add d.p. data to column
///
/// Add data to an double precision column in a specified EK record.
///
/// # Required Reading
///
/// * [EK](crate::required_reading::ek)
///
/// # Brief I/O
///
/// ```text
///  VARIABLE  I/O  DESCRIPTION
///  --------  ---  --------------------------------------------------
///  HANDLE     I   EK file handle.
///  SEGNO      I   Index of segment containing record.
///  RECNO      I   Record to which data is to be added.
///  COLUMN     I   Column name.
///  NVALS      I   Number of values to add to column.
///  DVALS      I   Double precision values to add to column.
///  ISNULL     I   Flag indicating whether column entry is null.
/// ```
///
/// # Detailed Input
///
/// ```text
///  HANDLE   is the handle of an EK file open for write access.
///
///  SEGNO    is the index of the segment to which data is to
///           be added.
///
///  RECNO    is the index of the record to which data is to be
///           added. This record number is relative to the start
///           of the segment indicated by SEGNO; the first
///           record in the segment has index 1.
///
///  COLUMN   is the name of the column to which data is to be
///           added.
///
///  NVALS,
///  DVALS    are, respectively, the number of values to add to
///           the specified column and the set of values
///           themselves. The data values are written into the
///           specified column and record.
///
///           If the  column has fixed-size entries, then NVALS
///           must equal the entry size for the specified column.
///
///           Only one value can be added to a virtual column.
///
///
///  ISNULL   is a logical flag indicating whether the entry is
///           null. If ISNULL is .FALSE., the column entry
///           defined by NVALS and DVALS is added to the
///           specified kernel file.
///
///           If ISNULL is .TRUE., NVALS and DVALS are ignored.
///           The contents of the column entry are undefined.
///           If the column has fixed-length, variable-size
///           entries, the number of entries is considered to
///           be 1.
/// ```
///
/// # Detailed Output
///
/// ```text
///  None. See $Particulars for a description of the effect of this
///  routine.
/// ```
///
/// # Exceptions
///
/// ```text
///  1)  If HANDLE is invalid, an error is signaled by a routine in the
///      call tree of this routine.
///
///  2)  If SEGNO is out of range, an error is signaled by a routine in
///      the call tree of this routine.
///
///  3)  If COLUMN is not the name of a declared column, an error
///      is signaled by a routine in the call tree of this routine.
///
///  4)  If COLUMN specifies a column of whose data type is not
///      double precision, the error SPICE(WRONGDATATYPE) is signaled.
///
///  5)  If RECNO is out of range, an error is signaled by a routine in
///      the call tree of this routine.
///
///  6)  If the specified column has fixed-size entries and NVALS does
///      not match this size, an error is signaled by a routine in the
///      call tree of this routine.
///
///  7)  If the specified column has variable-size entries and NVALS is
///      non-positive, an error is signaled by a routine in the call
///      tree of this routine.
///
///  8)  If an attempt is made to add a null value to a column that
///      doesn't take null values, an error is signaled by a routine in
///      the call tree of this routine.
///
///  9)  If COLUMN specifies a column of whose class is not
///      an character class known to this routine, the error
///      SPICE(NOCLASS) is signaled.
///
///  10) If an I/O error occurs while reading or writing the indicated
///      file, the error is signaled by a routine in the call tree of
///      this routine.
/// ```
///
/// # Files
///
/// ```text
///  See the EK Required Reading ek.req for a discussion of the EK file
///  format.
/// ```
///
/// # Particulars
///
/// ```text
///  This routine operates by side effects: it modifies the named
///  EK file by adding data to the specified record in the specified
///  column. Data may be added to a segment in random order; it is not
///  necessary to fill in columns or rows sequentially. Data may only
///  be added one column entry at a time.
/// ```
///
/// # Examples
///
/// ```text
///  The numerical results shown for these examples may differ across
///  platforms. The results depend on the SPICE kernels used as
///  input, the compiler and supporting libraries, and the machine
///  specific arithmetic implementation.
///
///  1) This example demonstrates how to add double precision values
///     to a column in three different cases: single values,
///     variable-size arrays and static-size arrays.
///
///     Create an EK that contains a table TAB that has the following
///     columns:
///
///        Column name   Data Type   Size
///        -----------   ---------   ----
///        DP_COL_1      DP          1
///        DP_COL_2      DP          VARIABLE
///        DP_COL_3      DP          3
///
///     Issue the following query
///
///         QUERY = 'SELECT DP_COL_1, DP_COL_2, DP_COL_3 FROM TAB'
///
///     to fetch and dump column values from the rows that satisfy the
///     query.
///
///
///     Example code begins here.
///
///
///           PROGRAM EKACED_EX1
///           IMPLICIT NONE
///
///     C
///     C     Include the EK Column Name Size (CNAMSZ)
///     C     and EK Query Limit Parameters (MAXQRY)
///     C
///           INCLUDE 'ekcnamsz.inc'
///           INCLUDE 'ekqlimit.inc'
///
///     C
///     C     Local parameters
///     C
///           CHARACTER*(*)         EKNAME
///           PARAMETER           ( EKNAME  = 'ekaced_ex1.bdb' )
///
///           CHARACTER*(*)         TABLE
///           PARAMETER           ( TABLE   = 'TAB' )
///
///           INTEGER               COL3SZ
///           PARAMETER           ( COL3SZ = 3   )
///
///           INTEGER               DECLEN
///           PARAMETER           ( DECLEN = 200 )
///
///           INTEGER               ERRLEN
///           PARAMETER           ( ERRLEN = 1840 )
///
///           INTEGER               MXC2SZ
///           PARAMETER           ( MXC2SZ = 4   )
///
///           INTEGER               NAMLEN
///           PARAMETER           ( NAMLEN = 40  )
///
///           INTEGER               NCOLS
///           PARAMETER           ( NCOLS  = 3   )
///
///           INTEGER               NROWS
///           PARAMETER           ( NROWS  = 4   )
///
///     C
///     C     Local variables
///     C
///           CHARACTER*(DECLEN)    CDECLS ( NCOLS  )
///           CHARACTER*(CNAMSZ)    CNAMES ( NCOLS  )
///           CHARACTER*(ERRLEN)    ERRMSG
///           CHARACTER*(NAMLEN)    IFNAME
///           CHARACTER*(MAXQRY)    QUERY
///
///           DOUBLE PRECISION      COL1
///           DOUBLE PRECISION      COL2   ( MXC2SZ )
///           DOUBLE PRECISION      COL3   ( COL3SZ )
///           DOUBLE PRECISION      DVALS  ( MXC2SZ )
///
///           INTEGER               ELTIDX
///           INTEGER               HANDLE
///           INTEGER               I
///           INTEGER               J
///           INTEGER               NELT
///           INTEGER               NMROWS
///           INTEGER               NRESVC
///           INTEGER               RECNO
///           INTEGER               ROW
///           INTEGER               SEGNO
///           INTEGER               SELIDX
///
///           LOGICAL               ERROR
///           LOGICAL               FOUND
///           LOGICAL               ISNULL
///
///     C
///     C     Open a new EK file.  For simplicity, we will not
///     C     reserve any space for the comment area, so the
///     C     number of reserved comment characters is zero.
///     C     The variable IFNAME is the internal file name.
///     C
///           NRESVC  =  0
///           IFNAME  =  'Test EK/Created 13-JUN-2019'
///
///           CALL EKOPN ( EKNAME, IFNAME, NRESVC, HANDLE )
///
///     C
///     C     Set up the column names and declarations
///     C     for the TAB segment.  We'll index all of
///     C     the columns.
///     C
///           CNAMES(1) = 'DP_COL_1'
///           CDECLS(1) = 'DATATYPE = DOUBLE PRECISION, ' //
///          .            'INDEXED  = TRUE'
///
///           CNAMES(2) = 'DP_COL_2'
///           CDECLS(2) = 'DATATYPE = DOUBLE PRECISION, ' //
///          .            'SIZE = VARIABLE, NULLS_OK = TRUE'
///
///           CNAMES(3) = 'DP_COL_3'
///           CDECLS(3) = 'DATATYPE = DOUBLE PRECISION, ' //
///          .            'SIZE = 3'
///
///     C
///     C     Start the segment.
///     C
///           CALL EKBSEG ( HANDLE, TABLE,  NCOLS,
///          .              CNAMES, CDECLS, SEGNO )
///
///     C
///     C     At the records to the table.
///     C
///           DO I = 1, NROWS
///
///     C
///     C        Append a new record to the EK.
///     C
///              CALL EKAPPR ( HANDLE, SEGNO, RECNO )
///
///     C
///     C        Add DP_COL_1
///     C
///              COL1 = I * 100.D0
///
///              CALL EKACED ( HANDLE,    SEGNO, RECNO,
///          .                 CNAMES(1), 1,     COL1,  .FALSE. )
///
///     C
///     C        Add I items to DP_COL_2
///     C
///              DO J = 1, I
///                 COL2(J) = J + I*200.D0
///              END DO
///
///              ISNULL = ( I .EQ. 2 )
///
///              CALL EKACED ( HANDLE,    SEGNO, RECNO,
///          .                 CNAMES(2), I,     COL2,  ISNULL )
///
///     C
///     C        Add 3 items to DP_COL_3
///     C
///              DO J = 1, 3
///                 COL3(J) =  I + J*100.D0
///              END DO
///
///              CALL EKACED ( HANDLE,    SEGNO, RECNO,
///          .                 CNAMES(3), 3,     COL3, .FALSE. )
///
///           END DO
///
///     C
///     C     Close the file.
///     C
///           CALL EKCLS ( HANDLE )
///
///     C
///     C     Open the created file. Perform the query and show the
///     C     results.
///     C
///           CALL FURNSH ( EKNAME )
///
///           QUERY = 'SELECT DP_COL_1, DP_COL_2, DP_COL_3 FROM TAB'
///
///     C
///     C     Query the EK system for data rows matching the
///     C     SELECT constraints.
///     C
///           CALL EKFIND ( QUERY, NMROWS, ERROR, ERRMSG )
///
///     C
///     C     Check whether an error occurred while processing the
///     C     SELECT clause. If so, output the error message.
///     C
///           IF ( ERROR ) THEN
///
///              WRITE(*,*) 'SELECT clause error: ', ERRMSG
///
///           ELSE
///
///              DO ROW = 1, NMROWS
///
///                 WRITE(*,*) ' '
///                 WRITE(*,'(A,I3)') 'ROW  = ', ROW
///
///     C
///     C           Fetch values from column DP_COL_1.  Since
///     C           DP_COL_1 was the first column selected, the
///     C           selection index SELIDX is set to 1.
///     C
///                 SELIDX = 1
///                 ELTIDX = 1
///                 CALL EKGD ( SELIDX,    ROW,     ELTIDX,
///          .                  DVALS(1),  ISNULL,  FOUND   )
///
///                 IF ( ISNULL ) THEN
///
///                    WRITE(*,*) '  COLUMN = DP_COL_1: <Null>'
///
///                 ELSE
///
///                    WRITE(*,*) '  COLUMN = DP_COL_1:', DVALS(1)
///
///                 END IF
///
///     C
///     C           Fetch values from column DP_COL_2 in the current
///     C           row.  Since DP_COL_2 contains variable-size array
///     C           elements, we call EKNELT to determine how many
///     C           elements to fetch.
///     C
///                 SELIDX = 2
///                 CALL EKNELT ( SELIDX, ROW, NELT )
///
///                 ELTIDX = 1
///                 ISNULL = .FALSE.
///
///                 DO WHILE (       ( ELTIDX .LE.  NELT   )
///          .                 .AND. (        .NOT. ISNULL )  )
///
///                    CALL EKGD ( SELIDX,         ROW,     ELTIDX,
///          .                     DVALS(ELTIDX),  ISNULL,  FOUND   )
///
///                    ELTIDX = ELTIDX + 1
///
///     C
///     C           If the column entry is null, we'll be kicked
///     C           out of this loop after the first iteration.
///     C
///                 END DO
///
///                 IF ( ISNULL ) THEN
///
///                    WRITE(*,*) '  COLUMN = DP_COL_2: <Null>'
///
///                 ELSE
///
///                    WRITE(*,'(A,4F6.1)') '   COLUMN = DP_COL_2:',
///          .                              ( DVALS(I), I = 1, NELT )
///
///                 END IF
///
///     C
///     C           Fetch values from column DP_COL_3 in the current
///     C           row.  We need not call EKNELT since we know how
///     C           many elements are in each column entry.
///     C
///                 SELIDX = 3
///                 ELTIDX = 1
///                 ISNULL = .FALSE.
///
///                 DO WHILE (       ( ELTIDX .LE.  COL3SZ )
///          .                 .AND. (        .NOT. ISNULL )  )
///
///                    CALL EKGD ( SELIDX,         ROW,     ELTIDX,
///          .                     DVALS(ELTIDX),  ISNULL,  FOUND   )
///
///                    ELTIDX = ELTIDX + 1
///
///                 END DO
///
///                 IF ( ISNULL ) THEN
///
///                    WRITE(*,*) '  COLUMN = DP_COL_3: <Null>'
///
///                 ELSE
///
///                    WRITE(*,'(A,3F6.1)') '   COLUMN = DP_COL_3:',
///          .                           ( DVALS(I), I = 1, COL3SZ )
///
///                 END IF
///
///              END DO
///
///     C
///     C     We either parsed the SELECT clause or had an error.
///     C
///           END IF
///
///           END
///
///
///     When this program was executed on a Mac/Intel/gfortran/64-bit
///     platform, the output was:
///
///
///     ROW  =   1
///        COLUMN = DP_COL_1:   100.00000000000000
///        COLUMN = DP_COL_2: 201.0
///        COLUMN = DP_COL_3: 101.0 201.0 301.0
///
///     ROW  =   2
///        COLUMN = DP_COL_1:   200.00000000000000
///        COLUMN = DP_COL_2: <Null>
///        COLUMN = DP_COL_3: 102.0 202.0 302.0
///
///     ROW  =   3
///        COLUMN = DP_COL_1:   300.00000000000000
///        COLUMN = DP_COL_2: 601.0 602.0 603.0
///        COLUMN = DP_COL_3: 103.0 203.0 303.0
///
///     ROW  =   4
///        COLUMN = DP_COL_1:   400.00000000000000
///        COLUMN = DP_COL_2: 801.0 802.0 803.0 804.0
///        COLUMN = DP_COL_3: 104.0 204.0 304.0
///
///
///  2) Suppose we want to create an E-kernel which contains a table
///     of items that have been ordered. The columns of this table
///     are shown below:
///
///        DATAITEMS
///
///           Column Name     Data Type
///           -----------     ---------
///           ITEM_ID         INTEGER
///           ORDER_ID        INTEGER
///           ITEM_NAME       CHARACTER*(*)
///           DESCRIPTION     CHARACTER*(*)
///           PRICE           DOUBLE PRECISION
///
///
///     This EK file will have one segment containing the DATAITEMS
///     table.
///
///     This examples demonstrates how to open a new EK file; create
///     the segment described above and how to insert a new record
///     into it.
///
///
///     Example code begins here.
///
///
///           PROGRAM EKACED_EX2
///           IMPLICIT NONE
///
///     C
///     C     Include the EK Column Name Size (CNAMSZ)
///     C
///           INCLUDE 'ekcnamsz.inc'
///
///     C
///     C     Local parameters
///     C
///           CHARACTER*(*)         EKNAME
///           PARAMETER           ( EKNAME  = 'ekaced_ex2.bdb' )
///
///           CHARACTER*(*)         TABLE
///           PARAMETER           ( TABLE   = 'DATAITEMS'      )
///
///           INTEGER               DECLEN
///           PARAMETER           ( DECLEN = 200 )
///
///           INTEGER               DESCLN
///           PARAMETER           ( DESCLN = 80  )
///
///           INTEGER               NAMLEN
///           PARAMETER           ( NAMLEN = 40  )
///
///           INTEGER               NCOLS
///           PARAMETER           ( NCOLS  = 5   )
///
///     C
///     C     Local variables
///     C
///           CHARACTER*(DECLEN)    CDECLS ( NCOLS )
///           CHARACTER*(CNAMSZ)    CNAMES ( NCOLS )
///           CHARACTER*(DESCLN)    DESCRP
///           CHARACTER*(NAMLEN)    IFNAME
///           CHARACTER*(NAMLEN)    ITEMNM
///
///           DOUBLE PRECISION      PRICE
///
///           INTEGER               ESIZE
///           INTEGER               HANDLE
///           INTEGER               ITEMID
///           INTEGER               NRESVC
///           INTEGER               ORDID
///           INTEGER               RECNO
///           INTEGER               SEGNO
///
///           LOGICAL               ISNULL
///
///     C
///     C     Open a new EK file.  For simplicity, we will not
///     C     reserve any space for the comment area, so the
///     C     number of reserved comment characters is zero.
///     C     The variable IFNAME is the internal file name.
///     C
///           NRESVC  =  0
///           IFNAME  =  'Test EK;Created 21-JUN-2019'
///
///           CALL EKOPN ( EKNAME, IFNAME, NRESVC, HANDLE )
///
///     C
///     C     Set up the table and column names and declarations
///     C     for the DATAITEMS segment.  We'll index all of
///     C     the columns.  All columns are scalar, so we omit
///     C     the size declaration.
///     C
///           CNAMES(1) =  'ITEM_ID'
///           CDECLS(1) =  'DATATYPE = INTEGER, INDEXED = TRUE'
///
///           CNAMES(2) =  'ORDER_ID'
///           CDECLS(2) =  'DATATYPE = INTEGER, INDEXED = TRUE'
///
///           CNAMES(3) =  'ITEM_NAME'
///           CDECLS(3) =  'DATATYPE = CHARACTER*(*),' //
///          .             'INDEXED  = TRUE'
///
///           CNAMES(4) =  'DESCRIPTION'
///           CDECLS(4) =  'DATATYPE = CHARACTER*(*),' //
///          .             'INDEXED  = TRUE'
///
///           CNAMES(5) =  'PRICE'
///           CDECLS(5) =  'DATATYPE = DOUBLE PRECISION,' //
///          .             'INDEXED  = TRUE'
///
///
///     C
///     C     Start the segment. Since we have no data for this
///     C     segment, start the segment by just defining the new
///     C     segment's schema.
///     C
///           CALL EKBSEG ( HANDLE, TABLE,  NCOLS,
///          .              CNAMES, CDECLS, SEGNO )
///
///     C
///     C     Append a new, empty record to the DATAITEMS
///     C     table. Recall that the DATAITEMS table
///     C     is in segment number 1.  The call will return
///     C     the number of the new, empty record.
///     C
///           SEGNO = 1
///           CALL EKAPPR ( HANDLE, SEGNO, RECNO )
///
///     C
///     C     At this point, the new record is empty.  A valid EK
///     C     cannot contain empty records.  We fill in the data
///     C     here.  Data items are filled in one column at a time.
///     C     The order in which the columns are filled in is not
///     C     important.  We use the EKACEx (add column entry)
///     C     routines to fill in column entries.  We'll assume
///     C     that no entries are null.  All entries are scalar,
///     C     so the entry size is 1.
///     C
///           ISNULL   =  .FALSE.
///           ESIZE    =  1
///
///     C
///     C     The following variables will contain the data for
///     C     the new record.
///     C
///           ORDID    =   10011
///           ITEMID   =   531
///           ITEMNM   =  'Sample item'
///           DESCRP   =  'This sample item is used only in tests.'
///           PRICE    =   1345.678D0
///
///     C
///     C     Note that the names of the routines called
///     C     correspond to the data types of the columns:  the
///     C     last letter of the routine name is C, I, or D,
///     C     depending on the data type.
///     C
///           CALL EKACEI ( HANDLE, SEGNO,  RECNO, 'ORDER_ID',
///          .              ESIZE,  ORDID,  ISNULL               )
///
///           CALL EKACEI ( HANDLE, SEGNO,  RECNO, 'ITEM_ID',
///          .              ESIZE,  ITEMID, ISNULL               )
///
///           CALL EKACEC ( HANDLE, SEGNO,  RECNO, 'ITEM_NAME',
///          .              ESIZE,  ITEMNM, ISNULL               )
///
///           CALL EKACEC ( HANDLE, SEGNO,  RECNO, 'DESCRIPTION',
///          .              ESIZE,  DESCRP, ISNULL               )
///
///           CALL EKACED ( HANDLE, SEGNO,  RECNO, 'PRICE',
///          .              ESIZE,  PRICE,  ISNULL               )
///
///     C
///     C     Close the file to make the update permanent.
///     C
///           CALL EKCLS ( HANDLE )
///
///           END
///
///
///     When this program is executed, no output is presented on
///     screen. After run completion, a new EK file exists in the
///     output directory.
/// ```
///
/// # Author and Institution
///
/// ```text
///  N.J. Bachman       (JPL)
///  J. Diaz del Rio    (ODC Space)
///  W.L. Taber         (JPL)
/// ```
///
/// # Version
///
/// ```text
/// -    SPICELIB Version 1.2.1, 06-JUL-2021 (JDR)
///
///         Edited the header to comply with NAIF standard. Added complete
///         code examples from existing fragments.
///
/// -    SPICELIB Version 1.2.0, 05-FEB-2015 (NJB)
///
///         Updated to use ERRHAN.
///
/// -    SPICELIB Version 1.1.0, 18-JUN-1999 (WLT)
///
///         Removed an unbalanced call to CHKOUT
///
/// -    SPICELIB Version 1.0.0, 26-SEP-1995 (NJB)
/// ```
pub fn ekaced(
    ctx: &mut SpiceContext,
    handle: i32,
    segno: &mut i32,
    recno: i32,
    column: &str,
    nvals: i32,
    dvals: &[f64],
    isnull: bool,
) -> crate::Result<()> {
    EKACED(
        handle,
        segno,
        recno,
        column.as_bytes(),
        nvals,
        dvals,
        isnull,
        ctx.raw_context(),
    )?;
    ctx.handle_errors()?;
    Ok(())
}

//$Procedure EKACED ( EK, add d.p. data to column )
pub fn EKACED(
    HANDLE: i32,
    SEGNO: &mut i32,
    RECNO: i32,
    COLUMN: &[u8],
    NVALS: i32,
    DVALS: &[f64],
    ISNULL: bool,
    ctx: &mut Context,
) -> f2rust_std::Result<()> {
    let DVALS = DummyArray::new(DVALS, 1..);
    let mut COLDSC = StackArray::<i32, 11>::new(1..=CDSCSZ);
    let mut CLASS: i32 = 0;
    let mut DTYPE: i32 = 0;
    let mut RECPTR: i32 = 0;
    let mut SEGDSC = StackArray::<i32, 24>::new(1..=SDSCSZ);

    //
    // SPICELIB functions
    //

    //
    // Local variables
    //

    //
    // Use discovery check-in.
    //
    // First step:  find the descriptor for the named segment.  Using
    // this descriptor, get the column descriptor.
    //
    ZZEKSDSC(HANDLE, *SEGNO, SEGDSC.as_slice_mut(), ctx)?;
    ZZEKCDSC(
        HANDLE,
        SEGDSC.as_slice(),
        COLUMN,
        COLDSC.as_slice_mut(),
        ctx,
    )?;

    if FAILED(ctx) {
        return Ok(());
    }

    //
    // This column had better be of double precision or `time' type.
    //
    DTYPE = COLDSC[TYPIDX];

    if ((DTYPE != DP) && (DTYPE != TIME)) {
        CHKIN(b"EKACED", ctx)?;
        SETMSG(b"Column # is of type #; EKACED only works with d.p. or time columns.  RECNO = #; SEGNO = #; EK = #.", ctx);
        ERRCH(b"#", COLUMN, ctx);
        ERRINT(b"#", DTYPE, ctx);
        ERRINT(b"#", RECNO, ctx);
        ERRINT(b"#", *SEGNO, ctx);
        ERRHAN(b"#", HANDLE, ctx)?;
        SIGERR(b"SPICE(WRONGDATATYPE)", ctx)?;
        CHKOUT(b"EKACED", ctx)?;
        return Ok(());
    }

    //
    // Look up the record pointer for the target record.
    //
    ZZEKTRDP(HANDLE, SEGDSC[RTIDX], RECNO, &mut RECPTR, ctx)?;

    //
    // Now it's time to add data to the file.
    //
    CLASS = COLDSC[CLSIDX];

    if (CLASS == 2) {
        //
        // Class 2 columns contain scalar d.p. data.
        //
        ZZEKAD02(
            HANDLE,
            SEGDSC.as_slice_mut(),
            COLDSC.as_slice(),
            RECPTR,
            *DVALS.first(),
            ISNULL,
            ctx,
        )?;
    } else if (CLASS == 5) {
        //
        // Class 5 columns contain array-valued d.p. data.
        //
        ZZEKAD05(
            HANDLE,
            SEGDSC.as_slice_mut(),
            COLDSC.as_slice(),
            RECPTR,
            NVALS,
            DVALS.as_slice(),
            ISNULL,
            ctx,
        )?;
    } else {
        //
        // This is an unsupported d.p. column class.
        //
        *SEGNO = SEGDSC[SNOIDX];

        CHKIN(b"EKACED", ctx)?;
        SETMSG(b"Class # from input column descriptor is not a supported d.p. class.  COLUMN = #; RECNO = #; SEGNO = #; EK = #.", ctx);
        ERRINT(b"#", CLASS, ctx);
        ERRCH(b"#", COLUMN, ctx);
        ERRINT(b"#", RECNO, ctx);
        ERRINT(b"#", *SEGNO, ctx);
        ERRHAN(b"#", HANDLE, ctx)?;
        SIGERR(b"SPICE(NOCLASS)", ctx)?;
        CHKOUT(b"EKACED", ctx)?;
        return Ok(());
    }

    Ok(())
}