removc_c

Index Page removc_c
A B C D E F G H I J K L M N O P Q R S T U V W X
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
       void removc_c ( ConstSpiceChar  * item,
                       SpiceCell       * set   )
#### Abstract
       Remove an item from a character set.
#### Required_Reading
       SETS
#### Keywords
       CELLS, SETS
#### Brief_I/O
       VARIABLE  I/O  DESCRIPTION
       --------  ---  --------------------------------------------------
       item       I   Item to be removed.
       set       I/O  Removal set.
#### Detailed_Input
       item        is an item which is to be removed from the specified
                   set. item may or may not already be an element of the
                   set.  Trailing blanks in item are not significant.

       set         is a CSPICE set.  set must be declared as a character
                   SpiceCell.

                   On input, set may or may not contain the input item
                   as an element.
#### Detailed_Output
       set          on output contains the difference of the input set and
                    the input item. If the item is not an element of the
                    set, the set is not changed.
#### Parameters
       None.
#### Exceptions
       1) If the input set argument is a SpiceCell of type other than
          character, the error SPICE(TYPEMISMATCH) is signaled.

       2) If the input set argument does not qualify as a CSPICE set,
          the error SPICE(NOTASET) will be signaled.  CSPICE sets have
          their data elements sorted in increasing order and contain
          no duplicate data elements.

       3) If the input string pointer is null, the error SPICE(NULLPOINTER)
          is signaled.
#### Files
       None.
#### Particulars
       None.
#### Examples
       1) In the following example, the element "PLUTO" is removed from
          the character set planets and inserted into the character set
          asteroids.

             #include "SpiceUsr.h"
                    .
                    .
                    .
             /.
             Declare the sets with string length NAMLEN and with maximum
             number of elements MAXSIZ.
             ./
             SPICECHAR_CELL ( planets,   MAXSIZ, NAMLEN );
             SPICECHAR_CELL ( asteroids, MAXSIZ, NAMLEN );
                    .
                    .
                    .
             removc_c ( "PLUTO", &planets   );
             insrtc_c ( "PLUTO", &asteroids );

          If "PLUTO" is not an element of planets, then the contents of
          planets are not changed. Similarly, if "PLUTO" is already an
          element of asteroids, the contents of asteroids remain unchanged.
#### Restrictions
       1)  String comparisons performed by this routine are Fortran-style:
           trailing blanks in the input set or key value are ignored.
           This gives consistent behavior with CSPICE code generated by
           the f2c translator, as well as with the Fortran SPICE Toolkit.

           Note that this behavior is not identical to that of the ANSI
           C library functions strcmp and strncmp.
#### Literature_References
       None.
#### Author_and_Institution
       N.J. Bachman    (JPL)
       C.A. Curzon     (JPL)
       W.L. Taber      (JPL)
       I.M. Underwood  (JPL)
#### Version
       -CSPICE Version 1.1.0, 07-MAR-2009 (NJB)

           This file now includes the header file f2cMang.h.
           This header supports name mangling of f2c library
           functions.

       -CSPICE Version 1.0.0, 07-AUG-2002 (NJB) (CAC) (WLT) (IMU)
#### Index_Entries
       remove an item from a character set
#### Link to routine removc_c source file removc_c.c

    Thu Apr 16 08:58:57 2009