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 repmot_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

       repmot_c ( Replace marker with ordinal text )

       void repmot_c ( ConstSpiceChar   * in,
                       ConstSpiceChar   * marker,
                       SpiceInt           value,
                       SpiceChar          rtcase,
                       SpiceInt           outlen,
                       SpiceChar        * out      )

#### Abstract

       Replace a marker with the text representation of an ordinal
       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.
       rtcase     I   Case of replacement text.
       outlen     I   Available space in output string.
       out        O   Output string.
       MAXLON     P   Maximum length of an ordinal 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 the text
                   representation of the ordinal number `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 integer.

       rtcase      indicates the case of the replacement text. `rtcase' may be
                   any of the following:

                      rtcase   Meaning        Example
                      ------   -----------    -----------------------
                      U, u     Uppercase      ONE HUNDRED FIFTY-THIRD

                      L, l     Lowercase      one hundred fifty-third

                      C, c     Capitalized    One hundred fifty-third

       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 the ordinal number `value' for the first
                   occurrence of `marker' in the input string.

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

#### Parameters

       MAXLON      is the maximum expected length of any ordinal text.
                   147 characters are sufficient to hold the text
                   representing any ordinal value whose corresponding ordinal
                   value is in the range

                      ( -10^12, 10^12 )

                   An example of a number whose ordinal text representation
                   is of maximum length is

                      - 777 777 777 777

#### 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 the value of `rtcase' is not recognized, the error
           SPICE(INVALIDCASE) is signaled by a routine in the call tree
           of this routine. `out' is not changed.

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

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

       6)  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

          "The fifty-first picture was found in directory [USER.DATA]."

       might be constructed from the fixed string

          "The #1 picture was found in directory #2."

       by the calls

          repmot_c ( string, "#1",  51,  'L',     lenstr, string );
          repmc_c  ( string, "#2", "[USER.DATA]", lenstr, string );

       which substitute the ordinal text "fifty-first" 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 repmot_c to
          replace a marker within a string with the ordinal text
          corresponding to an integer.

          Example code begins here.

          /.
             Program repmot_ex1
          ./
          #include <stdio.h>
          #include "SpiceUsr.h"

          int main( )
          {

             /.
             Local constants.
             ./
             #define STRLEN       81

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

             /.
             1. Uppercase
             ./
             marker = "#";
             instr  = "INVALID COMMAND. # WORD NOT RECOGNIZED.";

             repmot_c ( instr, marker, 5, 'U', STRLEN, outstr );

             printf( "Case 1: Replacement text in uppercase.\n" );
             printf( "   Input string :  %s\n", instr );
             printf( "   Output string:  %s\n", outstr );
             printf( " \n" );

             /.
             2. Lowercase
             ./
             marker = " XX ";
             instr  = "The XX word of the XX sentence was ...";

             repmot_c ( instr, marker, 5, 'L', STRLEN, outstr );

             printf( "Case 2: Replacement text in lowercase.\n" );
             printf( "   Input string :  %s\n", instr );
             printf( "   Output string:  %s\n", outstr );
             printf( " \n" );

             /.
             2. Capitalized
             ./
             marker = " XX ";
             instr  = "Name:  YY.  Rank:  XX.";

             repmc_c ( instr, "YY", "Moriarty", STRLEN, outstr );
             repmot_c ( outstr, marker, 5, 'C', STRLEN, outstr );

             printf( "Case 3: Replacement text in capitalized.\n" );
             printf( "   Input string :  %s\n", instr );
             printf( "   Output string:  %s\n", outstr );

             return ( 0 );
          }

          When this program was executed on a Mac/Intel/cc/64-bit
          platform, the output was:

          Case 1: Replacement text in uppercase.
             Input string :  INVALID COMMAND. # WORD NOT RECOGNIZED.
             Output string:  INVALID COMMAND. FIFTH WORD NOT RECOGNIZED.

          Case 2: Replacement text in lowercase.
             Input string :  The XX word of the XX sentence was ...
             Output string:  The fifth word of the XX sentence was ...

          Case 3: Replacement text in capitalized.
             Input string :  Name:  YY.  Rank:  XX.
             Output string:  Name:  Moriarty.  Rank:  Fifth.

#### Restrictions

       1)  `value' must be in the range accepted by the SPICELIB routine
           INTORD. This range is currently

              ( -10**12, 10**12 )

           Note that the endpoints of the interval are excluded.

#### 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, 04-AUG-2021 (JDR)

           Changed the input argument names "repcase" and "lenout" to
           "rtcase" and "outlen" for consistency with other routines.

           Updated error handling strategy to Standard, as the f2c'ed
           routine might signal errors.

           Edited the header to comply with NAIF standard. Added complete
           code example from existing fragments.

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

#### Index_Entries

       replace marker with ordinal text

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

    Fri Dec 31 18:41:11 2021