nstime.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2005,2006 INRIA
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
 */
#ifndef TIME_H
#define TIME_H

#include "assert.h"
#include "attribute.h"
#include "attribute-helper.h"
#include "int64x64.h"
#include "unused.h"
#include <stdint.h>
#include <limits>
#include <cmath>
#include <ostream>
#include <set>

namespace ns3 {

class TimeWithUnit;
  
class Time
{
public:
  enum Unit
  {
    Y   = 0,   
    D   = 1,   
    H   = 2,   
    MIN = 3,   
    S   = 4,   
    MS  = 5,   
    US  = 6,   
    NS  = 7,   
    PS  = 8,   
    FS  = 9,   
    LAST = 10
  };

  inline Time & operator = (const Time & o)
  {
    m_data = o.m_data;
    return *this;
  }
  inline Time ()
    : m_data ()
  {
    if (g_markingTimes)
      {
    Mark (this);
      }
  }
  inline Time(const Time & o)
    : m_data (o.m_data)
  {
    if (g_markingTimes)
      {
    Mark (this);
      }
  }
  explicit inline Time (double v)
    : m_data (lround (v))
  {
    if (g_markingTimes)
      {
    Mark (this);
      }
  }
  explicit inline Time (int v)
    : m_data (v)
  {
    if (g_markingTimes)
      {
    Mark (this);
      }
  }
  explicit inline Time (long int v)
    : m_data (v)
  {
    if (g_markingTimes)
      {
    Mark (this);
      }
  }
  explicit inline Time (long long int v)
    : m_data (v)
  {
    if (g_markingTimes)
      {
    Mark (this);
      }
  }
  explicit inline Time (unsigned int v)
    : m_data (v)
  {
    if (g_markingTimes)
      {
    Mark (this);
      }
  }
  explicit inline Time (unsigned long int v)
    : m_data (v)
  {
    if (g_markingTimes)
      {
    Mark (this);
      }
  }
  explicit inline Time (unsigned long long int v)
    : m_data (v)
  {
    if (g_markingTimes)
      {
    Mark (this);
      }
  }
  explicit Time (const std::string & s);

  static Time Min ()
  {
    return Time (std::numeric_limits<int64_t>::min ());
  }
  static Time Max ()
  {
    return Time (std::numeric_limits<int64_t>::max ());
  }

  ~Time ()
  {
    if (g_markingTimes)
      {
        Clear (this);
      }
  }

  inline bool IsZero (void) const
  {
    return m_data == 0;
  }
  inline bool IsNegative (void) const
  {
    return m_data <= 0;
  }
  inline bool IsPositive (void) const
  {
    return m_data >= 0;
  }
  inline bool IsStrictlyNegative (void) const
  {
    return m_data < 0;
  }
  inline bool IsStrictlyPositive (void) const
  {
    return m_data > 0;
  }
  inline int Compare (const Time & o) const
  {
    return (m_data < o.m_data) ? -1 : (m_data == o.m_data) ? 0 : 1;
  }

  inline double GetSeconds (void) const
  {
    return ToDouble (Time::S);
  }

  inline int64_t GetMilliSeconds (void) const
  {
    return ToInteger (Time::MS);
  }
  inline int64_t GetMicroSeconds (void) const
  {
    return ToInteger (Time::US);
  }
  inline int64_t GetNanoSeconds (void) const
  {
    return ToInteger (Time::NS);
  }
  inline int64_t GetPicoSeconds (void) const
  {
    return ToInteger (Time::PS);
  }
  inline int64_t GetFemtoSeconds (void) const
  {
    return ToInteger (Time::FS);
  }

  inline double GetMinutes (void) const
  {
    return ToDouble (Time::MIN);
  }
  inline double GetHours (void) const
  {
    return ToDouble (Time::H);
  }
  inline double GetDays (void) const
  {
    return ToDouble (Time::D);
  }
  inline double GetYears (void) const
  {
    return ToDouble (Time::Y);
  }

  inline int64_t GetTimeStep (void) const
  {
    return m_data;
  }
  inline double GetDouble (void) const
  {
    return m_data;
  }
  inline int64_t GetInteger (void) const
  {
    return GetTimeStep ();
  }


