Mercurial > hg > ltpda
diff m-toolbox/classes/@time/format.m @ 0:f0afece42f48
Import.
author | Daniele Nicolodi <nicolodi@science.unitn.it> |
---|---|
date | Wed, 23 Nov 2011 19:22:13 +0100 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/m-toolbox/classes/@time/format.m Wed Nov 23 19:22:13 2011 +0100 @@ -0,0 +1,45 @@ +% FORMAT Formats a time object into a string +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% +% DESCRIPTION: FORMAT(TIME, FRMT, TIMEZONE) Formats the time object TIME into a +% string, accordingly to the format descrption FRMT and the timezone TIMEZONE. +% +% The FRMT format description can be a format number or a free form date format +% string, as accepted by the datestr() MATLAB function. The FRMT and TIMEZONE +% arguments are optional, if they are not specified or empty, the ones stored in +% the toolbox user preferences are used. +% +% EXAMPLES: +% +% >> t = time(); +% >> t.format(); +% >> t.format('yyyy-mm-dd HH:MM:SS.FFF z'); +% >> t.format('yyyy-mm-dd HH:MM:SS.FFF z', 'UTC'); +% +% SEE ALSO: datestr time/strftime +% +% VERSION: $Id: format.m,v 1.19 2010/07/29 18:07:55 nicolodi Exp $ +% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +function str = format(tt, frmt, timezone) + + % check input arguments + error(nargchk(1, 3, nargin, 'struct')); + + % second and third arguments are optional + if nargin < 3 + timezone = ''; + end + if nargin < 2 + frmt = ''; + end + + % format all input time objects + str = time.strftime(tt(1).utc_epoch_milli, frmt, timezone); + for k = 2:numel(tt) + str = [ str ', ' time.strftime(tt(1).utc_epoch_milli, frmt, timezone)]; + end + +end +