Index Page
cspice_tpictr
A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X 

Abstract
I/O
Examples
Particulars
Required Reading
Version
Index_Entries

Abstract


   CSPICE_TPICTR takes a time format sample then creates a
   time format picture suitable for use by cspice_timout.

I/O


   Given:

      sample   a representative time string to use as a model to 
               format time strings (the string need not describe 
               an actual date - only format matters).

               [1,c1] = size(sample); char = class(sample)

                  or

               [1,1] = size(sample); cell = class(sample)

   the call:

      [pictur, ok, errmsg] = cspice_tpictr(sample)

   returns:

      pictur   a format picture string suitable for use with the 
               SPICE routine cspice_timout.

               [1,c2] = size(pictur); char = class(pictur)

      ok       a boolean indicating whether 'sample' parsed
               without error, true, or some parse error occurred, false.

               [1,1] = size(ok); logical = class(ok)

      errmsg   a string containing the explanation of
               the parse error.

               [1,c3] = size(errmsg); char = class(errmsg)

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.

      %
      % Given a sample with the format of the UNIX date string,
      % create a SPICE time picture for use in cspice_timout.
      %
      sample = 'Thu Oct 1 11:11:11 PDT 1111';

      %
      % Make the call. 'ok' returns false is an error occurred.
      % The error description returns in the err variable.
      %
      [pictur, ok, errmsg] = cspice_tpictr( sample );

      %
      % If a false error flag, print the picture; if
      % a true error flag, print the error message.
      %
      if ( ok )
         disp( pictur )
      else
         disp( errmsg )
      end

   MATLAB outputs:

      Wkd Mon DD HR:MN:SC PDT YYYY ::UTC-7

Particulars


   None.

Required Reading


   For important details concerning this module's function, please refer to
   the CSPICE routine tpictr_c.

   MICE.REQ
   TIME.REQ

Version


   -Mice Version 1.0.2, 09-MAR-2015, EDW (JPL)

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

   -Mice Version 1.2.0, 10-MAY-2011, EDW (JPL)

      "logical" call replaced with "zzmice_logical."

   -Mice Version 1.0.1, 31-MAR-2010, EDW (JPL)

      Renamed error message argument 'error' to 'errmsg'.

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

Index_Entries


   Use a sample time string to produce a time format picture


Wed Apr  5 18:00:36 2017