  static void SetResolution (enum Unit resolution);
  static enum Unit GetResolution (void);
  inline static Time FromInteger (uint64_t value, enum Unit timeUnit)
  {
    struct Information *info = PeekInformation (timeUnit);
    if (info->fromMul)
      {
        value *= info->factor;
      }
    else
      {
        value /= info->factor;
      }
    return Time (value);
  }
  inline int64_t ToInteger (enum Unit timeUnit) const
  {
    struct Information *info = PeekInformation (timeUnit);
    int64_t v = m_data;
    if (info->toMul)
      {
        v *= info->factor;
      }
    else
      {
        v /= info->factor;
      }
    return v;
  }
  inline static Time FromDouble (double value, enum Unit timeUnit)
  {
    return From (int64x64_t (value), timeUnit);
  }
  inline double ToDouble (enum Unit timeUnit) const
  {
    return To (timeUnit).GetDouble ();
  }
  static inline Time From (const int64x64_t & from, enum Unit timeUnit)
  {
    struct Information *info = PeekInformation (timeUnit);
    // DO NOT REMOVE this temporary variable. It's here
    // to work around a compiler bug in gcc 3.4
    int64x64_t retval = from;
    if (info->fromMul)
      {
        retval *= info->timeFrom;
      }
    else
      {
        retval.MulByInvert (info->timeFrom);
      }
    return Time (retval);
  }
  inline int64x64_t To (enum Unit timeUnit) const
  {
    struct Information *info = PeekInformation (timeUnit);
    int64x64_t retval = int64x64_t (m_data);
    if (info->toMul)
      {
        retval *= info->timeTo;
      }
    else
      {
        retval.MulByInvert (info->timeTo);
      }
    return retval;
  }
  inline operator int64x64_t () const
  {
    return int64x64_t (m_data);
  }
  explicit inline Time (const int64x64_t & value)
    : m_data (value.GetHigh ())
  {
    if (g_markingTimes)
      {
    Mark (this);
      }
  }
  inline static Time From (const int64x64_t & value)
  {
    return Time (value);
  }

  TimeWithUnit As (const enum Unit unit) const;

private:
  struct Information
  {
    bool toMul;                     
    bool fromMul;                   
    int64_t factor;                 
    int64x64_t timeTo;              
    int64x64_t timeFrom;            
  };
  struct Resolution
  {
    struct Information info[LAST];  
    enum Time::Unit unit;           
  };

  static inline struct Resolution *PeekResolution (void)
  {
    static struct Time::Resolution resolution = SetDefaultNsResolution ();
    return & resolution;
  }
  static inline struct Information *PeekInformation (enum Unit timeUnit)
  {
    return & (PeekResolution ()->info[timeUnit]);
  }

  static struct Resolution SetDefaultNsResolution (void);
  static void SetResolution (enum Unit unit, struct Resolution *resolution,
                             const bool convert = true);

  typedef std::set< Time * > MarkedTimes;
  static MarkedTimes * g_markingTimes;
public:
  static bool StaticInit ();
private:

  /* Friend the Simulator class so it can call the private function
     ClearMarkedTimes ()
  */
  friend class Simulator;
  static void ClearMarkedTimes ();
  static void Mark (Time * const time);
  static void Clear (Time * const time);
  static void ConvertTimes (const enum Unit unit);

  friend bool operator == (const Time & lhs, const Time & rhs);
  friend bool operator != (const Time & lhs, const Time & rhs);
  friend bool operator <= (const Time & lhs, const Time & rhs);
  friend bool operator >= (const Time & lhs, const Time & rhs);
  friend bool operator < (const Time & lhs, const Time & rhs);
  friend bool operator > (const Time & lhs, const Time & rhs);
  friend Time operator + (const Time & lhs, const Time & rhs);
  friend Time operator - (const Time & lhs, const Time & rhs);
  friend Time operator * (const Time & lhs, const int64_t & rhs);
  friend Time operator * (const int64_t & lhs, const Time & rhs);
  friend int64_t operator / (const Time & lhs, const Time & rhs);
  friend Time operator / (const Time & lhs, const int64_t & rhs);
  friend Time & operator += (Time & lhs, const Time & rhs);
  friend Time & operator -= (Time & lhs, const Time & rhs);
  friend Time Abs (const Time & time);
  friend Time Max (const Time & ta, const Time & tb);
  friend Time Min (const Time & ta, const Time & tb);


