SbTime.h

/*=======================================================================
 * Copyright 1991-1996, Silicon Graphics, Inc.
 * ALL RIGHTS RESERVED
 *
 * UNPUBLISHED -- Rights reserved under the copyright laws of the United
 * States.   Use of a copyright notice is precautionary only and does not
 * imply publication or disclosure.
 *
 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
 * Use, duplication or disclosure by the Government is subject to restrictions
 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
 * in similar or successor clauses in the FAR, or the DOD or NASA FAR
 * Supplement.  Contractor/manufacturer is Silicon Graphics, Inc.,
 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
 *
 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
 * GRAPHICS, INC.
**=======================================================================*/
/*=======================================================================
** Author      : Nick Thompson (MMM yyyy)
**=======================================================================*/
/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2014 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifndef _SB_TIME_
#define _SB_TIME_
 
#include <Inventor/sys/port.h>
 
#ifdef _WIN32
#  include <time.h>
#else
#  include <sys/time.h>
#endif
 
#include <math.h>
#include <limits.h>
#include <Inventor/SbBase.h>
#include <Inventor/SbString.h>
 
//
//  Class: SbTime
//
//  Representation of a time.  Some parts are not adequately debugged:
//  for example, it is not clear when it is legal to have negative
//  values.
//
 
class  SbTime {
 
 public:
  SbTime() {}
 
  SbTime(double sec);
 
  SbTime(time_t sec, long usec);
 
 private:
  // Constructor taking milliseconds
  //
  // NOTE! This constructor has been removed.  Change existing uses of
  //          SbTime(msec)
  // to
  //          time_t secs = msec / 1000;
  //          SbTime(secs, 1000 * (msec - 1000 * sec))
  // The constructor was removed because it led to unexpected results --
  // while SbTime(1.0) results in 1 second, SbTime(1) resulted in 1
  // MILLIsecond).  Its declaration has been kept, as "private", so that 
  // existing code using it will get compilation errors; if it was removed
  // completely, an existing use of SbTime(1) would silently cast to
  // SbTime(1.0) resulting in hard-to-find bugs.  This declaration
  // will be removed entirely in a future release, so that SbTime(1)
  // will be equivalent to SbTime(1.0).
  SbTime(uint32_t msec);
 
 public:
  SbTime(const struct timeval *tv);
 
  static SbTime getTimeOfDay();
 
  void setToTimeOfDay();
 
  static SbTime zero();
  
  static void sleep(const int msec);
 
  static void usleep(size_t usec);
 
#if !defined(_WIN32)
  static SbTime max();
#endif
 
  static SbTime maxTime();
 
  void setValue(double sec);
 
  void setValue(time_t sec, long usec);
 
  void setValue(const struct timeval *tv);
 
  void setMsecValue(unsigned long msec);
 
  double getValue() const;
 
  void getValue(time_t &sec, long &usec) const;
 
  void getValue(struct timeval *tv) const;
 
  unsigned long getMsecValue() const;
 
  SbString format(const char *fmt = "%S.%i") const;
 
#ifdef _WIN32
#  define DEFAULT_FORMAT_DATE   "%#c"
#else  
#  define DEFAULT_FORMAT_DATE   "%A, %D %r"
#endif
  SbString formatDate(const char *fmt = DEFAULT_FORMAT_DATE) const;
 
   friend SbTime operator +(const SbTime &t0, const SbTime &t1);
 
   friend SbTime operator -(const SbTime &t0, const SbTime &t1);
 
  SbTime &operator +=(const SbTime &tm);
 
  SbTime &operator -=(const SbTime &tm);
 
  SbTime operator -() const;
 
   friend SbTime operator *(const SbTime &tm, double s);
   friend SbTime operator *(double s, const SbTime &tm);
 
  SbTime &operator *=(double s);
 
   friend SbTime operator /(const SbTime &tm, double s);
 
  SbTime & operator /=(double s);
 
  double operator /(const SbTime &tm) const;
 
  SbTime operator %(const SbTime &tm) const;
 
  int operator ==(const SbTime &tm) const;
 
  int operator !=(const SbTime &tm) const;
 
  inline SbBool operator <(const SbTime &tm) const;
  inline SbBool operator >(const SbTime &tm) const;
  inline SbBool operator <=(const SbTime &tm) const;
  inline SbBool operator >=(const SbTime &tm) const;
 
 private:
  struct timeval t;
 
};
 
inline SbBool
SbTime::operator <(const SbTime &tm) const
{
  if ((t.tv_sec < tm.t.tv_sec) ||
      (t.tv_sec == tm.t.tv_sec && t.tv_usec < tm.t.tv_usec))
    return TRUE;
  else
    return FALSE;
}
 
inline SbBool
SbTime::operator >(const SbTime &tm) const
{
  if ((t.tv_sec > tm.t.tv_sec) ||
      (t.tv_sec == tm.t.tv_sec && t.tv_usec > tm.t.tv_usec))
    return TRUE;
  else
    return FALSE;
}
 
inline SbBool
SbTime::operator <=(const SbTime &tm) const
{
  if ((t.tv_sec < tm.t.tv_sec) ||
      (t.tv_sec == tm.t.tv_sec && t.tv_usec <= tm.t.tv_usec))
    return TRUE;
  else
    return FALSE;
}
 
inline SbBool
SbTime::operator >=(const SbTime &tm) const
{
  if ((t.tv_sec > tm.t.tv_sec) ||
      (t.tv_sec == tm.t.tv_sec && t.tv_usec >= tm.t.tv_usec))
    return TRUE;
  else
    return FALSE;
}
 
#endif /* _SB_TIME_ */