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
cspice_tyear

Table of contents
Abstract
I/O
Parameters
Examples
Particulars
Exceptions
Files
Restrictions
Required_Reading
Literature_References
Author_and_Institution
Version
Index_Entries

Abstract


   CSPICE_TYEAR returns the double precision value of the number
   of seconds in a tropical year: 31556925.9747

I/O


   Given:

      None.

   the call:

      [tyear] = cspice_tyear

   returns:

      tyear   the number of seconds per tropical year. This value is
              taken from the 1992 Explanatory Supplement to the
              Astronomical Almanac.

              [1,n] = size(tyear); double = class(tyear)

Parameters


   None.

Examples


   Any numerical results shown for this example may differ between
   platforms as the results depend on the SPICE kernels used as input
   and the machine specific arithmetic implementation.

   1) The following code example returns the double precision value of
      the number of seconds in a tropical year, and prints it out.

      Example code begins here.


      function tyear_ex1()

         %
         % Print the double precision value of seconds in a tropical
         % year.
         %
         fprintf( 'Seconds per tropical year: %20.8f\n', cspice_tyear )


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


      Seconds per tropical year:    31556925.97470000


Particulars


   The tropical year is often used as a fundamental unit
   of time when dealing with older ephemeris data. For this
   reason its value in terms of ephemeris seconds is
   recorded in this function.

Exceptions


   Error free.

Files


   None.

Restrictions


   None.

Required_Reading


   MICE.REQ
   TIME.REQ

Literature_References


   [1]  P. Kenneth Seidelmann (Ed.), "Explanatory Supplement to the
        Astronomical Almanac," p 80, University Science Books, 1992.

Author_and_Institution


   J. Diaz del Rio     (ODC Space)
   E.D. Wright         (JPL)

Version


   -Mice Version 1.1.0, 10-AUG-2021 (EDW) (JDR)

       Corrected the value given for the number of seconds in the
       tropical year in the -Abstract section.

       Edited -Examples section to comply with NAIF standard. Added
       example's problem statement.

       Changed output argument name "return_val" to "tyear" to comply
       with NAIF standard.

       Added -Parameters, -Exceptions, -Files, -Restrictions,
       -Literature_References and -Author_and_Institution sections, and
       completed -Particulars section.

       Eliminated use of "lasterror" in rethrow.

       Removed reference to the function's corresponding CSPICE header from
       -Required_Reading section.

   -Mice Version 1.0.1, 13-FEB-2015 (EDW)

       Edited -I/O section to conform to NAIF standard for Mice
       documentation.

   -Mice Version 1.0.0, 22-NOV-2005 (EDW)

Index_Entries


   Number of seconds per tropical year


Fri Dec 31 18:44:28 2021