Vuo
1.2.6
|
A date and time.
Typedefs | |
typedef double | VuoTime |
A date and time. | |
Functions | |
VuoTime | VuoTime_makeFromJson (struct json_object *js) |
Decodes the JSON object js to create a new value. | |
struct json_object * | VuoTime_getJson (const VuoTime value) |
Encodes value as a JSON object. | |
char * | VuoTime_getSummary (const VuoTime value) |
Returns a compact string representation of value . | |
bool | VuoTime_areEqual (const VuoTime valueA, const VuoTime valueB) |
Returns true if the two values are equal. | |
bool | VuoTime_isLessThan (const VuoTime valueA, const VuoTime valueB) |
Returns true if valueA is less than valueB . | |
bool | VuoTime_areEqualWithinTolerance (VuoList_VuoTime times, VuoReal tolerance, VuoTimeUnit toleranceUnit) |
Checks if the dates and times are all within a certain distance of each other (within 1 hour, within 8 hours, within 1 year, …). | |
bool | VuoTime_areTimesOfDayEqualWithinTolerance (VuoList_VuoTime times, VuoReal tolerance, VuoTimeUnit toleranceUnit) |
Checks if the times are all within a certain distance of each other (within 1 minute, within 8 hours, …). | |
bool | VuoTime_isTimeOfDayLessThan (const VuoTime valueA, const VuoTime valueB, const VuoTime startOfDay) |
Checks if time A is before B, ignoring the date component. | |
VuoTime | VuoTime_getCurrent (void) |
Returns the current calendar date and time (seconds since 2001.01.01 @ 00:00:00 UTC). | |
VuoTime | VuoTime_make (VuoInteger year, VuoInteger month, VuoInteger dayOfMonth, VuoInteger hour, VuoInteger minute, VuoReal second) |
Creates a date-time from component values. | |
VuoTime | VuoTime_makeFromRFC822 (const char *rfc822) |
Creates a date-time from an RFC 822 date-time string. | |
VuoTime | VuoTime_makeFromUnknownFormat (const char *str) |
Creates a date-time from a string that may have any format of the VuoTimeFormat options, or of VuoTimeFormat_DateTimeShort12 , VuoTimeFormat_DateTimeShort24 , or VuoTimeFormat_DateShort with 2-digit years instead of 4-digit. | |
bool | VuoTime_getComponents (VuoTime time, VuoInteger *year, VuoInteger *dayOfYear, VuoInteger *month, VuoInteger *dayOfMonth, VuoInteger *week, VuoWeekday *dayOfWeek, VuoInteger *hour, VuoInteger *minute, VuoReal *second) |
For a given time (in UTC), converts it to the current local timezone, and splits it into its human-readable parts. | |
VuoTime | VuoTime_round (const VuoTime value, const VuoTimeUnit unit, const int roundingMethod) |
Rounds to a nearby minute, hour, etc. | |
VuoText | VuoTime_format (const VuoTime time, const VuoTimeFormat format) |
Outputs text containing a date and/or time, in the system's current locale. | |
VuoText | VuoTime_formatWithLocale (const VuoTime time, const VuoTimeFormat format, const VuoText localeIdentifier) |
Outputs text containing a date and/or time. | |
VuoTime | VuoTime_makeFromString (const char *str) |
Automatically generated function. | |
char * | VuoTime_getString (const VuoTime value) |
Automatically generated function. | |
void | VuoTime_retain (VuoTime value) |
Automatically generated function. | |
void | VuoTime_release (VuoTime value) |
Automatically generated function. | |
typedef double VuoTime |
A date and time.
The number of seconds since 2001.01.01 @ 00:00:00 UTC, including fractional seconds.
Regarding precision: A 64-bit double can represent 15 significant figures in decimal. In 2015 (about 441,000,000 seconds since 2001.01.01), that leaves 6 significant figures to represent fractional seconds, meaning VuoTime can represent individual microseconds.
This type is similar in definition to Cocoa's NSDate
and Core Foundation's CFDateRef
— it's timezone-independent / always in UTC.
Returns true if the two values are equal.
bool VuoTime_areEqualWithinTolerance | ( | VuoList_VuoTime | times, |
VuoReal | tolerance, | ||
VuoTimeUnit | toleranceUnit | ||
) |
Checks if the dates and times are all within a certain distance of each other (within 1 hour, within 8 hours, within 1 year, …).
bool VuoTime_areTimesOfDayEqualWithinTolerance | ( | VuoList_VuoTime | times, |
VuoReal | tolerance, | ||
VuoTimeUnit | toleranceUnit | ||
) |
Checks if the times are all within a certain distance of each other (within 1 minute, within 8 hours, …).
Ignores the date components.
Times are considered equal within tolerance if they span midnight. For example, 23:00 and 01:00 are equal within a tolerance of 3 hours.
VuoText VuoTime_format | ( | const VuoTime | time, |
const VuoTimeFormat | format | ||
) |
Outputs text containing a date and/or time, in the system's current locale.
Uses the current local timezone (except VuoTimeFormat_DateTimeSortable, which is always UTC).
Fractional seconds are rounded down.
VuoText VuoTime_formatWithLocale | ( | const VuoTime | time, |
const VuoTimeFormat | format, | ||
const VuoText | localeIdentifier | ||
) |
Outputs text containing a date and/or time.
Uses the current local timezone (except VuoTimeFormat_DateTimeSortable, which is always UTC).
Fractional seconds are rounded down.
bool VuoTime_getComponents | ( | VuoTime | time, |
VuoInteger * | year, | ||
VuoInteger * | dayOfYear, | ||
VuoInteger * | month, | ||
VuoInteger * | dayOfMonth, | ||
VuoInteger * | week, | ||
VuoWeekday * | dayOfWeek, | ||
VuoInteger * | hour, | ||
VuoInteger * | minute, | ||
VuoReal * | second | ||
) |
For a given time
(in UTC), converts it to the current local timezone, and splits it into its human-readable parts.
It's OK to pass NULL for any of the output pointers.
time | The time to dissect. |
year | Millennium + Century + Decade + Year (e.g., 1970) |
dayOfYear | 1 to 365 or 366 |
month | 1 to 12 |
dayOfMonth | 1 to 28, 30, or 31 |
week | 1 to 52 or 53 (ISO 8601:1988 week number) |
dayOfWeek | 0=Sunday, 1=Monday, …, 6=Saturday |
hour | 0 to 23 |
minute | 0 to 59 |
second | Includes fractional seconds. |
VuoTime VuoTime_getCurrent | ( | void | ) |
Returns the current calendar date and time (seconds since 2001.01.01 @ 00:00:00 UTC).
This function always uses UTC; it does not concern itself with time zones or Daylight Saving Time.
|
read |
Encodes value
as a JSON object.
char* VuoTime_getString | ( | const VuoTime | value | ) |
Automatically generated function.
char* VuoTime_getSummary | ( | const VuoTime | value | ) |
Returns a compact string representation of value
.
Returns true if valueA
is less than valueB
.
bool VuoTime_isTimeOfDayLessThan | ( | const VuoTime | valueA, |
const VuoTime | valueB, | ||
const VuoTime | startOfDay | ||
) |
Checks if time A is before B, ignoring the date component.
startOfDay
specifies the breakpoint. For example, if startOfDay
is 04:00, time 23:00 is considered less than 03:00.
VuoTime VuoTime_make | ( | VuoInteger | year, |
VuoInteger | month, | ||
VuoInteger | dayOfMonth, | ||
VuoInteger | hour, | ||
VuoInteger | minute, | ||
VuoReal | second | ||
) |
Creates a date-time from component values.
See VuoTime_getComponents for parameter definitions.
VuoTime VuoTime_makeFromJson | ( | json_object * | js | ) |
Decodes the JSON object js
to create a new value.
VuoTime VuoTime_makeFromRFC822 | ( | const char * | rfc822 | ) |
Creates a date-time from an RFC 822 date-time string.
VuoTime VuoTime_makeFromString | ( | const char * | str | ) |
Automatically generated function.
VuoTime VuoTime_makeFromUnknownFormat | ( | const char * | str | ) |
Creates a date-time from a string that may have any format of the VuoTimeFormat
options, or of VuoTimeFormat_DateTimeShort12
, VuoTimeFormat_DateTimeShort24
, or VuoTimeFormat_DateShort
with 2-digit years instead of 4-digit.
void VuoTime_release | ( | VuoTime | value | ) |
Automatically generated function.
void VuoTime_retain | ( | VuoTime | value | ) |
Automatically generated function.
VuoTime VuoTime_round | ( | const VuoTime | value, |
const VuoTimeUnit | unit, | ||
const int | roundingMethod | ||
) |
Rounds to a nearby minute, hour, etc.