JUCE
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Member Functions | Static Public Member Functions | List of all members
Time Class Reference

Holds an absolute date and time. More...

Public Member Functions

 Time () noexcept
 Creates a Time object.
 
 Time (int64 millisecondsSinceEpoch) noexcept
 Creates a time based on a number of milliseconds.
 
 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.
 
 Time (const Time &other) noexcept
 Creates a copy of another Time object.
 
 ~Time () noexcept
 Destructor.
 
Timeoperator= (const Time &other) noexcept
 Copies this time from another one.
 
int64 toMilliseconds () const noexcept
 Returns the time as a number of milliseconds.
 
int getYear () const noexcept
 Returns the year.
 
int getMonth () const noexcept
 Returns the number of the month.
 
String getMonthName (bool threeLetterVersion) const
 Returns the name of the month.
 
int getDayOfMonth () const noexcept
 Returns the day of the month.
 
int getDayOfWeek () const noexcept
 Returns the number of the day of the week.
 
int getDayOfYear () const noexcept
 Returns the number of the day of the year.
 
String getWeekdayName (bool threeLetterVersion) const
 Returns the name of the weekday.
 
int getHours () const noexcept
 Returns the number of hours since midnight.
 
bool isAfternoon () const noexcept
 Returns true if the time is in the afternoon.
 
int getHoursInAmPmFormat () const noexcept
 Returns the hours in 12-hour clock format.
 
int getMinutes () const noexcept
 Returns the number of minutes, 0 to 59.
 
int getSeconds () const noexcept
 Returns the number of seconds, 0 to 59.
 
int getMilliseconds () const noexcept
 Returns the number of milliseconds, 0 to 999.
 
bool isDaylightSavingTime () const noexcept
 Returns true if the local timezone uses a daylight saving correction.
 
String getTimeZone () const noexcept
 Returns a 3-character string to indicate the local timezone.
 
String toString (bool includeDate, bool includeTime, bool includeSeconds=true, bool use24HourClock=false) const noexcept
 Quick way of getting a string version of a date and time.
 
String formatted (const String &format) const
 Converts this date/time to a string with a user-defined format.
 
Timeoperator+= (RelativeTime delta) noexcept
 Adds a RelativeTime to this time.
 
Timeoperator-= (RelativeTime delta) noexcept
 Subtracts a RelativeTime from this time.
 
bool setSystemTimeToThisTime () const
 Tries to set the computer's clock.
 

Static Public Member Functions

static Time JUCE_CALLTYPE getCurrentTime () noexcept
 Returns a Time object that is set to the current system time.
 
static String getWeekdayName (int dayNumber, bool threeLetterVersion)
 Returns the name of a day of the week.
 
static String getMonthName (int monthNumber, bool threeLetterVersion)
 Returns the name of one of the months.
 
static int64 currentTimeMillis () noexcept
 Returns the current system time.
 
static uint32 getMillisecondCounter () noexcept
 Returns the number of millisecs since a fixed event (usually system startup).
 
static double getMillisecondCounterHiRes () noexcept
 Returns the number of millisecs since a fixed event (usually system startup).
 
static void waitForMillisecondCounter (uint32 targetTime) noexcept
 Waits until the getMillisecondCounter() reaches a given value.
 
static uint32 getApproximateMillisecondCounter () noexcept
 Less-accurate but faster version of getMillisecondCounter().
 
static int64 getHighResolutionTicks () noexcept
 Returns the current high-resolution counter's tick-count.
 
static int64 getHighResolutionTicksPerSecond () noexcept
 Returns the resolution of the high-resolution counter in ticks per second.
 
static double highResolutionTicksToSeconds (int64 ticks) noexcept
 Converts a number of high-resolution ticks into seconds.
 
static int64 secondsToHighResolutionTicks (double seconds) noexcept
 Converts a number seconds into high-resolution ticks.
 
static Time getCompilationDate ()
 Returns a Time based on the value of the __DATE__ macro when this module was compiled.
 

Detailed Description

Holds an absolute date and time.

Internally, the time is stored at millisecond precision.

See Also
RelativeTime

Constructor & Destructor Documentation

Time::Time ( )
noexcept

Creates a Time object.

This default constructor creates a time of 1st January 1970, (which is represented internally as 0ms).

To create a time object representing the current time, use getCurrentTime().

See Also
getCurrentTime
Time::Time ( int64  millisecondsSinceEpoch)
explicitnoexcept

