octave_packages/m/time/now.m

   1 ## Copyright (C) 2000-2012 Paul Kienzle
   2 ##
   3 ## This file is part of Octave.
   4 ##
   5 ## Octave is free software; you can redistribute it and/or modify it
   6 ## under the terms of the GNU General Public License as published by
   7 ## the Free Software Foundation; either version 3 of the License, or (at
   8 ## your option) any later version.
   9 ##
  10 ## Octave is distributed in the hope that it will be useful, but
  11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
  12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 ## General Public License for more details.
  14 ##
  15 ## You should have received a copy of the GNU General Public License
  16 ## along with Octave; see the file COPYING.  If not, see
  17 ## <http://www.gnu.org/licenses/>.
  18
  19 ## -*- texinfo -*-
  20 ## @deftypefn {Function File} {t =} now ()
  21 ## Return the current local date/time as a serial day number
  22 ## (see @code{datenum}).
  23 ##
  24 ## The integral part, @code{floor (now)} corresponds to the number of days
  25 ## between today and Jan 1, 0000.
  26 ##
  27 ## The fractional part, @code{rem (now, 1)} corresponds to the current
  28 ## time.
  29 ## @seealso{clock, date, datenum}
  30 ## @end deftypefn
  31
  32 ## Author: pkienzle <pkienzle@users.sf.net>
  33 ## Created: 10 October 2001 (CVS)
  34 ## Adapted-By: William Poetra Yoga Hadisoeseno <williampoetra@gmail.com>
  35
  36 function t = now ()
  37
  38   if (nargin != 0)
  39     print_usage ();
  40   endif
  41
  42   t = datenum (clock ());
  43
  44   ## The following doesn't work (e.g., one hour off on 2005-10-04):
  45   ##
  46   ##   seconds since 1970-1-1 corrected by seconds from GMT to local time
  47   ##   divided by 86400 sec/day plus day num for 1970-1-1
  48   ##   t = (time - mktime(gmtime(0)))/86400 + 719529;
  49   ##
  50   ## mktime(gmtime(0)) does indeed return the offset from Greenwich to the
  51   ## local time zone, but we need to account for daylight savings time
  52   ## changing by an hour the offset from CUT for part of the year.
  53
  54 endfunction
  55
  56
  57 %!assert (isnumeric (now ()));
  58 %!assert (now () > 0);
  59 %!assert (now () <= now ());
  60
  61 %!error now (1);