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
//
// GENERATED FILE
//
use super::*;
use crate::SpiceContext;
use f2rust_std::*;
/// Surface and body ID codes to surface string
///
/// Translate a surface ID code, together with a body ID code, to the
/// corresponding surface name. If no such name exists, return a
/// string representation of the surface ID code.
///
/// # Required Reading
///
/// * [DSK](crate::required_reading::dsk)
/// * [NAIF_IDS](crate::required_reading::naif_ids)
///
/// # Brief I/O
///
/// ```text
/// VARIABLE I/O DESCRIPTION
/// -------- --- --------------------------------------------------
/// CODE I Integer surface ID code to translate to a string.
/// BODYID I ID code of body associated with surface.
/// SRFSTR O String corresponding to surface ID code.
/// ISNAME O Logical flag indicating output is a surface name.
/// SFNMLN P Maximum length of surface name.
/// ```
///
/// # Detailed Input
///
/// ```text
/// CODE is an integer code for a surface associated with a
/// body.
///
/// BODYID is an integer code for the body associated with the
/// surface designated by CODE. The combination of CODE
/// and BODYID is to be mapped to a surface name.
/// ```
///
/// # Detailed Output
///
/// ```text
/// SRFSTR is the name of the surface identified by CODE, for the
/// body designated by BODYID, if an association exists
/// between this pair of ID codes and a surface name.
///
/// If CODE has more than one translation, then the most
/// recently defined surface name corresponding to CODE is
/// returned. SRFSTR will have the exact format (case and
/// embedded blanks) used in the definition of the
/// name/code association.
///
/// If the input pair of codes does not map to a surface
/// name, SRFSTR is set to the string representation of
/// CODE.
///
/// SRFSTR should be declared with length SFNMLN (see the
/// $Parameters section below).
///
///
/// ISNAME is a logical flag that is .TRUE. if a surface name
/// corresponding to the input ID codes was found and
/// .FALSE. otherwise. When ISNAME is .FALSE., the output
/// string SRFSTR contains a string representing the
/// integer CODE.
/// ```
///
/// # Parameters
///
/// ```text
/// SFNMLN is the maximum length of a surface name. This
/// parameter is declared in the SPICELIB include file
///
/// srftrn.inc
/// ```
///
/// # Exceptions
///
/// ```text
/// 1) If the input surface ID code cannot be mapped to a name, the
/// output SRFSTR is set to a string representation of the code.
/// The input body ID is ignored. The output ISNAME is set to
/// .FALSE.
///
/// This case is not treated as an error.
/// ```
///
/// # Files
///
/// ```text
/// Surface name-to-ID mappings may be defined at run time by loading
/// text kernels containing kernel variable assignments of the form
///
/// NAIF_SURFACE_NAME += ( <surface name 1>, ... )
/// NAIF_SURFACE_CODE += ( <surface code 1>, ... )
/// NAIF_SURFACE_BODY += ( <body code 1>, ... )
///
/// Above, the Ith elements of the lists on the assignments' right
/// hand sides together define the Ith surface name/ID mapping.
///
/// The same effect can be achieved using assignments formatted as
/// follows:
///
/// NAIF_SURFACE_NAME += <surface name 1>
/// NAIF_SURFACE_CODE += <surface code 1>
/// NAIF_SURFACE_BODY += <body code 1>
///
/// NAIF_SURFACE_NAME += <surface name 2>
/// NAIF_SURFACE_CODE += <surface code 2>
/// NAIF_SURFACE_BODY += <body code 2>
///
/// ...
///
/// Note the use of the
///
/// +=
///
/// operator; this operator appends to rather than overwrites the
/// kernel variable named on the left hand side of the assignment.
/// ```
///
/// # Particulars
///
/// ```text
/// Surfaces are always associated with bodies (which usually are
/// ephemeris objects). For any given body, a mapping between surface
/// names and surface ID codes can be established.
///
/// Bodies serve to disambiguate surface names and ID codes: the set
/// of surface names and surface ID codes for a given body can be
/// thought of as belonging to a name space. A given surface ID code
/// or surface name may be used for surfaces of multiple bodies,
/// without conflict.
///
/// Associations between surface names and ID codes are always made
/// via kernel pool assignments; there are no built-in associations.
///
/// SRFC2S is one of four related subroutines:
///
/// SRFS2C Surface string and body string to surface ID code
/// SRFSCC Surface string and body ID code to surface ID code
/// SRFC2S Surface ID code and body ID code to surface string
/// SRFCSS Surface ID code and body string to surface string
///
/// SRFS2C, SRFC2S, SRFSCC, and SRFCSS perform translations between
/// surface strings and their corresponding integer ID codes.
///
/// Refer to naif_ids.req for details concerning adding new surface
/// name/code associations at run time by loading text kernels.
/// ```
///
/// # Examples
///
/// ```text
/// The formatting of the results shown for this example may differ
/// across platforms.
///
/// 1) Supposed a text kernel has been loaded that contains
/// the following assignments:
///
/// NAIF_SURFACE_NAME += ( 'MGS MOLA 64 pixel/deg',
/// 'MGS MOLA 128 pixel/deg',
/// 'PHOBOS GASKELL Q512' )
/// NAIF_SURFACE_CODE += ( 1, 2, 1 )
/// NAIF_SURFACE_BODY += ( 499, 499, 401 )
///
/// Translate each surface and body ID code pair to the
/// associated surface name. Also perform a translation
/// for a surface ID having no matching name.
///
/// Use the meta-kernel shown below to define the required SPICE
/// kernel variables.
///
///
/// KPL/MK
///
/// File: srfc2s_ex1.tm
///
/// This meta-kernel is intended to support operation of SPICE
/// example programs. The file contents shown here should not be
/// assumed to contain adequate or correct versions of data
/// required by SPICE-based user applications.
///
///
/// \begindata
///
/// NAIF_SURFACE_NAME += ( 'MGS MOLA 64 pixel/deg',
/// 'MGS MOLA 128 pixel/deg',
/// 'PHOBOS GASKELL Q512' )
/// NAIF_SURFACE_CODE += ( 1, 2, 1 )
/// NAIF_SURFACE_BODY += ( 499, 499, 401 )
///
/// \begintext
///
///
/// Example code begins here.
///
///
/// PROGRAM SRFC2S_EX1
/// IMPLICIT NONE
///
/// INCLUDE 'srftrn.inc'
///
/// INTEGER FILSIZ
/// PARAMETER ( FILSIZ = 255 )
///
/// INTEGER NCASE
/// PARAMETER ( NCASE = 5 )
///
/// CHARACTER*(FILSIZ) META
/// CHARACTER*(SFNMLN) SRFNAM
///
/// INTEGER BODYID ( NCASE )
/// INTEGER I
/// INTEGER SURFID ( NCASE )
///
/// LOGICAL ISNAME
///
/// DATA ( SURFID(I), BODYID(I), I = 1, NCASE ) /
/// .
/// . 1, 499,
/// . 1, 401,
/// . 2, 499,
/// . 3, 499,
/// . 1, -1 /
///
///
/// META = 'srfc2s_ex1.tm'
///
/// CALL FURNSH ( META )
///
/// WRITE (*,*) ' '
///
/// DO I = 1, NCASE
///
/// CALL SRFC2S ( SURFID(I), BODYID(I),
/// . SRFNAM, ISNAME )
///
/// WRITE (*,*) 'surface ID = ', SURFID(I)
/// WRITE (*,*) 'body ID = ', BODYID(I)
/// WRITE (*,*) 'name found = ', ISNAME
/// WRITE (*,*) 'surface string = ', SRFNAM
/// WRITE (*,*) ' '
///
/// END DO
///
/// END
///
///
/// When this program was executed on a Mac/Intel/gfortran/64-bit
/// platform, the output was:
///
///
/// surface ID = 1
/// body ID = 499
/// name found = T
/// surface string = MGS MOLA 64 pixel/deg
///
/// surface ID = 1
/// body ID = 401
/// name found = T
/// surface string = PHOBOS GASKELL Q512
///
/// surface ID = 2
/// body ID = 499
/// name found = T
/// surface string = MGS MOLA 128 pixel/deg
///
/// surface ID = 3
/// body ID = 499
/// name found = F
/// surface string = 3
///
/// surface ID = 1
/// body ID = -1
/// name found = F
/// surface string = 1
/// ```
///
/// # Author and Institution
///
/// ```text
/// N.J. Bachman (JPL)
/// J. Diaz del Rio (ODC Space)
/// B.V. Semenov (JPL)
/// E.D. Wright (JPL)
/// ```
///
/// # Version
///
/// ```text
/// - SPICELIB Version 1.0.1, 12-AUG-2021 (JDR)
///
/// Edited the header to comply with NAIF standard.
///
/// - SPICELIB Version 1.0.0, 14-JAN-2016 (NJB) (EDW) (BVS)
/// ```
pub fn srfc2s(
ctx: &mut SpiceContext,
code: i32,
bodyid: i32,
srfstr: &mut str,
isname: &mut bool,
) -> crate::Result<()> {
SRFC2S(
code,
bodyid,
fstr::StrBytes::new(srfstr).as_mut(),
isname,
ctx.raw_context(),
)?;
ctx.handle_errors()?;
Ok(())
}
//$Procedure SRFC2S ( Surface and body ID codes to surface string )
pub fn SRFC2S(
CODE: i32,
BODYID: i32,
SRFSTR: &mut [u8],
ISNAME: &mut bool,
ctx: &mut Context,
) -> f2rust_std::Result<()> {
//
// SPICELIB functions
//
if RETURN(ctx) {
return Ok(());
}
CHKIN(b"SRFC2S", ctx)?;
//
// Try to translate the input codes to a known surface name.
//
ZZSRFC2N(CODE, BODYID, SRFSTR, ISNAME, ctx)?;
if FAILED(ctx) {
CHKOUT(b"SRFC2S", ctx)?;
return Ok(());
}
//
// If there is no matching name, convert the surface ID code to a
// string representation.
//
if !*ISNAME {
INTSTR(CODE, SRFSTR, ctx);
}
CHKOUT(b"SRFC2S", ctx)?;
Ok(())
}