Procedure

     SGBWVS ( Generic segments: Begin a variable size segment. )

     ENTRY SGBWVS ( HANDLE, DESCR, SEGID, NCONST, CONST, IDXTYP )

Abstract

     Begin writing a generic segment that will contain variable size
     data packets.

Required_Reading

     DAF

Keywords

     GENERIC SEGMENTS

Declarations

    IMPLICIT NONE

    INTEGER               HANDLE
    DOUBLE PRECISION      DESCR  ( * )
    CHARACTER*(*)         SEGID
    INTEGER               NCONST
    DOUBLE PRECISION      CONST  ( * )
    INTEGER               IDXTYP

Brief_I/O

     VARIABLE  I/O  DESCRIPTION
     --------  ---  --------------------------------------------------
     HANDLE    I    Handle of a DAF file opened with write access.
     DESCR     I    Descriptor for a segment.
     SEGID     I    Identifier for a segment.
     NCONST    I    Number of constant values in a segment.
     CONST     I    Array of constant values for a segment.
     IDXTYP    I    Index type for the reference values.

Detailed_Input

     HANDLE   is the handle of a DAF file opened with write access.
              This is the handle of the file in which a generic segment
              will be written.

     DESCR    is the descriptor for a segment that is being written.
              This is the packed form of the DAF double precision and
              integer summaries which contain ND double precision
              numbers and NI integers.

     SEGID    is an identifier for a segment that is being written.
              This is a character string containing at most NC printing
              ASCII characters where

                                /  ND + ( NI + 1 )  \
                     NC =  8 *  | ----------------- |
                                \         2         /

               SEGID may be blank.

     NCONST   is the number of constant values to be placed in a
              segment.

     CONST    is an array of NCONST constant values for a segment.

     IDXTYP   is the index type to use for the reference values.

              Two forms of indexing are provided:

                 1) An implicit form of indexing based on using two
                    values, a starting value, which will have an index
                    of 1, and a step size between reference values,
                    which are used to compute an index and a reference
                    value associated with a specified key value. See
                    the descriptions of the implicit types below for
                    the particular formula used in each case.

                 2) An explicit form of indexing based on a reference
                    value for each data packet.

              See the chapter on generic segments in the DAF required
              or the include file 'sgparam.inc' for more details
              about the index types that are available.

Detailed_Output

     None.

Parameters

     This subroutine makes use of parameters defined in the file
     'sgparam.inc'.

Exceptions

     1)  If this routine is called more than once for a particular file
         and segment, the error SPICE(CALLEDOUTOFORDER) is signaled.

     2)  If the length of the segment identifier, SEGID, is greater
         than NC, as determined from the ND and NI values for a
         particular DAF file, the error SPICE(SEGIDTOOLONG) is
         signaled.

     3)  If the segment identifier contains nonprinting characters, the
         error SPICE(NONPRINTINGCHARS) is signaled.

     4)  If the number of constant values, NCONST, is negative, the
         error SPICE(NUMCONSTANTSNEG) is signaled.

     5)  If the index type for the reference values is not recognized,
         the error SPICE(UNKNOWNINDEXTYPE) is signaled.

     6)  If the file table is full, the error SPICE(FILETABLEFULL) is
         signaled.

Files

     See HANDLE in the $Detailed_Input section.

Particulars

     Begin writing a generic segment for variable size data packets to
     the DAF file associated with HANDLE.

Examples

     See the $Examples section in the header for the main subroutine.
     It contains examples which demonstrate the use of the entry points
     in the generic segments sequential writer. The entry points which
     comprise the generic segments sequential writer must be used
     together in the proper manner. Rather than repeating the examples
     for each entry point they are provided in a single location.

Restrictions

     None.

Literature_References

     None.

Author_and_Institution

     J. Diaz del Rio    (ODC Space)
     K.R. Gehringer     (JPL)
     W.L. Taber         (JPL)

Version

    SPICELIB Version 1.0.1, 03-JUN-2021 (JDR)

        Edited the header to comply with NAIF standard.

    SPICELIB Version 1.0.0, 05-APR-1995 (KRG) (WLT)