Qore Programming Language Reference Manual  0.9.3
ql_time.dox.h
1 namespace Qore {
4 
6 struct DateTimeInfo {
8  int day;
10  int dow;
12  int doy;
14  bool dst;
16  int hour;
20  int minute;
22  int month;
24  bool relative;
26  int second;
30  int year;
34  string zone_name;
35 };
36 };
38 namespace Qore {
40 
42 struct IsoWeekInfo {
44  int day;
46  int week;
48  int year;
49 };
50 };
51 
53 namespace Qore {
255 
257 
271 int clock_getmicros();
272 
274 
288 int clock_getmillis();
289 
291 
305 int clock_getnanos();
306 
308 
317 date date(date dt);
318 
320 
344 date date(string dtstr);
345 
347 
361 date date(softfloat f);
362 
364 
378 date date(int i);
379 
381 
388 date date();
389 
391 
398 date date(null null);
399 
401 
418 date date(string dtstr, string mask);
419 
421 
435 hash<DateTimeInfo> date_info(date dt);
436 
438 
448 hash<DateTimeInfo> date_info();
449 
451 
465 date date_ms(softint ms);
466 
468 
472 nothing date_ms();
473 
475 
489 date date_us(softint us);
490 
492 
513 date days(softint days);
514 
516 
520 nothing days();
521 
523 
539 string format_date(string format, date dt);
540 
542 
546 nothing format_date();
547 
549 
565 date getDateFromISOWeek(softint year, softint week, softint day = 1);
566 
568 
577 int getDayNumber(date dt);
578 
580 
584 nothing getDayNumber();
585 
587 
598 int getDayOfWeek(date dt);
599 
601 
605 nothing getDayOfWeek();
606 
608 
619 int getISODayOfWeek(date dt);
620 
622 
626 nothing getISODayOfWeek();
627 
629 
642 hash<IsoWeekInfo> getISOWeekHash(date dt);
643 
645 
649 nothing getISOWeekHash();
650 
652 
668 string getISOWeekString(date dt);
669 
671 
675 nothing getISOWeekString();
676 
678 
699 date get_date_from_iso_week(softint year, softint week, softint day = 1);
700 
702 
718 int get_day_number(date dt);
719 
721 
739 int get_day_of_week(date dt);
740 
742 
756 int get_days(date dt);
757 
759 
763 nothing get_days();
764 
766 
788 
790 
814 
816 
840 int get_duration_seconds(date dt);
841 
843 
868 float get_duration_seconds_f(date dt);
869 
871 
887 int get_epoch_seconds(date dt);
888 
890 
894 nothing get_epoch_seconds();
895 
897 
911 int get_hours(date dt);
912 
914 
918 nothing get_hours();
919 
921 
939 int get_iso_day_of_week(date dt);
940 
942 
962 hash<IsoWeekInfo> get_iso_week_hash(date dt);
963 
965 
983 string get_iso_week_string(date dt);
984 
986 
1002 int get_microseconds(date dt);
1003 
1005 
1019 date get_midnight(date dt);
1020 
1022 
1026 nothing get_midnight();
1027 
1029 
1045 int get_milliseconds(date dt);
1046 
1048 
1052 nothing get_milliseconds();
1053 
1055 
1069 int get_minutes(date dt);
1070 
1072 
1076 nothing get_minutes();
1077 
1079 
1093 int get_months(date dt);
1094 
1096 
1100 nothing get_months();
1101 
1103 
1119 int get_seconds(date dt);
1120 
1122 
1126 nothing get_seconds();
1127 
1129 
1143 int get_years(date dt);
1144 
1146 
1150 nothing get_years();
1151 
1153 
1167 date gmtime();
1168 
1170 
1185 date gmtime(softint secs, softint us = 0);
1186 
1188 
1202 date gmtime(date dt);
1203 
1205 
1226 date hours(softint hours);
1227 
1229 
1233 nothing hours();
1234 
1236 
1250 bool is_date_absolute(date dt);
1251 
1253 
1257 bool is_date_absolute();
1258 
1260 
1274 bool is_date_relative(date dt);
1275 
1277 
1281 bool is_date_relative();
1282 
1284 
1298 date localtime();
1299 
1301 
1316 date localtime(softint secs, softint us = 0);
1317 
1319 
1333 date localtime(date dt);
1334 
1336 
1357 date microseconds(softint us);
1358 
1360 
1381 date milliseconds(softint ms);
1382 
1384 
1388 nothing milliseconds();
1389 
1391 
1412 date minutes(softint minutes);
1413 
1415 
1419 nothing minutes();
1420 
1422 
1438 int mktime(date dt);
1439 
1441 
1445 nothing mktime();
1446 
1448 
1469 date months(softint months);
1470 
1472 
1476 nothing months();
1477 
1479 
1496 date now();
1497 
1499 
1516 date now_ms();
1517 
1519 
1536 date now_us();
1537 
1539 
1551 date now_utc();
1552 
1554 
1575 date seconds(softint seconds);
1576 
1578 
1582 nothing seconds();
1583 
1585 
1599 int timegm(date dt);
1600 
1602 
1606 nothing timegm();
1607 
1609 
1630 date years(softint years);
1631 
1633 
1637 nothing years();
1638 
1640 };
int get_hours(date dt)
Returns an integer corresponding to the literal hour value in the date (does not calculate a duration...
int get_microseconds(date dt)
Returns an integer corresponding to the literal microsecond value in the date (does not calculate a d...
int getDayNumber(date dt)
Returns an integer representing the ordinal day number in the year (corresponding to the ISO-8601 day...
date date(date dt)
Returns the date passed.
int get_years(date dt)
Returns an integer corresponding to the literal year value in the date (does not calculate a duration...
int getDayOfWeek(date dt)
Returns an integer representing the day of the week for the absolute date value passed (0=Sunday,...
int microsecond
(absolute and relative) The microsecond value of the date
Definition: ql_time.dox.h:18
hash< DateTimeInfo > date_info(date dt)
Returns a DateTimeInfo hash for the given date argument (can be either a relative or absolute date)
int dow
(absolute Only) The day of the week, where 0=Sunday, 1=Monday, ... 6=Saturday
Definition: ql_time.dox.h:10
int clock_getnanos()
Returns an integer representing the system time in nanoseconds (1/1000000000 second intervals) since ...
date/time information hash as returned by date_info() and <date>::info()
Definition: ql_time.dox.h:6
int get_months(date dt)
Returns an integer corresponding to the literal month value in the date (does not calculate a duratio...
int get_duration_microseconds(date dt)
Returns an integer value representing the the number of microseconds of duration in the value of the ...
float get_duration_seconds_f(date dt)
Returns a floating-point value representing the the number of seconds of duration in the value of the...
date now_us()
Returns the current date and time with a resolution to the microsecond.
int day
the ISO day value from 1 (Monday) to 7 (Sunday)
Definition: ql_time.dox.h:44
date getDateFromISOWeek(softint year, softint week, softint day=1)
Retuns an absolute date value for the ISO-8601 calendar week information passed (year,...
int mktime(date dt)
Returns the number of seconds of the date and time in local time passed since Jan 1,...
date get_midnight(date dt)
Returns midnight on the date passed (strips the time component on the new value)
int get_iso_day_of_week(date dt)
Returns an integer representing the ISO-8601 day of the week for the absolute date value passed (1=Mo...
int get_day_number(date dt)
Returns an integer representing the ordinal day number in the year (corresponding to the ISO-8601 day...
int doy
(absolute Only) The ordinal day number in the year
Definition: ql_time.dox.h:12
date now()
Returns the current date and time with a resolution to the second.
date gmtime()
Returns the current UTC (GMT) time with a resolution of a second.
Qore::TimeZone zone
(absolute Only) The time zone for the time
Definition: ql_time.dox.h:32
int week
the ISO week number
Definition: ql_time.dox.h:46
bool dst
(absolute Only) A flag if daylight savings time is in effect
Definition: ql_time.dox.h:14
int get_milliseconds(date dt)
Returns an integer corresponding to the literal millisecond value in the date (does not calculate a d...
int get_seconds(date dt)
Returns an integer corresponding to the literal second value in the date (does not calculate a durati...
date get_date_from_iso_week(softint year, softint week, softint day=1)
Retuns an absolute date value for the ISO-8601 calendar week information passed (year,...
int getISODayOfWeek(date dt)
Returns an integer representing the ISO-8601 day of the week for the absolute date value passed (1=Mo...
date now_ms()
Returns the current date and time with a resolution to the millisecond.
int minute
(absolute and relative) The minute value of the date
Definition: ql_time.dox.h:20
date milliseconds(softint ms)
Returns a relative date/time value in milliseconds based on the integer argument passed to be used in...
int utc_secs_east
(absolute Only) Offset from UTC in seconds east; if the time zone is west of UTC then the value will ...
Definition: ql_time.dox.h:28
hash< IsoWeekInfo > get_iso_week_hash(date dt)
Returns an IsoWeekInfo hash representing the ISO-8601 calendar week information for the absolute date...
date now_utc()
Returns the current UTC date and time with a resolution to the microsecond.
hash< IsoWeekInfo > getISOWeekHash(date dt)
Returns an IsoWeekInfo hash representing the ISO-8601 calendar week information for the absolute date...
int day
(absolute and relative) The day value of the date (day of the month for absolute dates)
Definition: ql_time.dox.h:8
int second
(absolute and relative) The second value of the date
Definition: ql_time.dox.h:26
date microseconds(softint us)
Returns a relative date/time value in microseconds based on the integer argument passed to be used in...
The TimeZone class provides access to time zone functionality.
Definition: QC_TimeZone.dox.h:10
date months(softint months)
Returns a relative date/time value in months based on the integer argument passed to be used in date ...
string getISOWeekString(date dt)
Returns a string representing the ISO-8601 calendar week information for the absolute date passed (ex...
bool is_date_absolute(date dt)
Returns True if the argument is an absolute date/time value, False if not.
int clock_getmillis()
Returns an integer representing the system time in milliseconds (1/1000 second intervals since Jan 1,...
bool is_date_relative(date dt)
Returns True if the argument is an relative date/time value, False if not.
string get_iso_week_string(date dt)
Returns a string representing the ISO-8601 calendar week information for the absolute date passed (ex...
int get_epoch_seconds(date dt)
Returns the number of seconds of the date and time in local time passed since Jan 1,...
int hour
(absolute and relative) The hour value of the date
Definition: ql_time.dox.h:16
ISO week information as returned by get_iso_week_hash() and <date>::isoWeekHash()
Definition: ql_time.dox.h:42
int get_minutes(date dt)
Returns an integer corresponding to the literal minute value in the date (does not calculate a durati...
date date_ms(softint ms)
Converts an integer argument representing the offset in milliseconds from January 1,...
int year
(absolute and relative) The year value of the date
Definition: ql_time.dox.h:30
date years(softint years)
Returns a relative date/time value in years based on the integer argument passed to be used in date a...
bool relative
(absolute and relative) True if the date is a relative date, False if it is absolute
Definition: ql_time.dox.h:24
string zone_name
(absolute Only) The name of the time zone for the given time (ex: "CEST" for Central European Summer ...
Definition: ql_time.dox.h:34
date hours(softint hours)
Returns a relative date/time value in hours based on the integer argument passed to be used in date a...
int get_day_of_week(date dt)
Returns an integer representing the day of the week for the absolute date value passed (0=Sunday,...
int get_days(date dt)
Returns an integer corresponding to the literal day value in the date (does not calculate a duration)
string format_date(string format, date dt)
Returns a formatted string for a date argument passed.
int month
(absolute and relative) The month value of the date
Definition: ql_time.dox.h:22
date days(softint days)
Returns a relative date/time value in days based on the integer argument passed to be used in date ar...
main Qore-language namespace
Definition: Pseudo_QC_All.dox.h:2
date localtime()
Returns the current date and time with a resolution to the second.
int year
the ISO year value (not always equal to the actual calendar year)
Definition: ql_time.dox.h:48
int get_duration_seconds(date dt)
Returns an integer value representing the the number of seconds of duration in the value of the date ...
date seconds(softint seconds)
Returns a relative date/time value in seconds based on the integer argument passed to be used in date...
int get_duration_milliseconds(date dt)
Returns an integer value representing the the number of milliseconds of duration in the value of the ...
date date_us(softint us)
Converts an integer argument representing the offset in microseconds from January 1,...
date minutes(softint minutes)
Returns a relative date/time value in minutes based on the integer argument passed to be used in date...
int clock_getmicros()
Returns an integer representing the system time in microseconds (1/1000000 second intervals) since Ja...
int timegm(date dt)
Returns the number of seconds since January 1, 1970 00:00:00 in the local time zone for the given dat...