Creates a time based on a number of milliseconds.

The internal millisecond count is set to 0 (1st January 1970). To create a time object set to the current time, use getCurrentTime().

Parameters
millisecondsSinceEpochthe number of milliseconds since the unix 'epoch' (midnight Jan 1st 1970).
See Also
getCurrentTime, currentTimeMillis
Time::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.

The timezone is assumed to be whatever the system is using as its locale.

Parameters
yearthe year, in 4-digit format, e.g. 2004
monththe month, in the range 0 to 11
daythe day of the month, in the range 1 to 31
hourshours in 24-hour clock format, 0 to 23
minutesminutes 0 to 59
secondsseconds 0 to 59
millisecondsmilliseconds 0 to 999
useLocalTimeif true, encode using the current machine's local time; if false, it will always work in GMT.
Time::Time ( const Time other)
noexcept

Creates a copy of another Time object.

Time::~Time ( )
noexcept

Destructor.

Member Function Documentation

Time& Time::operator= ( const Time other)
noexcept

Copies this time from another one.

static Time JUCE_CALLTYPE Time::getCurrentTime ( )
staticnoexcept

Returns a Time object that is set to the current system time.

See Also
currentTimeMillis
int64 Time::toMilliseconds ( ) const
noexcept

Returns the time as a number of milliseconds.

Returns
the number of milliseconds this Time object represents, since midnight jan 1st 1970.
See Also
getMilliseconds
int Time::getYear ( ) const
noexcept

Returns the year.

A 4-digit format is used, e.g. 2004.

int Time::getMonth ( ) const
noexcept

Returns the number of the month.

The value returned is in the range 0 to 11.

See Also
getMonthName
String Time::getMonthName ( bool  threeLetterVersion) const

Returns the name of the month.

Parameters
threeLetterVersionif true, it'll be a 3-letter abbreviation, e.g. "Jan"; if false it'll return the long form, e.g. "January"
See Also
getMonth
int Time::getDayOfMonth ( ) const
noexcept

Returns the day of the month.

The value returned is in the range 1 to 31.

int Time::getDayOfWeek ( ) const
noexcept

Returns the number of the day of the week.

The value returned is in the range 0 to 6 (0 = sunday, 1 = monday, etc).

int Time::getDayOfYear ( ) const
noexcept

Returns the number of the day of the year.

The value returned is in the range 0 to 365.

String Time::getWeekdayName ( bool  threeLetterVersion) const

Returns the name of the weekday.

Parameters
threeLetterVersionif true, it'll return a 3-letter abbreviation, e.g. "Tue"; if false, it'll return the full version, e.g. "Tuesday".
int Time::getHours ( ) const
noexcept

Returns the number of hours since midnight.

This is in 24-hour clock format, in the range 0 to 23.

See Also
getHoursInAmPmFormat, isAfternoon
bool Time::isAfternoon ( ) const
noexcept

Returns true if the time is in the afternoon.

So it returns true for "PM", false for "AM".

See Also
getHoursInAmPmFormat, getHours
int Time::getHoursInAmPmFormat ( ) const
noexcept

Returns the hours in 12-hour clock format.

This will return a value 1 to 12 - use isAfternoon() to find out whether this is in the afternoon or morning.

See Also
getHours, isAfternoon
int Time::getMinutes ( ) const
noexcept

Returns the number of minutes, 0 to 59.

int Time::getSeconds ( ) const
noexcept

Returns the number of seconds, 0 to 59.

int Time::getMilliseconds ( ) const
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.

See Also
toMilliseconds
bool Time::isDaylightSavingTime ( ) const
noexcept

Returns true if the local timezone uses a daylight saving correction.

String Time::getTimeZone ( ) const
noexcept

Returns a 3-character string to indicate the local timezone.

String Time::toString ( bool  includeDate,
bool  includeTime,
bool  includeSeconds = true,
bool  use24HourClock = false 
) const
noexcept

Quick way of getting a string version of a date and time.

For a more powerful way of formatting the date and time, see the formatted() method.

Parameters
includeDatewhether to include the date in the string
includeTimewhether to include the time in the string
includeSecondsif the time is being included, this provides an option not to include the seconds in it
use24HourClockif the time is being included, sets whether to use am/pm or 24 hour notation.
See Also
formatted
String Time::formatted ( const String format) const

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):

