scard_c

Index Page scard_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 scard_c (  SpiceInt      card,
                       SpiceCell   * cell  )
#### Abstract
       Set the cardinality of a SPICE cell of any data type.
#### Required_Reading
       CELLS
#### Keywords
       CELLS
#### Brief_I/O
       VARIABLE  I/O  DESCRIPTION
       --------  ---  --------------------------------------------------
       card       I   Cardinality of (number of elements in) the cell.
       cell       O   The cell.
#### Detailed_Input
       card         is the cardinality of (number of elements in) the
                    cell.
#### Detailed_Output
       cell         is a SpiceCell of any data type. On output, the
                    cardinality of the cell is card.  The data portion of
                    the cell is left unchanged.

                    If the cardinality is set to zero, the cell becomes a
                    CSPICE set:  the cell's "is a set?" attribute becomes
                    true.  The cell then can be used as an input to the
                    CSPICE set routines such as insrt*_c.
#### Parameters
       None.
#### Exceptions
       1)  If the cardinality value supplied is less than 0 or greater
           than the cell size, the error SPICE(INVALIDCARDINALITY) is
           signaled.
#### Files
       None.
#### Particulars
       The set cardinality (scard_c) and set size (ssize_c) routines are
       typically used to initialize cells for subsequent use.

       The set cardinality routines are also used by library routines
       which manipulate cells (including set and window routines) to
       reset the cardinalities of cells as they gain or lose elements.
#### Examples
       1) Declare an integer cell.  Populate the cell, then reset
          the cardinality to zero to effectively make room in the
          cell.

             #include "SpiceUsr.h"
                   .
                   .
                   .

             #define SIZE          10

             Spiceint              i;

             /.
             Declare a cell with room for SIZE integers.
             ./
             SPICEINT_CELL         ( icell, SIZE );

             /.
             Fill in the cell with integers 0 through 9.
             ./

             for ( i = 0;  i < SIZE;  i++ )
             {
                appndi_c ( i, &icell );
             }
                   .
                   .
                   .
             /.
             Make room in the cell.
             ./
             scard_c ( 0, &icell );
                   .
                   .
                   .
#### Restrictions
       None.
#### 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.0.0, 21-AUG-2002 (NJB) (CAC) (WLT) (IMU)
#### Index_Entries
       set the cardinality of an integer cell
#### Link to routine scard_c source file scard_c.c

    Thu Apr 16 08:59:03 2009