timeint.h

Go to the documentation of this file.

/*
 * timeint.h
 *
 * Millisecond resolution time interval class (uses 64 bit integers).
 *
 * Portable Windows Library
 *
 * Copyright (c) 1993-1998 Equivalence Pty. Ltd.
 *
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 *
 * The Original Code is Portable Windows Library.
 *
 * The Initial Developer of the Original Code is Equivalence Pty. Ltd.
 *
 * Portions are Copyright (C) 1993 Free Software Foundation, Inc.
 * All Rights Reserved.
 *
 * Contributor(s): ______________________________________.
 */

#ifndef PTLIB_TIMEINTERVAL_H
#define PTLIB_TIMEINTERVAL_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif


// Difference between two system times

class PTimeInterval : public PObject
{
  PCLASSINFO(PTimeInterval, PObject);

  public:
    PTimeInterval(
      PInt64 millisecs = 0   
    );
    PTimeInterval(
      PInt64 millisecs,     
      long seconds,         
      long minutes = 0,     
      long hours = 0,       
      int days = 0          
    );
    PTimeInterval(
      const PString & str   
    );

    PTimeInterval(const PTimeInterval & other);
    PTimeInterval & operator=(const PTimeInterval & other);

    static PTimeInterval NanoSeconds(
      int64_t nsecs,
      int secs = 0
    );

    static PTimeInterval MicroSeconds(
      int64_t usecs,
      int secs = 0
    );

    static PTimeInterval Seconds(
      double secs
    );

    static PTimeInterval Frequency(
      double frequency
    );

    PObject * Clone() const;

    virtual Comparison Compare(
      const PObject & obj   
    ) const;

    virtual void PrintOn(
      ostream & strm    
    ) const;

    virtual void ReadFrom(
      istream & strm    
    );

    enum Formats {
      NormalFormat,     
      IncludeDays,      
      SecondsOnly,      
      SecondsSI         
    };

    PString AsString(
      int decimals = 3,                 
      Formats format = NormalFormat,    
      int width = 1                     
    ) const;

    PInt64 GetNanoSeconds() const;

    void SetNanoSeconds(
      int64_t nsecs,
      int secs = 0
    );

    PInt64 GetMicroSeconds() const;

    void SetMicroSeconds(
      int64_t usecs,
      int secs = 0
    );

    double GetFrequency() const;

    void SetFrequency(double frequency);

    PInt64 GetMilliSeconds() const;

    void SetMilliSeconds(PInt64 msecs);

    long GetSeconds() const;

    double GetSecondsAsDouble() const;

    void SetSeconds(
      double secs
    );

    long GetMinutes() const;

    int GetHours() const;

    int GetDays() const;

#ifdef _WIN32
    typedef DWORD IntervalType;
#else
    typedef int IntervalType;
#endif

    IntervalType GetInterval() const;

    void SetInterval(
      PInt64 milliseconds = 0,  
      long seconds = 0,         
      long minutes = 0,         
      long hours = 0,           
      int days = 0              
    );

    PTimeInterval operator-() const;

    PTimeInterval operator+(
      const PTimeInterval & interval   
    ) const;
    friend PTimeInterval operator+(int64_t left, const PTimeInterval & right);

    PTimeInterval & operator+=(
      const PTimeInterval & interval   
    );

    PTimeInterval operator-(
      const PTimeInterval & interval   
    ) const;
    friend PTimeInterval operator-(int64_t left, const PTimeInterval & right);

    PTimeInterval & operator-=(
      const PTimeInterval & interval   
    );

    PTimeInterval operator*(
      int factor   
    ) const;
    friend PTimeInterval operator*(int left, const PTimeInterval & right);

    PTimeInterval & operator*=(
      int factor   
    );

    int operator/(
      const PTimeInterval & smaller   
    ) const;

    PTimeInterval operator/(
      int factor   
    ) const;
    friend PTimeInterval operator/(int64_t left, const PTimeInterval & right);

    PTimeInterval & operator/=(
      int factor   
    );

    bool operator==(
      const PTimeInterval & interval   
    ) const;
    bool operator==(
      long msecs    
    ) const;

    bool operator!=(
      const PTimeInterval & interval   
    ) const;
    bool operator!=(
      long msecs    
    ) const;

    bool operator> (
      const PTimeInterval & interval   
    ) const;
    bool operator> (
      long msecs    
    ) const;

    bool operator>=(
      const PTimeInterval & interval   
    ) const;
    bool operator>=(
      long msecs    
    ) const;

    bool operator< (
      const PTimeInterval & interval   
    ) const;
    bool operator< (
      long msecs    
    ) const;

    bool operator<=(
      const PTimeInterval & interval   
    ) const;
    bool operator<=(
      long msecs    
    ) const;

    static int64_t const MicroToNano = 1000;
    static int64_t const MilliToNano = MicroToNano*1000;
    static int64_t const SecsToNano  = MilliToNano*1000;
    static int64_t const MinsToNano  = SecsToNano*60;
    static int64_t const HoursToNano = MinsToNano*60;
    static int64_t const DaysToNano  = HoursToNano*24;

  protected:
    virtual int64_t InternalGet() const;
    virtual void InternalSet(int64_t t);

  private:
    atomic<int64_t> m_nanoseconds;


// Include platform dependent part of class
#ifdef _WIN32
#include "msos/ptlib/timeint.h"
#else
#include "unix/ptlib/timeint.h"
#endif
};


struct PNanoSeconds : PTimeInterval
{
  PNanoSeconds(int64_t nanoseconds) { SetNanoSeconds(nanoseconds); }
};

struct PMicroSeconds : PTimeInterval
{
  PMicroSeconds(int64_t microseconds) { SetMicroSeconds(microseconds); }
};

typedef PTimeInterval PMilliSeconds;

struct PFrequencyTime : PTimeInterval
{
  PFrequencyTime(double frequency) { SetFrequency(frequency); }
};


namespace std
{
  template<> class numeric_limits<PTimeInterval>
  {
  public:
    static PTimeInterval min() { return -PMaxTimeInterval; }
    static PTimeInterval max() { return  PMaxTimeInterval; }
    static PTimeInterval epsilon() { return PTimeInterval::NanoSeconds(1); }
    static PTimeInterval round_error() { return PTimeInterval::NanoSeconds(1); }
    static PTimeInterval denorm_min() { return PTimeInterval::NanoSeconds(numeric_limits<int64_t>::denorm_min()); }
    static PTimeInterval infinity() { return PTimeInterval::NanoSeconds(numeric_limits<int64_t>::infinity()); }
    static PTimeInterval quiet_NaN() { return PTimeInterval::NanoSeconds(numeric_limits<int64_t>::quiet_NaN()); }
    static PTimeInterval signaling_NaN() { return PTimeInterval::NanoSeconds(numeric_limits<int64_t>::signaling_NaN()); }
  };
};


#endif // PTLIB_TIMEINTERVAL_H


// End Of File ///////////////////////////////////////////////////////////////