Index of Functions: A B C D E F G H I J K L M N O P Q R S T U V W X
Index Page repmd_c

Table of contents

Procedure Abstract Required_Reading Keywords Brief_I/O Detailed_Input | Detailed_Output Parameters Exceptions Files Particulars Examples | Restrictions Literature_References Author_and_Institution Version Index_Entries

#### Procedure

       repmd_c ( Replace marker with double precision number )

       void repmd_c ( ConstSpiceChar     * in,
                      ConstSpiceChar     * marker,
                      SpiceDouble          value,
                      SpiceInt             sigdig,
                      SpiceInt             outlen,
                      SpiceChar          * out     )

#### Abstract

       Replace a marker with a double precision number.

#### Required_Reading

       None.

#### Keywords

       CHARACTER
       CONVERSION
       STRING

#### Brief_I/O

       VARIABLE  I/O  DESCRIPTION
       --------  ---  --------------------------------------------------
       in         I   Input string.
       marker     I   Marker to be replaced.
       value      I   Replacement value.
       sigdig     I   Significant digits in replacement text.
       outlen     I   Available space in output string.
       out        O   Output string.
       MAXLDP     P   Maximum length of a d.p. number.

#### Detailed_Input

       in          is an arbitrary character string.

       marker      is an arbitrary character string. 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       is an arbitrary double precision number.

       sigdig      is the number of significant digits with which `value' is
                   to be represented. `sigdig' must be greater than zero and
                   less than 15.

       outlen      is the maximum allowed length of the output string `out'.
                   This length must be large enough to hold the output string
                   plus the null-terminator character. If the output string
                   is expected to have N characters, `outlen' should be at
                   least N+1.

#### Detailed_Output

       out         is the string obtained by substituting the text
                   representation of `value' for the first occurrence of
                   `marker' in the input string.

                   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.

                   `out' and `in' must be identical or disjoint.

#### Parameters

       MAXLDP   is the maximum expected length of the text representation
                of a double precision number. 23 characters are
                sufficient to hold any result returned by the SPICELIB
                routine DPSTR. (See -Restrictions.)

                This routine assumes that the input d.p. value is such
                that its string representation contains no more than
                MAXLDP characters.

#### Exceptions

       1)  If `out' does not have sufficient length to accommodate the
           result of the substitution, the result will be truncated on
           the right.

       2)  If `marker' is blank or empty, or if `marker' is not a substring of
           `in', this routine leaves the input string unchanged, except that
           trailing blanks will be trimmed. This case is not considered an error.

       3)  If any of the `in' or `marker' input string pointers is null,
           the error SPICE(NULLPOINTER) is signaled.

       4)  If the `out' output string pointer is null, the error
           SPICE(NULLPOINTER) is signaled.

       5)  If the `out' output string has length less than one character,
           the error SPICE(STRINGTOOSHORT) is signaled.

#### Files

       None.

#### Particulars

       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

          #include "SpiceUsr.h"
               .
               .
               .
          #define   STRLEN                  81
               .
               .
               .
          repmct_c ( string, "#1",  51,  'c',     STRLEN, string );
          repmc_c  ( string, "#2", "[USER.DATA]", STRLEN, 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.

          repmc_c    ( Replace marker with character string value )
          repmd_c    ( Replace marker with double precision value )
          repmf_c    ( Replace marker with formatted d.p. value   )
          repmi_c    ( Replace marker with integer value          )
          repml_c    ( Replace marker with logical value          )
          repmct_c   ( Replace marker with cardinal text          )
          repmot_c   ( Replace marker with ordinal text           )

#### Examples

       The numerical results shown for this example 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) The following example illustrate the use of repmd_c to
          replace a marker within a string with the text representation
          of a double precision value.

          Example code begins here.

          /.
             Program repmd_ex1
          ./
          #include <stdio.h>
          #include <string.h>
          #include "SpiceUsr.h"

          int main( )
          {

             /.
             Local parameters.
             ./
             #define STRLEN       81

             /.
             Local variables.
             ./
             SpiceChar            instr  [STRLEN];
             SpiceChar            marker [STRLEN];
             SpiceChar            outstr [STRLEN];

             /.
             1. Single marker, two significant digits.
             ./
             strncpy( marker, "#", 2 );
             strncpy( instr, "Invalid value. The value was:  #", 33 );

             repmd_c ( instr, marker, 5.0e1, 2, STRLEN, outstr );

             printf( "Case 1: Single marker, two significant digits.\n" );
             printf( "   Input : %s\n", instr );
             printf( "   Output: %s\n", outstr );
             printf( "\n" );

             /.
             2. Multiple markers, three significant digits.
             ./
             strncpy( marker, " XX ", 5 );
             strncpy( instr, "Left > Right endpoint. Left: XX; Right: XX", 43 );

             repmd_c ( instr, marker, -5.2e-9, 3, STRLEN, outstr );

             printf( "Case 2: Multiple markers, three significant digits.\n" );
             printf( "   Input : %s\n", instr );
             printf( "   Output: %s\n", outstr );
             printf( "\n" );

             /.
             3. Excessive significant digits.
             ./
             strncpy( marker, "#", 2 );
             strncpy( instr, "Invalid value. The value was:  #", 33 );

             repmd_c ( instr, marker, 5.0e1, 100, STRLEN, outstr );

             printf( "Case 3: Excessive significant digits.\n" );
             printf( "   Input : %s\n", instr );
             printf( "   Output: %s\n", outstr );
             printf( "\n" );

             return ( 0 );
          }

          When this program was executed on a Mac/Intel/cc/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.

#### Restrictions

       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.

#### Literature_References

       None.

#### Author_and_Institution

       N.J. Bachman        (JPL)
       J. Diaz del Rio     (ODC Space)
       I.M. Underwood      (JPL)

#### Version

       -CSPICE Version 1.1.0, 01-NOV-2021 (JDR)

           Changed the input argument name "lenout" to "outlen" for consistency
           with other routines.

           Edited the header to comply with NAIF standard. Added complete
           code example based on existing code fragment.

       -CSPICE Version 1.0.0, 14-AUG-2002 (NJB) (IMU)

#### Index_Entries

       replace marker with d.p. number

#### Link to routine repmd_c source file repmd_c.c

    Fri Dec 31 18:41:11 2021