juce_RelativeTime.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_RELATIVETIME_H_INCLUDED
#define JUCE_RELATIVETIME_H_INCLUDED
 
 
//==============================================================================
class JUCE_API  RelativeTime
{
public:
    //==============================================================================
    explicit RelativeTime (double seconds = 0.0) noexcept;
 
    RelativeTime (const RelativeTime& other) noexcept;
 
    RelativeTime& operator= (const RelativeTime& other) noexcept;
 
    ~RelativeTime() noexcept;
 
    //==============================================================================
    static RelativeTime milliseconds (int milliseconds) noexcept;
 
    static RelativeTime milliseconds (int64 milliseconds) noexcept;
 
    static RelativeTime seconds (double seconds) noexcept;
 
    static RelativeTime minutes (double numberOfMinutes) noexcept;
 
    static RelativeTime hours (double numberOfHours) noexcept;
 
    static RelativeTime days (double numberOfDays) noexcept;
 
    static RelativeTime weeks (double numberOfWeeks) noexcept;
 
    //==============================================================================
    int64 inMilliseconds() const noexcept;
 
    double inSeconds() const noexcept       { return numSeconds; }
 
    double inMinutes() const noexcept;
 
    double inHours() const noexcept;
 
    double inDays() const noexcept;
 
    double inWeeks() const noexcept;
 
    String getDescription (const String& returnValueForZeroTime = "0") const;
 
 
    //==============================================================================
    RelativeTime operator+= (RelativeTime timeToAdd) noexcept;
    RelativeTime operator-= (RelativeTime timeToSubtract) noexcept;
 
    RelativeTime operator+= (double secondsToAdd) noexcept;
    RelativeTime operator-= (double secondsToSubtract) noexcept;
 
private:
    //==============================================================================
    double numSeconds;
};
 
//==============================================================================
bool operator== (RelativeTime t1, RelativeTime t2) noexcept;
bool operator!= (RelativeTime t1, RelativeTime t2) noexcept;
bool operator>  (RelativeTime t1, RelativeTime t2) noexcept;
bool operator<  (RelativeTime t1, RelativeTime t2) noexcept;
bool operator>= (RelativeTime t1, RelativeTime t2) noexcept;
bool operator<= (RelativeTime t1, RelativeTime t2) noexcept;
 
//==============================================================================
RelativeTime  operator+  (RelativeTime t1, RelativeTime t2) noexcept;
RelativeTime  operator-  (RelativeTime t1, RelativeTime t2) noexcept;
 
 
 
#endif   // JUCE_RELATIVETIME_H_INCLUDED