Table of contents
CSPICE_REPMD replaces a marker with a double precision number.
Given:
in an arbitrary character string.
help, in
STRING = Scalar
marker an arbitrary character string.
help, marker
STRING = Scalar
The first occurrence of `marker' in the input string is to be
replaced by `value'.
Leading and trailing blanks in `marker' are NOT
significant. In particular, no substitution is performed
if `marker' is blank or empty.
value an arbitrary double precision number.
help, value
DOUBLE = Scalar
sigdig the number of significant digits with which `value' is to be
represented.
help, sigdig
LONG = Scalar
`sigdig' must be greater than zero and less than 15.
the call:
cspice_repmd, in, marker, value, sigdig, out
returns:
out the string obtained by substituting the text representation of
`value' for the first occurrence of `marker' in the input
string.
help, out
STRING = Scalar
The text representation of `value' is in scientific
notation, having the number of significant digits
specified by `sigdig'. The representation of `value' is
produced by the SPICELIB routine DPSTR; see that routine
for details concerning the representation of double
precision numbers.
None.
Any numerical results shown for this example may differ between
platforms as the results depend on the SPICE kernels used as input
and the machine specific arithmetic implementation.
1) The following example illustrate the use of cspice_repmd to
replace a marker within a string with the text representation
of a double precision value.
Example code begins here.
PRO repmd_ex1
;;
;; 1. Single marker, two significant digits.
;;
marker = '#'
instr = 'Invalid value. The value was: #'
cspice_repmd, instr, marker, 5.D1, 2L, outstr
print, 'Case 1: Single marker, two significant digits.'
print, ' Input : ', instr
print, ' Output: ', outstr
print
;;
;; 2. Multiple markers, three significant digits.
;;
marker = ' XX '
instr = 'Left > Right endpoint. Left: XX; Right: XX'
cspice_repmd, instr, marker, -5.2D-9, 3L, outstr
print, 'Case 2: Multiple markers, three significant digits.'
print, ' Input : ', instr
print, ' Output: ', outstr
print
;;
;; 3. Excessive significant digits.
;;
marker = '#'
instr = 'Invalid value. The value was: #'
cspice_repmd, instr, marker, 5.D1, 100L, outstr
print, 'Case 3: Excessive significant digits.'
print, ' Input : ', instr
print, ' Output: ', outstr
print
END
When this program was executed on a Mac/Intel/IDL8.x/64-bit
platform, the output was:
Case 1: Single marker, two significant digits.
Input : Invalid value. The value was: #
Output: Invalid value. The value was: 5.0E+01
Case 2: Multiple markers, three significant digits.
Input : Left > Right endpoint. Left: XX; Right: XX
Output: Left > Right endpoint. Left: -5.20E-09; Right: XX
Case 3: Excessive significant digits.
Input : Invalid value. The value was: #
Output: Invalid value. The value was: 5.0000000000000E+01
Note that, in Case #3 even though 100 digits of precision were
requested, only 14 were returned.
This is one of a family of related routines for inserting values
into strings. They are typically to construct messages that
are partly fixed, and partly determined at run time. For example,
a message like
'Fifty-one pictures were found in directory [USER.DATA].'
might be constructed from the fixed string
'#1 pictures were found in directory #2.'
by the calls
cspice_repmct, string, '#1', 51L, 'C', string
cspice_repmc, string, '#2', '[USER.DATA]', string
which substitute the cardinal text 'Fifty-one' and the character
string '[USER.DATA]' for the markers '#1' and '#2' respectively.
The complete list of routines is shown below.
cspice_repmc ( Replace marker with character string value )
cspice_repmd ( Replace marker with double precision value )
cspice_repmf ( Replace marker with formatted d.p. value )
cspice_repmi ( Replace marker with integer value )
cspice_repml ( Replace marker with logical value )
cspice_repmct ( Replace marker with cardinal text )
cspice_repmot ( Replace marker with ordinal text )
1) If `marker' is blank or empty, or if `marker' is not a substring of
`in', no substitution is performed. (`out' and `in' are identical.)
2) If any of the input arguments, `in', `marker', `value' or
`sigdig', is undefined, an error is signaled by the IDL error
handling system.
3) If any of the input arguments, `in', `marker', `value' or
`sigdig', is not of the expected type, or it does not have the
expected dimensions and size, an error is signaled by the Icy
interface.
4) If the output argument `out' is not a named variable, an error
is signaled by the Icy interface.
None.
1) The maximum number of significant digits returned is 14.
2) This routine makes explicit use of the format of the string
returned by the SPICELIB routine DPSTR; should that routine
change, substantial work may be required to bring this routine
back up to snuff.
ICY.REQ
None.
J. Diaz del Rio (ODC Space)
-Icy Version 1.0.0, 01-NOV-2021 (JDR)
replace marker with d.p. number
|