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): ______________________________________.
 *
 * $Revision: 32009 $
 * $Author: rjongbloed $
 * $Date: 2014-05-31 13:32:03 +1000 (Sat, 31 May 2014) $
 */

#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   
    );

    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
    };

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

    virtual PInt64 GetMilliSeconds() const;

    virtual void SetMilliSeconds(PInt64 msecs);

    long GetSeconds() const;

    long GetMinutes() const;

    int GetHours() const;

    int GetDays() const;

    DWORD GetInterval() const;

    virtual 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;

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

    PTimeInterval operator-(
      const PTimeInterval & interval   
    ) const;

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

    PTimeInterval operator*(
      int factor   
    ) const;

    PTimeInterval & operator*=(
      int factor   
    );

    int operator/(
      const PTimeInterval & smaller   
    ) const;

    PTimeInterval operator/(
      int factor   
    ) const;

    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;

  private:
  // Member variables
    PInt64 m_milliseconds;


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

#endif // PTLIB_TIMEINTERVAL_H


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