juce_Time.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the juce_core module of the JUCE library.
   Copyright (c) 2015 - ROLI Ltd.
 
   Permission to use, copy, modify, and/or distribute this software for any purpose with
   or without fee is hereby granted, provided that the above copyright notice and this
   permission notice appear in all copies.
 
   THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
   TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN
   NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
   DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
   IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
   CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
   ------------------------------------------------------------------------------
 
   NOTE! This permissive ISC license applies ONLY to files within the juce_core module!
   All other JUCE modules are covered by a dual GPL/commercial license, so if you are
   using any other modules, be sure to check that you also comply with their license.
 
   For more details, visit www.juce.com
 
  ==============================================================================
*/
 
#ifndef JUCE_TIME_H_INCLUDED
#define JUCE_TIME_H_INCLUDED
 
 
//==============================================================================
class JUCE_API  Time
{
public:
    //==============================================================================
    Time() noexcept;
 
    explicit 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& other) noexcept;
 
    ~Time() noexcept;
 
    Time& operator= (const Time& other) noexcept;
 
    //==============================================================================
    static Time JUCE_CALLTYPE getCurrentTime() noexcept;
 
    int64 toMilliseconds() const noexcept                           { return millisSinceEpoch; }
 
    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 noexcept;
 
    //==============================================================================
    String toString (bool includeDate,
                     bool includeTime,
                     bool includeSeconds = true,
                     bool use24HourClock = false) const noexcept;
 
    String formatted (const String& format) const;
 
    //==============================================================================
    Time& operator+= (RelativeTime delta) noexcept;
    Time& operator-= (RelativeTime delta) noexcept;
 
    //==============================================================================
    bool setSystemTimeToThisTime() const;
 
    //==============================================================================
    static String getWeekdayName (int dayNumber, bool threeLetterVersion);
 
    static String getMonthName (int monthNumber, bool threeLetterVersion);
 
    //==============================================================================
    // Static methods for getting system timers directly..
 
    static int64 currentTimeMillis() noexcept;
 
    static uint32 getMillisecondCounter() noexcept;
 
    static double getMillisecondCounterHiRes() noexcept;
 
    static void waitForMillisecondCounter (uint32 targetTime) noexcept;
 
    static uint32 getApproximateMillisecondCounter() noexcept;
 
    //==============================================================================
    // High-resolution timers..
 
    static int64 getHighResolutionTicks() noexcept;
 
    static int64 getHighResolutionTicksPerSecond() noexcept;
 
    static double highResolutionTicksToSeconds (int64 ticks) noexcept;
 
    static int64 secondsToHighResolutionTicks (double seconds) noexcept;
 
    static Time getCompilationDate();
 
private:
    //==============================================================================
    int64 millisSinceEpoch;
};
 
//==============================================================================
JUCE_API Time operator+ (Time time, RelativeTime delta) noexcept;
JUCE_API Time operator+ (RelativeTime delta, Time time) noexcept;
 
JUCE_API Time operator- (Time time, RelativeTime delta) noexcept;
JUCE_API const RelativeTime operator- (Time time1, Time time2) noexcept;
 
JUCE_API bool operator== (Time time1, Time time2) noexcept;
JUCE_API bool operator!= (Time time1, Time time2) noexcept;
JUCE_API bool operator<  (Time time1, Time time2) noexcept;
JUCE_API bool operator<= (Time time1, Time time2) noexcept;
JUCE_API bool operator>  (Time time1, Time time2) noexcept;
JUCE_API bool operator>= (Time time1, Time time2) noexcept;
 
 
#endif   // JUCE_TIME_H_INCLUDED