topical media & game development
lib-of-vs-libs-Poco-include-Poco-DateTimeFormatter.h / h
//
// DateTimeFormatter.h
//
//
//
// Library: Foundation
// Package: DateTime
// Module: DateTimeFormatter
//
// Definition of the DateTimeFormatter class.
//
// Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH.
// and Contributors.
//
// Permission is hereby granted, free of charge, to any person or organization
// obtaining a copy of the software and accompanying documentation covered by
// this license (the "Software") to use, reproduce, display, distribute,
// execute, and transmit the Software, and to prepare derivative works of the
// Software, and to permit third-parties to whom the Software is furnished to
// do so, all subject to the following:
//
// The copyright notices in the Software and this entire statement, including
// the above license grant, this restriction and the following disclaimer,
// must be included in all copies of the Software, in whole or in part, and
// all derivative works of the Software, unless such copies or derivative
// works are solely in the form of machine-executable object code generated by
// a source language processor.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//
ifndef Foundation_DateTimeFormatter_INCLUDED
define Foundation_DateTimeFormatter_INCLUDED
include "Poco/Foundation.h"
namespace Poco {
class DateTime;
class LocalDateTime;
class Timestamp;
class Timespan;
class Foundation_API DateTimeFormatter
This class converts dates and times into strings, supporting a
variety of standard and custom formats.
{
public:
enum
{
UTC = 0xFFFF
Special value for timeZoneDifferential denoting UTC.
};
static std::string format(const Timestamp& timestamp, const std::string& fmt, int timeZoneDifferential = UTC);
Formats the given timestamp according to the given format.
The format string is used as a template to format the date and
is copied character by character except for the following special characters,
which are replaced by the corresponding value.
* %w - abbreviated weekday (Mon, Tue, ...)
* %W - full weekday (Monday, Tuesday, ...)
* %b - abbreviated month (Jan, Feb, ...)
* %B - full month (January, February, ...)
* %d - zero-padded day of month (01 .. 31)
* %e - day of month (1 .. 31)
* %f - space-padded day of month ( 1 .. 31)
* %m - zero-padded month (01 .. 12)
* %n - month (1 .. 12)
* %o - space-padded month ( 1 .. 12)
* %y - year without century (70)
* %Y - year with century (1970)
* %H - hour (00 .. 23)
* %h - hour (00 .. 12)
* %a - am/pm
* %A - AM/PM
* %M - minute (00 .. 59)
* %S - second (00 .. 59)
* %i - millisecond (000 .. 999)
* %c - centisecond (0 .. 9)
* %z - time zone differential in ISO 8601 format (Z or +NN.NN).
* %Z - time zone differential in RFC format (GMT or +NNNN)
* %% - percent sign
Class DateTimeFormat defines format strings for various standard date/time formats.
static std::string format(const DateTime& dateTime, const std::string& fmt, int timeZoneDifferential = UTC);
Formats the given date and time according to the given format.
See format(const Timestamp&, const std::string&, int) for more information.
static std::string format(const LocalDateTime& dateTime, const std::string& fmt);
Formats the given local date and time according to the given format.
See format(const Timestamp&, const std::string&, int) for more information.
static std::string format(const Timespan& timespan, const std::string& fmt = "\%dd \%H:\%M:\%S.\%i");
Formats the given timespan according to the given format.
The format string is used as a template to format the date and
is copied character by character except for the following special characters,
which are replaced by the corresponding value.
* %d - days
* %H - hours (00 .. 23)
* %h - total hours (0 .. n)
* %M - minutes (00 .. 59)
* %m - total minutes (0 .. n)
* %S - seconds (00 .. 59)
* %s - total seconds (0 .. n)
* %i - milliseconds (000 .. 999)
* %c - centisecond (0 .. 9)
* %% - percent sign
static std::string tzdISO(int timeZoneDifferential);
Formats the given timezone differential in ISO format.
If timeZoneDifferential is UTC, "Z" is returned,
otherwise, +HH.MM (or -HH.MM) is returned.
static std::string tzdRFC(int timeZoneDifferential);
Formats the given timezone differential in RFC format.
If timeZoneDifferential is UTC, "GMT" is returned,
otherwise ++HHMM (or -HHMM) is returned.
};
} // namespace Poco
endif // Foundation_DateTimeFormatter_INCLUDED
(C) Æliens
04/09/2009
You may not copy or print any of this material without explicit permission of the author or the publisher.
In case of other copyright issues, contact the author.