  int64_t m_data;                   

};  // class Time


static bool NS_UNUSED_GLOBAL (g_TimeStaticInit) = Time::StaticInit ();

inline bool
operator == (const Time & lhs, const Time & rhs)
{
  return lhs.m_data == rhs.m_data;
}
inline bool
operator != (const Time & lhs, const Time & rhs)
{
  return lhs.m_data != rhs.m_data;
}
inline bool
operator <= (const Time & lhs, const Time & rhs)
{
  return lhs.m_data <= rhs.m_data;
}
inline bool
operator >= (const Time & lhs, const Time & rhs)
{
  return lhs.m_data >= rhs.m_data;
}
inline bool
operator < (const Time & lhs, const Time & rhs)
{
  return lhs.m_data < rhs.m_data;
}
inline bool
operator > (const Time & lhs, const Time & rhs)
{
  return lhs.m_data > rhs.m_data;
}
inline Time operator + (const Time & lhs, const Time & rhs)
{
  return Time (lhs.m_data + rhs.m_data);
}
inline Time operator - (const Time & lhs, const Time & rhs)
{
  return Time (lhs.m_data - rhs.m_data);
}
inline Time
operator * (const Time & lhs, const int64_t & rhs)
{
  Time res = lhs;
  res.m_data *= rhs;
  return res;
}
inline Time
operator * (const int64_t & lhs, const Time & rhs)
{
  Time res = rhs;
  res.m_data *= lhs;
  return res;
}
inline int64_t
operator / (const Time & lhs, const Time & rhs)
{
  int64_t res = lhs.m_data / rhs.m_data;
  return res;
}
inline Time
operator / (const Time & lhs, const int64_t & rhs)
{
  Time res = lhs;
  res.m_data /= rhs;
  return res;
}
inline Time & operator += (Time & lhs, const Time & rhs)
{
  lhs.m_data += rhs.m_data;
  return lhs;
}
inline Time & operator -= (Time & lhs, const Time & rhs)
{
  lhs.m_data -= rhs.m_data;
  return lhs;
}

inline Time Max (const Time & ta, const Time & tb)
{
  return Time ((ta.m_data < tb.m_data) ? tb : ta);
}
inline Time Min (const Time & ta, const Time & tb)
{
  return Time ((ta.m_data > tb.m_data) ? tb : ta);
}

inline Time Abs (const Time & time)
{
  return Time ((time.m_data < 0) ? -time.m_data : time.m_data);
}

std::ostream & operator<< (std::ostream & os, const Time & time);
std::istream & operator>> (std::istream & is, Time & time);

inline Time Seconds (double seconds)
{
  return Time::FromDouble (seconds, Time::S);
}

inline Time MilliSeconds (uint64_t ms)
{
  return Time::FromInteger (ms, Time::MS);
}
inline Time MicroSeconds (uint64_t us)
{
  return Time::FromInteger (us, Time::US);
}
inline Time NanoSeconds (uint64_t ns)
{
  return Time::FromInteger (ns, Time::NS);
}
inline Time PicoSeconds (uint64_t ps)
{
  return Time::FromInteger (ps, Time::PS);
}
inline Time FemtoSeconds (uint64_t fs)
{
  return Time::FromInteger (fs, Time::FS);
}
inline Time Minutes (double minutes)
{
  return Time::FromDouble (minutes, Time::MIN);
}
inline Time Hours (double hours)
{
  return Time::FromDouble (hours, Time::H);
}
inline Time Days (double days)
{
  return Time::FromDouble (days, Time::D);
}
inline Time Years (double years)
{
  return Time::FromDouble (years, Time::Y);
}

inline Time Seconds (int64x64_t seconds)
{
  return Time::From (seconds, Time::S);
}
inline Time MilliSeconds (int64x64_t ms)
{
  return Time::From (ms, Time::MS);
}
inline Time MicroSeconds (int64x64_t us)
{
  return Time::From (us, Time::US);
}
inline Time NanoSeconds (int64x64_t ns)
{
  return Time::From (ns, Time::NS);
}
inline Time PicoSeconds (int64x64_t ps)
{
  return Time::From (ps, Time::PS);
}
inline Time FemtoSeconds (int64x64_t fs)
{
  return Time::From (fs, Time::FS);
}
inline Time Minutes (int64x64_t minutes)
{
  return Time::From (minutes, Time::MIN);
}
inline Time Hours (int64x64_t hours)
{
  return Time::From (hours, Time::H);
}
inline Time Days (int64x64_t days)
{
  return Time::From (days, Time::D);
}
inline Time Years (int64x64_t years)
{
  return Time::From (years, Time::Y);
}

// internal function not publicly documented
inline Time TimeStep (uint64_t ts)
{
  return Time (ts);
}

ATTRIBUTE_VALUE_DEFINE (Time);
ATTRIBUTE_ACCESSOR_DEFINE (Time);

Ptr<const AttributeChecker> MakeTimeChecker (const Time min, const Time max);

inline
Ptr<const AttributeChecker> MakeTimeChecker (void)
{
  return MakeTimeChecker (Time::Min (), Time::Max ());
}

inline
Ptr<const AttributeChecker> MakeTimeChecker (const Time min)
{
  return MakeTimeChecker (min, Time::Max ());
}

class TimeWithUnit
{
public:
  TimeWithUnit (const Time time, const Time::Unit unit)
    : m_time (time),
      m_unit (unit)
  { };

private:
  Time m_time;        
  Time::Unit m_unit;  

  friend std::ostream & operator << (std::ostream & os, const TimeWithUnit & time);

};  // class TimeWithUnit

} // namespace ns3

#endif /* TIME_H */