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

   dskstl_c ( DSK, set tolerance ) 

   void dskstl_c ( SpiceInt        keywrd,
                   SpiceDouble     dpval  )

Abstract

   Set the value of a specified DSK tolerance or margin parameter.

Required_Reading

   DSK

Keywords

   DSK
   MARGIN
   NUMERIC
   TOLERANCE


Brief_I/O

   VARIABLE  I/O  DESCRIPTION
   --------  ---  --------------------------------------------------
   keywrd     I   Code specifying parameter to set.
   dpval      I   Value of parameter.

Detailed_Input

   keywrd      is an integer code specifying the parameter to set. See
               the include file SpiceDtl.h for a description of the
               possible keywords.

   dpval       is the new value of the parameter specified by `keywrd'.

               <<< Use extreme caution. This routine performs no
               checks on DPVAL. >>>

Detailed_Output

   None.

   This routine operates by side effects.

Parameters

   See the header file

      SpiceDtl.h

   for descriptions and values of the tolerance or margin parameters
   accessed by this routine, and of the keyword parameters used to
   refer to them.

Exceptions

   1)  If the input keyword is not recognized, the error
       SPICE(INDEXOUTOFRANGE) is signaled by a routine in the call
       tree of this routine.

   2)  If an attempt is made to modify a fixed parameter, the error
       SPICE(IMMUTABLEVALUE) is signaled by a routine in the call
       tree of this routine.

Files

   None.

Particulars

   The DSK tolerance routines centralize numeric tolerance and margin
   values used by the DSK subsystem. The DSK subsystem retrieves values
   from the DSK tolerance subsystem to use at run time.

   The DSK tolerance access functions are

      dskgtl_c {DSK, get tolerance value}
      dskstl_c {DSK, set tolerance value}

   To minimize run time overhead, the "keywords" used by these routines
   to identify parameters are actually integer codes.

   SPICE users may override certain values maintained by this subsystem;
   others values are fixed. It is recommended that any change to the
   tolerance values made at run time be performed only by expert SPICE
   users.

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) Obtain, display, and update the DSK type 2 plate expansion
      fraction.


      Example code begins here.


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

      int main()
      {
         SpiceDouble             dpval;

         dskgtl_c ( SPICE_DSK_KEYXFR, &dpval );

         printf ( "Default plate expansion fraction = %e\n", dpval );

         /.
         Update the parameter.
         ./
         dskstl_c ( SPICE_DSK_KEYXFR, 1.e-8  );

         /.
         Verify the update.
         ./
         dskgtl_c ( SPICE_DSK_KEYXFR, &dpval );

         printf ( "New plate expansion fraction     = %e\n", dpval );

         return ( 0 );
      }


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


      Default plate expansion fraction = 1.000000e-10
      New plate expansion fraction     = 1.000000e-08

Restrictions

   1)  The default settings used by the DSK subsystem should be
       overridden only by expert SPICE users.

   2)  This routine do not check the validity of new parameter values
       supplied by the calling application.

Literature_References

   None.

Author_and_Institution

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

Version

   -CSPICE Version 1.0.1, 10-AUG-2021 (JDR)

       Corrected -Procedure section's description.

       Edited the header to comply with NAIF standard. Added example's
       solution. Corrected CSPICE include file name reference in
       "keywrd" description.

   -CSPICE Version 1.0.0, 27-FEB-2016 (NJB)

Index_Entries

   set DSK tolerance or margin parameters
Fri Dec 31 18:41:05 2021