]> Creatis software - CreaPhase.git/blobdiff - octave_packages/m/time/now.m
update packages
[CreaPhase.git] / octave_packages / m / time / now.m
diff --git a/octave_packages/m/time/now.m b/octave_packages/m/time/now.m
new file mode 100644 (file)
index 0000000..84ab028
--- /dev/null
@@ -0,0 +1,61 @@
+## Copyright (C) 2000-2012 Paul Kienzle
+##
+## This file is part of Octave.
+##
+## Octave is free software; you can redistribute it and/or modify it
+## under the terms of the GNU General Public License as published by
+## the Free Software Foundation; either version 3 of the License, or (at
+## your option) any later version.
+##
+## Octave is distributed in the hope that it will be useful, but
+## WITHOUT ANY WARRANTY; without even the implied warranty of
+## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+## General Public License for more details.
+##
+## You should have received a copy of the GNU General Public License
+## along with Octave; see the file COPYING.  If not, see
+## <http://www.gnu.org/licenses/>.
+
+## -*- texinfo -*-
+## @deftypefn {Function File} {t =} now ()
+## Return the current local date/time as a serial day number
+## (see @code{datenum}).
+##
+## The integral part, @code{floor (now)} corresponds to the number of days
+## between today and Jan 1, 0000.
+##
+## The fractional part, @code{rem (now, 1)} corresponds to the current
+## time.
+## @seealso{clock, date, datenum}
+## @end deftypefn
+
+## Author: pkienzle <pkienzle@users.sf.net>
+## Created: 10 October 2001 (CVS)
+## Adapted-By: William Poetra Yoga Hadisoeseno <williampoetra@gmail.com>
+
+function t = now ()
+
+  if (nargin != 0)
+    print_usage ();
+  endif
+
+  t = datenum (clock ());
+
+  ## The following doesn't work (e.g., one hour off on 2005-10-04):
+  ##
+  ##   seconds since 1970-1-1 corrected by seconds from GMT to local time
+  ##   divided by 86400 sec/day plus day num for 1970-1-1
+  ##   t = (time - mktime(gmtime(0)))/86400 + 719529;
+  ##
+  ## mktime(gmtime(0)) does indeed return the offset from Greenwich to the
+  ## local time zone, but we need to account for daylight savings time
+  ## changing by an hour the offset from CUT for part of the year.
+
+endfunction
+
+
+%!assert (isnumeric (now ()));
+%!assert (now () > 0);
+%!assert (now () <= now ());
+
+%!error now (1);