/* * 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): ______________________________________. * * $Log: timeint.h,v $ * Revision 1.31 2005/11/25 03:43:47 csoutheren * Fixed function argument comments to be compatible with Doxygen * * Revision 1.30 2004/04/18 04:33:36 rjongbloed * Changed all operators that return BOOL to return standard type bool. This is primarily * for improved compatibility with std STL usage removing many warnings. * * Revision 1.29 2003/09/17 05:41:59 csoutheren * Removed recursive includes * * Revision 1.28 2003/09/17 01:18:02 csoutheren * Removed recursive include file system and removed all references * to deprecated coooperative threading support * * Revision 1.27 2002/09/16 01:08:59 robertj * Added #define so can select if #pragma interface/implementation is used on * platform basis (eg MacOS) rather than compiler, thanks Robert Monaghan. * * Revision 1.26 2002/05/28 13:05:26 robertj * Fixed PTimer::SetInterval so it restarts timer as per operator=() * * Revision 1.25 2001/10/16 07:44:06 robertj * Added AsString() function to PTimeInterval. * * Revision 1.24 2001/07/10 02:55:16 robertj * Added unary minus operator * * Revision 1.23 2001/05/22 12:49:32 robertj * Did some seriously wierd rewrite of platform headers to eliminate the * stupid GNU compiler warning about braces not matching. * * Revision 1.22 2000/10/05 23:36:26 robertj * Fixed compiler ambiguities in PTimeInterval constructor. * * Revision 1.21 2000/03/06 04:09:23 robertj * Added constructor to do PString conversion to PTimeInterval * * Revision 1.20 1999/07/06 04:46:00 robertj * Fixed being able to case an unsigned to a PTimeInterval. * Improved resolution of PTimer::Tick() to be millisecond accurate. * * Revision 1.19 1999/03/09 02:59:51 robertj * Changed comments to doc++ compatible documentation. * * Revision 1.18 1999/02/16 08:11:17 robertj * MSVC 6.0 compatibility changes. * * Revision 1.17 1998/09/23 06:21:43 robertj * Added open source copyright license. * * Revision 1.16 1998/01/26 00:49:53 robertj * Added multiply and divide operators to PTimeInterval. * * Revision 1.15 1996/05/15 10:19:29 robertj * Changed millisecond access functions to get 64 bit integer. * * Revision 1.14 1996/05/09 12:22:09 robertj * Resolved C++ problems with 64 bit PTimeInterval for Mac platform. * * Revision 1.13 1996/03/17 05:52:02 robertj * Changed PTimeInterval to 64 bit integer. * * Revision 1.12 1995/03/14 12:42:50 robertj * Updated documentation to use HTML codes. * * Revision 1.11 1995/01/18 09:01:32 robertj * Documentation. * * Revision 1.10 1995/01/09 12:29:41 robertj * Removed unnecesary return value from I/O functions. * * Revision 1.9 1994/08/23 11:32:52 robertj * Oops * * Revision 1.8 1994/08/22 00:46:48 robertj * Added pragma fro GNU C++ compiler. * * Revision 1.7 1994/07/02 03:03:49 robertj * Timer redesign consequences and ability to compare a time interval against * ordinary integer milliseconds. * * Revision 1.6 1994/06/25 11:55:15 robertj * Unix version synchronisation. * * Revision 1.5 1994/01/03 04:42:23 robertj * Mass changes to common container classes and interactors etc etc etc. * * Revision 1.4 1993/08/31 03:38:02 robertj * Added copy constructor and assignement oeprator due to G++ strangeness. * * Revision 1.3 1993/08/27 18:17:47 robertj * Added function to set the interval of a PTieInterval object. * Used a common type for number of milliseconds. * * Revision 1.2 1993/07/14 12:49:16 robertj * Fixed RCS keywords. * */ #ifndef _PTIMEINTERVAL #define _PTIMEINTERVAL #ifdef P_USE_PRAGMA #pragma interface #endif /////////////////////////////////////////////////////////////////////////////// // Difference between two system times /** This class defines an arbitrary time interval to millisecond accuracy. The interval can be both positive and negative. A long int is used to store the time interval so it is limited to LONG_MAX (found in the standard C header file limits.h) milliseconds. This is approximately 596 hours for 32 bit integers. There is a constant, #PMaxTimeInterval# which defines the maximum number of milliseconds that a time interval may be. */ class PTimeInterval : public PObject { PCLASSINFO(PTimeInterval, PObject); public: /**@name Construction */ //@{ /** Create a new time interval object. The time interval, in milliseconds, is the sum of all of the parameters. For example all of the following are equivalent: \begin{verbatim} PTimeInterval(120000) PTimeInterval(60000, 60) PTimeInterval(60000, 0, 1) PTimeInterval(0, 60, 1) PTimeInterval(0, 0, 2) \end{verbatim} */ PTimeInterval( PInt64 millisecs = 0 ///< Number of milliseconds for interval. ); PTimeInterval( long millisecs, ///< Number of milliseconds for interval. long seconds, ///< Number of seconds for interval. long minutes = 0, ///< Number of minutes for interval. long hours = 0, ///< Number of hours for interval. int days = 0 ///< Number of days for interval. ); PTimeInterval( const PString & str ///< String representation of time interval. ); //@} /**@name Overrides from class PObject */ //@{ /** Create a new copy of the time interval. It is the responsibility of the called to delete the object. @return new time interval on heap. */ PObject * Clone() const; /** Rank the two time intervals. This ranks the intervals as you would expect for two integers. @return #EqualTo#, #LessThan# or #GreaterThan# depending on their relative rank. */ virtual Comparison Compare( const PObject & obj ///< Time interval to compare against. ) const; /** Output the time interval to the I/O stream. This outputs the number of milliseconds as a signed decimal integer number. */ virtual void PrintOn( ostream & strm ///< I/O stream to output the time interval. ) const; /** Input the time interval from the I/O stream. This expects the input to be a signed decimal integer number. */ virtual void ReadFrom( istream & strm ///< I/O stream to input the time interval from. ); //@} /**@name Conversion functions */ //@{ enum Formats { NormalFormat, IncludeDays, SecondsOnly }; PString AsString( int decimals = 3, Formats format = NormalFormat, int width = 1 ) const; //@} /**@name Access functions */ //@{ /** Get the number of milliseconds for the time interval. @return very long integer number of milliseconds. */ PInt64 GetMilliSeconds() const; /** Get the number of whole seconds for the time interval. @return long integer number of seconds. */ long GetSeconds() const; /** Get the number of whole minutes for the time interval. @return integer number of minutes. */ long GetMinutes() const; /** Get the number of whole hours for the time interval. @return integer number of hours. */ int GetHours() const; /** Get the number of whole days for the time interval. @return integer number of days. */ int GetDays() const; /** Get the number of milliseconds for the time interval. @return long integer number of milliseconds. */ DWORD GetInterval() const; /** Set the value of the time interval. The time interval, in milliseconds, is the sum of all of the parameters. For example all of the following are equivalent: \begin{verbatim} SetInterval(120000) SetInterval(60000, 60) SetInterval(60000, 0, 1) SetInterval(0, 60, 1) SetInterval(0, 0, 2) \end{verbatim} */ virtual void SetInterval( PInt64 milliseconds = 0, ///< Number of milliseconds for interval. long seconds = 0, ///< Number of seconds for interval. long minutes = 0, ///< Number of minutes for interval. long hours = 0, ///< Number of hours for interval. int days = 0 ///< Number of days for interval. ); //@} /**@name Operations */ //@{ /** Unary minus, get negative of time interval. @return difference of the time intervals. */ PTimeInterval operator-() const; /** Add the two time intervals yielding a third time interval. @return sum of the time intervals. */ PTimeInterval operator+( const PTimeInterval & interval ///< Time interval to add. ) const; /** Add the second time interval to the first time interval. @return reference to first time interval. */ PTimeInterval & operator+=( const PTimeInterval & interval ///< Time interval to add. ); /** Subtract the two time intervals yielding a third time interval. @return difference of the time intervals. */ PTimeInterval operator-( const PTimeInterval & interval ///< Time interval to subtract. ) const; /** Subtract the second time interval from the first time interval. @return reference to first time interval. */ PTimeInterval & operator-=( const PTimeInterval & interval ///< Time interval to subtract. ); /** Multiply the time interval by a factor yielding a third time interval. @return the time intervals times the factor. */ PTimeInterval operator*( int factor ///< factor to multiply. ) const; /** Multiply the time interval by a factor. @return reference to time interval. */ PTimeInterval & operator*=( int factor ///< factor to multiply. ); /** Divide the time interval by a factor yielding a third time interval. @return the time intervals divided by the factor. */ PTimeInterval operator/( int factor ///< factor to divide. ) const; /** Divide the time interval by a factor. @return reference to time interval. */ PTimeInterval & operator/=( int factor ///< factor to divide. ); //@} /**@name Comparison functions */ //@{ /** Compare to the two time intervals. This is provided as an override to the default in PObject so that comparisons can be made to integer literals that represent milliseconds. @return TRUE if intervals are equal. */ bool operator==( const PTimeInterval & interval ///< Time interval to compare. ) const; bool operator==( long msecs ///< Time interval as integer milliseconds to compare. ) const; /** Compare to the two time intervals. This is provided as an override to the default in PObject so that comparisons can be made to integer literals that represent milliseconds. @return TRUE if intervals are not equal. */ bool operator!=( const PTimeInterval & interval ///< Time interval to compare. ) const; bool operator!=( long msecs ///< Time interval as integer milliseconds to compare. ) const; /** Compare to the two time intervals. This is provided as an override to the default in PObject so that comparisons can be made to integer literals that represent milliseconds. @return TRUE if intervals are greater than. */ bool operator> ( const PTimeInterval & interval ///< Time interval to compare. ) const; bool operator> ( long msecs ///< Time interval as integer milliseconds to compare. ) const; /** Compare to the two time intervals. This is provided as an override to the default in PObject so that comparisons can be made to integer literals that represent milliseconds. @return TRUE if intervals are greater than or equal. */ bool operator>=( const PTimeInterval & interval ///< Time interval to compare. ) const; bool operator>=( long msecs ///< Time interval as integer milliseconds to compare. ) const; /** Compare to the two time intervals. This is provided as an override to the default in PObject so that comparisons can be made to integer literals that represent milliseconds. @return TRUE if intervals are less than. */ bool operator< ( const PTimeInterval & interval ///< Time interval to compare. ) const; bool operator< ( long msecs ///< Time interval as integer milliseconds to compare. ) const; /** Compare to the two time intervals. This is provided as an override to the default in PObject so that comparisons can be made to integer literals that represent milliseconds. @return TRUE if intervals are less than or equal. */ bool operator<=( const PTimeInterval & interval ///< Time interval to compare. ) const; bool operator<=( long msecs ///< Time interval as integer milliseconds to compare. ) const; //@} protected: // Member variables /// Number of milliseconds in time interval. PInt64 milliseconds; // Include platform dependent part of class #ifdef _WIN32 #include "msos/ptlib/timeint.h" #else #include "unix/ptlib/timeint.h" #endif }; #endif // End Of File ///////////////////////////////////////////////////////////////