data-rate.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
//
// Copyright (c) 2006 Georgia Tech Research Corporation
//
// 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: Rajib Bhattacharjea<raj.b@gatech.edu>
//

#ifndef DATA_RATE_H
#define DATA_RATE_H

#include <string>
#include <iostream>
#include <stdint.h>
#include "ns3/nstime.h"
#include "ns3/attribute.h"
#include "ns3/attribute-helper.h"
#include "ns3/deprecated.h"

namespace ns3 {

class DataRate
{
public:
  DataRate ();
  DataRate (uint64_t bps);
  DataRate (std::string rate);

  bool operator <  (const DataRate& rhs) const;

  bool operator <= (const DataRate& rhs) const;
  
  bool operator >  (const DataRate& rhs) const;
  
  bool operator >= (const DataRate& rhs) const;
  
  bool operator == (const DataRate& rhs) const;
  
  bool operator != (const DataRate& rhs) const;

  Time CalculateBytesTxTime (uint32_t bytes) const;

  Time CalculateBitsTxTime (uint32_t bits) const;

  NS_DEPRECATED
  double CalculateTxTime (uint32_t bytes) const;

  uint64_t GetBitRate () const;

private:

  static bool DoParse (const std::string s, uint64_t *v);

  // Uses DoParse
  friend std::istream &operator >> (std::istream &is, DataRate &rate);
  
  uint64_t m_bps; 
};

std::ostream &operator << (std::ostream &os, const DataRate &rate);

std::istream &operator >> (std::istream &is, DataRate &rate);

ATTRIBUTE_HELPER_HEADER (DataRate);


double operator* (const DataRate& lhs, const Time& rhs);
double operator* (const Time& lhs, const DataRate& rhs);


} // namespace ns3

#endif /* DATA_RATE_H */