Holds an absolute date and time. More...
#include <juce_Time.h>
Public Member Functions | |
Time ()=default | |
Creates a Time object. More... | |
Time (const Time &)=default | |
Time (int year, int month, int day, int hours, int minutes, int seconds=0, int milliseconds=0, bool useLocalTime=true) noexcept | |
Creates a time from a set of date components. More... | |
Time (int64 millisecondsSinceEpoch) noexcept | |
Creates a time based on a number of milliseconds. More... | |
~Time ()=default | |
String | formatted (const String &format) const |
Converts this date/time to a string with a user-defined format. More... | |
int | getDayOfMonth () const noexcept |
Returns the day of the month (in this machine's local timezone). More... | |
int | getDayOfWeek () const noexcept |
Returns the number of the day of the week (in this machine's local timezone). More... | |
int | getDayOfYear () const noexcept |
Returns the number of the day of the year (in this machine's local timezone). More... | |
int | getHours () const noexcept |
Returns the number of hours since midnight (in this machine's local timezone). More... | |
int | getHoursInAmPmFormat () const noexcept |
Returns the hours in 12-hour clock format (in this machine's local timezone). More... | |
int | getMilliseconds () const noexcept |
Returns the number of milliseconds, 0 to 999. More... | |
int | getMinutes () const noexcept |
Returns the number of minutes, 0 to 59 (in this machine's local timezone). More... | |
int | getMonth () const noexcept |
Returns the number of the month (in this machine's local timezone). More... | |
String | getMonthName (bool threeLetterVersion) const |
Returns the name of the month (in this machine's local timezone). More... | |
int | getSeconds () const noexcept |
Returns the number of seconds, 0 to 59. More... | |
String | getTimeZone () const |
Returns a 3-character string to indicate the local timezone. More... | |
int | getUTCOffsetSeconds () const noexcept |
Returns the local timezone offset from UTC in seconds. More... | |
String | getUTCOffsetString (bool includeDividerCharacters) const |
Returns a string to indicate the offset of the local timezone from UTC. More... | |
String | getWeekdayName (bool threeLetterVersion) const |
Returns the name of the weekday (in this machine's local timezone). More... | |
int | getYear () const noexcept |
Returns the year (in this machine's local timezone). More... | |
bool | isAfternoon () const noexcept |
Returns true if the time is in the afternoon (in this machine's local timezone). More... | |
bool | isDaylightSavingTime () const noexcept |
Returns true if the local timezone uses a daylight saving correction. More... | |
Time & | operator+= (RelativeTime delta) noexcept |
Adds a RelativeTime to this time. More... | |
Time & | operator-= (RelativeTime delta) noexcept |
Subtracts a RelativeTime from this time. More... | |
Time & | operator= (const Time &)=default |
bool | setSystemTimeToThisTime () const |
Tries to set the computer's clock. More... | |
String | toISO8601 (bool includeDividerCharacters) const |
Returns a fully described string of this date and time in ISO-8601 format (using the local timezone). More... | |
int64 | toMilliseconds () const noexcept |
Returns the time as a number of milliseconds. More... | |
String | toString (bool includeDate, bool includeTime, bool includeSeconds=true, bool use24HourClock=false) const |
Returns a string version of this date and time, using this machine's local timezone. More... | |
Static Public Member Functions | |
static int64 | currentTimeMillis () noexcept |
Returns the current system time. More... | |
static Time | fromISO8601 (StringRef iso8601) |
Parses an ISO-8601 string and returns it as a Time. More... | |
static uint32 | getApproximateMillisecondCounter () noexcept |
Less-accurate but faster version of getMillisecondCounter(). More... | |
static Time | getCompilationDate () |
Returns a Time based on the value of the DATE macro when this module was compiled. More... | |
static Time | getCurrentTime () noexcept |
Returns a Time object that is set to the current system time. More... | |
static int64 | getHighResolutionTicks () noexcept |
Returns the current high-resolution counter's tick-count. More... | |
static int64 | getHighResolutionTicksPerSecond () noexcept |
Returns the resolution of the high-resolution counter in ticks per second. More... | |
static uint32 | getMillisecondCounter () noexcept |
Returns the number of millisecs since a fixed event (usually system startup). More... | |
static double | getMillisecondCounterHiRes () noexcept |
Returns the number of millisecs since a fixed event (usually system startup). More... | |
static String | getMonthName (int monthNumber, bool threeLetterVersion) |
Returns the name of one of the months. More... | |
static String | getWeekdayName (int dayNumber, bool threeLetterVersion) |
Returns the name of a day of the week. More... | |
static double | highResolutionTicksToSeconds (int64 ticks) noexcept |
Converts a number of high-resolution ticks into seconds. More... | |
static int64 | secondsToHighResolutionTicks (double seconds) noexcept |
Converts a number seconds into high-resolution ticks. More... | |
static void | waitForMillisecondCounter (uint32 targetTime) noexcept |
Waits until the getMillisecondCounter() reaches a given value. More... | |
Private Attributes | |
int64 | millisSinceEpoch = 0 |
Holds an absolute date and time.
Internally, the time is stored at millisecond precision.
@tags{Core}
|
default |
Creates a Time object.
This default constructor creates a time of midnight Jan 1st 1970 UTC, (which is represented internally as 0ms). To create a time object representing the current time, use getCurrentTime().
|
explicitnoexcept |
Creates a time based on a number of milliseconds.
To create a time object set to the current time, use getCurrentTime().
millisecondsSinceEpoch | the number of milliseconds since the unix 'epoch' (midnight Jan 1st 1970 UTC). |
|
noexcept |
Creates a time from a set of date components.
year | the year, in 4-digit format, e.g. 2004 |
month | the month, in the range 0 to 11 |
day | the day of the month, in the range 1 to 31 |
hours | hours in 24-hour clock format, 0 to 23 |
minutes | minutes 0 to 59 |
seconds | seconds 0 to 59 |
milliseconds | milliseconds 0 to 999 |
useLocalTime | if true, assume input is in this machine's local timezone if false, assume input is in UTC. |
|
default |
|
default |
|
staticnoexcept |
Returns the current system time.
Returns the number of milliseconds since midnight Jan 1st 1970 UTC.
Should be accurate to within a few millisecs, depending on platform, hardware, etc.
Converts this date/time to a string with a user-defined format.
This uses the C strftime() function to format this time as a string. To save you looking it up, these are the escape codes that strftime uses (other codes might work on some platforms and not others, but these are the common ones):
Parses an ISO-8601 string and returns it as a Time.
|
staticnoexcept |
Less-accurate but faster version of getMillisecondCounter().
This will return the last value that getMillisecondCounter() returned, so doesn't need to make a system call, but is less accurate - it shouldn't be more than 100ms away from the correct time, though, so is still accurate enough for a lot of purposes.
|
static |
Returns a Time based on the value of the DATE macro when this module was compiled.
|
staticnoexcept |
Returns a Time object that is set to the current system time.
This may not be monotonic, as the system time can change at any moment. You should therefore not use this method for measuring time intervals.
Referenced by juce::CarbonViewWrapperComponent::createWindow(), juce::AnimatedPosition< Behaviour >::moveTo(), juce::AnimatedPosition< Behaviour >::timerCallback(), and juce::CarbonViewWrapperComponent::timerCallback().
|
noexcept |
Returns the day of the month (in this machine's local timezone).
The value returned is in the range 1 to 31.
|
noexcept |
Returns the number of the day of the week (in this machine's local timezone).
The value returned is in the range 0 to 6 (0 = sunday, 1 = monday, etc).
|
noexcept |
Returns the number of the day of the year (in this machine's local timezone).
The value returned is in the range 0 to 365.
|
staticnoexcept |
Returns the current high-resolution counter's tick-count.
This is a similar idea to getMillisecondCounter(), but with a higher resolution.
Referenced by juce::HiddenMessageWindow::HiddenMessageWindow(), and juce::ScopedTimeMeasurement::~ScopedTimeMeasurement().
|
staticnoexcept |
Returns the resolution of the high-resolution counter in ticks per second.
Referenced by juce::ScopedTimeMeasurement::~ScopedTimeMeasurement().
|
noexcept |
Returns the number of hours since midnight (in this machine's local timezone).
This is in 24-hour clock format, in the range 0 to 23.
|
noexcept |
Returns the hours in 12-hour clock format (in this machine's local timezone).
This will return a value 1 to 12 - use isAfternoon() to find out whether this is in the afternoon or morning.
|
staticnoexcept |
Returns the number of millisecs since a fixed event (usually system startup).
This returns a monotonically increasing value which is unaffected by changes to the system clock. It should be accurate to within a few millisecs, depending on platform, hardware, etc.
Being a 32-bit return value, it will of course wrap back to 0 after 2^32 seconds of uptime, so be careful to take that into account. If you need a 64-bit time, you can use currentTimeMillis() instead.
|
staticnoexcept |
Returns the number of millisecs since a fixed event (usually system startup).
This has the same function as getMillisecondCounter(), but returns a more accurate value, using a higher-resolution timer if one is available.
Referenced by juce::OpenGLContext::NativeContext::swapBuffers().
|
noexcept |
Returns the number of milliseconds, 0 to 999.
Unlike toMilliseconds(), this just returns the position within the current second rather than the total number since the epoch.
|
noexcept |
Returns the number of minutes, 0 to 59 (in this machine's local timezone).
|
noexcept |
Returns the number of the month (in this machine's local timezone).
The value returned is in the range 0 to 11.
Returns the name of the month (in this machine's local timezone).
threeLetterVersion | if true, it'll be a 3-letter abbreviation, e.g. "Jan"; if false it'll return the long form, e.g. "January" |
Returns the name of one of the months.
monthNumber | the month, 0 to 11 |
threeLetterVersion | if true, it'll be a 3-letter abbreviation, e.g. "Jan"; if false it'll return the long form, e.g. "January" |
|
noexcept |
Returns the number of seconds, 0 to 59.
String juce::Time::getTimeZone | ( | ) | const |
Returns a 3-character string to indicate the local timezone.
|
noexcept |
Returns the local timezone offset from UTC in seconds.
Returns a string to indicate the offset of the local timezone from UTC.
includeDividerCharacters | whether to include or omit the ":" divider in the string |
Returns the name of the weekday (in this machine's local timezone).
threeLetterVersion | if true, it'll return a 3-letter abbreviation, e.g. "Tue"; if false, it'll return the full version, e.g. "Tuesday". |
Returns the name of a day of the week.
dayNumber | the day, 0 to 6 (0 = sunday, 1 = monday, etc) |
threeLetterVersion | if true, it'll return a 3-letter abbreviation, e.g. "Tue"; if false, it'll return the full version, e.g. "Tuesday". |
|
noexcept |
Returns the year (in this machine's local timezone).
A 4-digit format is used, e.g. 2004.
|
staticnoexcept |
Converts a number of high-resolution ticks into seconds.
|
noexcept |
Returns true if the time is in the afternoon (in this machine's local timezone).
|
noexcept |
Returns true if the local timezone uses a daylight saving correction.
|
noexcept |
Adds a RelativeTime to this time.
|
noexcept |
Subtracts a RelativeTime from this time.
|
staticnoexcept |
Converts a number seconds into high-resolution ticks.
bool juce::Time::setSystemTimeToThisTime | ( | ) | const |
Tries to set the computer's clock.
Returns a fully described string of this date and time in ISO-8601 format (using the local timezone).
includeDividerCharacters | whether to include or omit the "-" and ":" dividers in the string |
|
inlinenoexcept |
Returns the time as a number of milliseconds.
String juce::Time::toString | ( | bool | includeDate, |
bool | includeTime, | ||
bool | includeSeconds = true , |
||
bool | use24HourClock = false |
||
) | const |
Returns a string version of this date and time, using this machine's local timezone.
For a more powerful way of formatting the date and time, see the formatted() method.
includeDate | whether to include the date in the string |
includeTime | whether to include the time in the string |
includeSeconds | if the time is being included, this provides an option not to include the seconds in it |
use24HourClock | if the time is being included, sets whether to use am/pm or 24 hour notation. |
|
staticnoexcept |
Waits until the getMillisecondCounter() reaches a given value.
This will make the thread sleep as efficiently as it can while it's waiting.
|
private |