#include <juce_Time.h>
Public Member Functions | |
Time ()=default | |
Time (int64 millisecondsSinceEpoch) noexcept | |
Time (int year, int month, int day, int hours, int minutes, int seconds=0, int milliseconds=0, bool useLocalTime=true) noexcept | |
Time (const Time &)=default | |
Time & | operator= (const Time &)=default |
int64 | toMilliseconds () const noexcept |
int | getYear () const noexcept |
int | getMonth () const noexcept |
String | getMonthName (bool threeLetterVersion) const |
int | getDayOfMonth () const noexcept |
int | getDayOfWeek () const noexcept |
int | getDayOfYear () const noexcept |
String | getWeekdayName (bool threeLetterVersion) const |
int | getHours () const noexcept |
bool | isAfternoon () const noexcept |
int | getHoursInAmPmFormat () const noexcept |
int | getMinutes () const noexcept |
int | getSeconds () const noexcept |
int | getMilliseconds () const noexcept |
bool | isDaylightSavingTime () const noexcept |
String | getTimeZone () const |
int | getUTCOffsetSeconds () const noexcept |
String | getUTCOffsetString (bool includeDividerCharacters) const |
String | toString (bool includeDate, bool includeTime, bool includeSeconds=true, bool use24HourClock=false) const |
String | formatted (const String &format) const |
String | toISO8601 (bool includeDividerCharacters) const |
Time & | operator+= (RelativeTime delta) noexcept |
Time & | operator-= (RelativeTime delta) noexcept |
bool | setSystemTimeToThisTime () const |
Static Public Member Functions | |
static Time JUCE_CALLTYPE | getCurrentTime () noexcept |
static Time | fromISO8601 (StringRef iso8601) |
static String | getWeekdayName (int dayNumber, bool threeLetterVersion) |
static String | getMonthName (int monthNumber, bool threeLetterVersion) |
static int64 | currentTimeMillis () noexcept |
static uint32 | getMillisecondCounter () noexcept |
static double | getMillisecondCounterHiRes () noexcept |
static void | waitForMillisecondCounter (uint32 targetTime) noexcept |
static uint32 | getApproximateMillisecondCounter () noexcept |
static int64 | getHighResolutionTicks () noexcept |
static int64 | getHighResolutionTicksPerSecond () noexcept |
static double | highResolutionTicksToSeconds (int64 ticks) noexcept |
static int64 | secondsToHighResolutionTicks (double seconds) noexcept |
static Time | getCompilationDate () |
Holds an absolute date and time.
Internally, the time is stored at millisecond precision.
Definition at line 36 of file juce_Time.h.
|
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().
Referenced by fromISO8601(), getCompilationDate(), getCurrentTime(), getHighResolutionTicksPerSecond(), getMillisecondCounter(), operator+=(), operator-=(), and Time().
|
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). |
Definition at line 199 of file juce_Time.cpp.
|
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. |
Definition at line 201 of file juce_Time.cpp.
|
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.
Definition at line 220 of file juce_Time.cpp.
Referenced by getCurrentTime(), juce::Random::setSeedRandomly(), and setSystemTimeToThisTime().
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):
Definition at line 341 of file juce_Time.cpp.
Referenced by juce::WavAudioFormat::createBWAVMetadata().
Parses an ISO-8601 string and returns it as a Time.
Definition at line 457 of file juce_Time.cpp.
|
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.
Definition at line 261 of file juce_Time.cpp.
Referenced by juce::StringPool::garbageCollect(), and getMillisecondCounterHiRes().
|
static |
Returns a Time based on the value of the DATE macro when this module was compiled
Definition at line 593 of file juce_Time.cpp.
Referenced by getHighResolutionTicksPerSecond().
|
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.
Definition at line 233 of file juce_Time.cpp.
Referenced by juce::TimeSliceThread::addTimeSliceClient(), juce::FileLogger::createDateStampedLogger(), juce::FileLogger::FileLogger(), juce::UndoManager::getTimeOfRedoTransaction(), juce::TimeSliceThread::moveToFrontOfQueue(), juce::PerformanceCounter::PerformanceCounter(), juce::TimeSliceThread::run(), and Time().
|
noexcept |
Returns the day of the month (in this machine's local timezone). The value returned is in the range 1 to 31.
Definition at line 351 of file juce_Time.cpp.
Referenced by toISO8601(), and toString().
|
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).
Definition at line 352 of file juce_Time.cpp.
Referenced by getWeekdayName().
|
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.
Definition at line 350 of file juce_Time.cpp.
|
staticnoexcept |
Returns the current high-resolution counter's tick-count.
This is a similar idea to getMillisecondCounter(), but with a higher resolution.
Referenced by getHighResolutionTicks(), juce::Random::setSeedRandomly(), juce::PerformanceCounter::start(), and juce::PerformanceCounter::stop().
|
staticnoexcept |
Returns the resolution of the high-resolution counter in ticks per second.
Referenced by getHighResolutionTicksPerSecond(), highResolutionTicksToSeconds(), secondsToHighResolutionTicks(), and juce::Random::setSeedRandomly().
|
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.
Definition at line 353 of file juce_Time.cpp.
Referenced by getHoursInAmPmFormat(), isAfternoon(), toISO8601(), and toString().
|
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.
Definition at line 358 of file juce_Time.cpp.
Referenced by toString().
|
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.
Definition at line 241 of file juce_Time.cpp.
Referenced by getApproximateMillisecondCounter(), getMillisecondCounter(), juce::MidiKeyboardState::noteOff(), juce::MidiKeyboardState::noteOn(), juce::BufferingAudioReader::readSamples(), juce::ThreadPool::removeAllJobs(), juce::Random::setSeedRandomly(), setSystemTimeToThisTime(), juce::ThreadPool::waitForJobToFinish(), waitForMillisecondCounter(), juce::BufferingAudioSource::waitForNextAudioBlockReady(), juce::ChildProcess::waitForProcessToFinish(), and juce::Thread::waitForThreadToExit().
|
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 getMillisecondCounterHiRes(), juce::MidiMessageCollector::handleNoteOff(), juce::MidiMessageCollector::handleNoteOn(), juce::MidiMessageCollector::removeNextBlockOfMessages(), and juce::MidiMessageCollector::reset().
|
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.
Definition at line 356 of file juce_Time.cpp.
Referenced by toISO8601().
|
noexcept |
Returns the number of minutes, 0 to 59 (in this machine's local timezone).
Definition at line 354 of file juce_Time.cpp.
Referenced by toISO8601(), and toString().
|
noexcept |
Returns the number of the month (in this machine's local timezone). The value returned is in the range 0 to 11.
Definition at line 349 of file juce_Time.cpp.
Referenced by getMonthName(), and toISO8601().
String juce::Time::getMonthName | ( | bool | threeLetterVersion | ) | const |
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" |
Definition at line 532 of file juce_Time.cpp.
Referenced by getMonthName(), setSystemTimeToThisTime(), and toString().
|
static |
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" |
Definition at line 545 of file juce_Time.cpp.
|
noexcept |
Returns the number of seconds, 0 to 59.
Definition at line 355 of file juce_Time.cpp.
Referenced by toISO8601(), and toString().
String juce::Time::getTimeZone | ( | ) | const |
Returns a 3-character string to indicate the local timezone.
Definition at line 378 of file juce_Time.cpp.
|
noexcept |
Returns the local timezone offset from UTC in seconds.
Definition at line 413 of file juce_Time.cpp.
Referenced by getUTCOffsetString().
String juce::Time::getUTCOffsetString | ( | bool | includeDividerCharacters | ) | const |
Returns a string to indicate the offset of the local timezone from UTC.
includeDividerCharacters | whether to include or omit the ":" divider in the string |
Definition at line 418 of file juce_Time.cpp.
Referenced by toISO8601().
String juce::Time::getWeekdayName | ( | bool | threeLetterVersion | ) | const |
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". |
Definition at line 537 of file juce_Time.cpp.
Referenced by getWeekdayName(), and setSystemTimeToThisTime().
|
static |
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". |
Definition at line 553 of file juce_Time.cpp.
|
noexcept |
Returns the year (in this machine's local timezone). A 4-digit format is used, e.g. 2004.
Definition at line 348 of file juce_Time.cpp.
Referenced by toISO8601(), and toString().
|
staticnoexcept |
Converts a number of high-resolution ticks into seconds.
Definition at line 293 of file juce_Time.cpp.
Referenced by getHighResolutionTicksPerSecond(), and juce::PerformanceCounter::stop().
|
noexcept |
Returns true if the time is in the afternoon (in this machine's local timezone).
Definition at line 368 of file juce_Time.cpp.
Referenced by toString().
|
noexcept |
Returns true if the local timezone uses a daylight saving correction.
Definition at line 373 of file juce_Time.cpp.
Referenced by getTimeZone().
|
noexcept |
Adds a RelativeTime to this time.
Definition at line 565 of file juce_Time.cpp.
|
noexcept |
Subtracts a RelativeTime from this time.
Definition at line 566 of file juce_Time.cpp.
|
staticnoexcept |
Converts a number seconds into high-resolution ticks.
Definition at line 298 of file juce_Time.cpp.
Referenced by getHighResolutionTicksPerSecond().
bool juce::Time::setSystemTimeToThisTime | ( | ) | const |
Tries to set the computer's clock.
Referenced by setSystemTimeToThisTime().
String juce::Time::toISO8601 | ( | bool | includeDividerCharacters | ) | const |
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 |
Definition at line 423 of file juce_Time.cpp.
|
inlinenoexcept |
Returns the time as a number of milliseconds.
Definition at line 98 of file juce_Time.h.
Referenced by juce::File::setCreationTime(), juce::File::setLastAccessTime(), juce::File::setLastModificationTime(), and toMilliseconds().
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. |
Definition at line 304 of file juce_Time.cpp.
|
staticnoexcept |
Waits until the getMillisecondCounter() reaches a given value.
This will make the thread sleep as efficiently as it can while it's waiting.
Definition at line 267 of file juce_Time.cpp.
Referenced by getMillisecondCounterHiRes().