Base::CalendarTimeBase Class Reference
#include <calendartimebase.h>
Inheritance diagram for Base::CalendarTimeBase:
Detailed Description
Allows to obtain the current point in time as year, month, day, etc... down to milliseconds, convert between filetime and CalendarTime, and format the time to a human readable string.(C) 2007 Radon Labs GmbH
Public Types | |
| enum | Month |
| months enum | |
| enum | Weekday |
| weekdays enum | |
| typedef unsigned int | Year |
| typedefs | |
Public Member Functions | |
| CalendarTimeBase () | |
| constructor | |
| void | SetYear (Year y) |
| set the year | |
| Year | GetYear () const |
| get the year | |
| void | SetMonth (Month m) |
| set the month | |
| Month | GetMonth () const |
| get the month | |
| void | SetWeekday (Weekday wd) |
| set the day-of-week | |
| Weekday | GetWeekday () const |
| get the day-of-week | |
| void | SetDay (Day d) |
| set the day (of month) | |
| Day | GetDay () const |
| get the day (of month) | |
| void | SetHour (Hour h) |
| set hour-of-day | |
| Hour | GetHour () const |
| get hour-of-day | |
| void | SetMinute (Minute m) |
| set minute-of-hour | |
| Minute | GetMinute () const |
| get minute-of-hour | |
| void | SetSecond (Second s) |
| set second-of-minute | |
| Second | GetSecond () const |
| get second-of-minute | |
| void | SetMilliSecond (MilliSecond ms) |
| set milliseconds | |
| MilliSecond | GetMilliSecond () const |
| get milliseconds | |
Static Public Member Functions | |
| static Timing::CalendarTime | GetSystemTime () |
| get the current system time | |
| static Timing::CalendarTime | GetLocalTime () |
| get the current local time | |
| static IO::FileTime | SystemTimeToFileTime (const Timing::CalendarTime &systemTime) |
| convert system time to file time | |
| static Timing::CalendarTime | FileTimeToSystemTime (const IO::FileTime &fileTime) |
| convert file time to system time | |
| static IO::FileTime | LocalTimeToFileTime (const Timing::CalendarTime &localTime) |
| convert local time to file time | |
| static Timing::CalendarTime | FileTimeToLocalTime (const IO::FileTime &fileTime) |
| convert file time to local time | |
| static Util::String | Format (const Util::String &fmtString, const Timing::CalendarTime &calTime) |
| format to string | |
| static Util::String | MonthToString (Month m) |
| convert month to string | |
| static Month | StringToMonth (const Util::String &str) |
| convert string to month | |
| static Util::String | WeekdayToString (Weekday d) |
| convert weekday to string | |
| static Weekday | StringToWeekday (const Util::String &str) |
| convert string to weekday | |
Member Function Documentation
| String Base::CalendarTimeBase::Format | ( | const Util::String & | fmtString, | |
| const Timing::CalendarTime & | calTime | |||
| ) | [static] |
format to string
Formats a calendar time into a string using the following substitution string:
{YEAR} - the year member {MONTH} - the month member {WEEKDAY} - the weekday member {DAY} - the numerical day-in-month member {HOUR} - the hour member {MINUTE} - the minute member {SECOND} - the second member {MILLISECOND} - the millisecond member