a is replaced by the locale's abbreviated weekday name. A is replaced by the locale's full weekday name. b is replaced by the locale's abbreviated month name. B is replaced by the locale's full month name. c is replaced by the locale's appropriate date and time representation. d is replaced by the day of the month as a decimal number [01,31]. H is replaced by the hour (24-hour clock) as a decimal number [00,23]. I is replaced by the hour (12-hour clock) as a decimal number [01,12]. j is replaced by the day of the year as a decimal number [001,366]. m is replaced by the month as a decimal number [01,12]. M is replaced by the minute as a decimal number [00,59]. p is replaced by the locale's equivalent of either a.m. or p.m. S is replaced by the second as a decimal number [00,61]. U is replaced by the week number of the year (Sunday as the first day of the week) as a decimal number [00,53]. w is replaced by the weekday as a decimal number [0,6], with 0 representing Sunday. W is replaced by the week number of the year (Monday as the first day of the week) as a decimal number [00,53]. All days in a new year preceding the first Monday are considered to be in week 0. x is replaced by the locale's appropriate date representation. X is replaced by the locale's appropriate time representation. y is replaced by the year without century as a decimal number [00,99]. Y is replaced by the year with century as a decimal number. Z is replaced by the timezone name or abbreviation, or by no bytes if no timezone information exists. %% is replaced by %.

See Also
toString
Time& Time::operator+= ( RelativeTime  delta)
noexcept

Adds a RelativeTime to this time.

Time& Time::operator-= ( RelativeTime  delta)
noexcept

Subtracts a RelativeTime from this time.

bool Time::setSystemTimeToThisTime ( ) const

Tries to set the computer's clock.

Returns
true if this succeeds, although depending on the system, the application might not have sufficient privileges to do this.
static String Time::getWeekdayName ( int  dayNumber,
bool  threeLetterVersion 
)
static

Returns the name of a day of the week.

Parameters
dayNumberthe day, 0 to 6 (0 = sunday, 1 = monday, etc)
threeLetterVersionif true, it'll return a 3-letter abbreviation, e.g. "Tue"; if false, it'll return the full version, e.g. "Tuesday".
static String Time::getMonthName ( int  monthNumber,
bool  threeLetterVersion 
)
static

Returns the name of one of the months.

Parameters
monthNumberthe month, 0 to 11
threeLetterVersionif true, it'll be a 3-letter abbreviation, e.g. "Jan"; if false it'll return the long form, e.g. "January"
static int64 Time::currentTimeMillis ( )
staticnoexcept

Returns the current system time.

Returns the number of milliseconds since midnight jan 1st 1970.

Should be accurate to within a few millisecs, depending on platform, hardware, etc.

static uint32 Time::getMillisecondCounter ( )
staticnoexcept

Returns the number of millisecs since a fixed event (usually system startup).

This returns a monotonically increasing value which it 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.

See Also
getApproximateMillisecondCounter
static double Time::getMillisecondCounterHiRes ( )
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.

See Also
getMillisecondCounter
static void Time::waitForMillisecondCounter ( uint32  targetTime)
staticnoexcept

Waits until the getMillisecondCounter() reaches a given value.

This will make the thread sleep as efficiently as it can while it's waiting.

static uint32 Time::getApproximateMillisecondCounter ( )
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.

See Also
getMillisecondCounter
static int64 Time::getHighResolutionTicks ( )
staticnoexcept

Returns the current high-resolution counter's tick-count.

This is a similar idea to getMillisecondCounter(), but with a higher resolution.

See Also
getHighResolutionTicksPerSecond, highResolutionTicksToSeconds, secondsToHighResolutionTicks
static int64 Time::getHighResolutionTicksPerSecond ( )
staticnoexcept

Returns the resolution of the high-resolution counter in ticks per second.

See Also
getHighResolutionTicks, highResolutionTicksToSeconds, secondsToHighResolutionTicks
static double Time::highResolutionTicksToSeconds ( int64  ticks)
staticnoexcept

Converts a number of high-resolution ticks into seconds.

See Also
getHighResolutionTicks, getHighResolutionTicksPerSecond, secondsToHighResolutionTicks
static int64 Time::secondsToHighResolutionTicks ( double  seconds)
staticnoexcept

Converts a number seconds into high-resolution ticks.

See Also
getHighResolutionTicks, getHighResolutionTicksPerSecond, highResolutionTicksToSeconds
static Time Time::getCompilationDate ( )
static

Returns a Time based on the value of the __DATE__ macro when this module was compiled.


The documentation for this class was generated from the following file: