queue-size.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
//
// Copyright (c) 2018 Universita' degli Studi di Napoli Federico II
//
// 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: Stefano Avallone <stavallo@unina.it>
//

#ifndef QUEUE_SIZE_H
#define QUEUE_SIZE_H

#include <string>
#include <iostream>
#include "ns3/attribute.h"
#include "ns3/attribute-helper.h"
#include "ns3/abort.h"

namespace ns3 {

enum QueueSizeUnit
{
  PACKETS,     
  BYTES,       
};

class QueueSize
{
public:
  QueueSize ();
  QueueSize (QueueSizeUnit unit, uint32_t value);
  QueueSize (std::string size);

  bool operator <  (const QueueSize& rhs) const;

  bool operator <= (const QueueSize& rhs) const;

  bool operator >  (const QueueSize& rhs) const;

  bool operator >= (const QueueSize& rhs) const;

  bool operator == (const QueueSize& rhs) const;

  bool operator != (const QueueSize& rhs) const;

  QueueSizeUnit GetUnit () const;

  uint32_t GetValue () const;

private:

  static bool DoParse (const std::string s, QueueSizeUnit *unit, uint32_t *value);

  // Uses DoParse
  friend std::istream &operator >> (std::istream &is, QueueSize &size);

  QueueSizeUnit m_unit; 
  uint32_t m_value;     
};

std::ostream &operator << (std::ostream &os, const QueueSize &size);

std::istream &operator >> (std::istream &is, QueueSize &size);

ATTRIBUTE_HELPER_HEADER (QueueSize);


template <typename Item>
QueueSize operator+ (const QueueSize& lhs, const Ptr<Item>& rhs);
template <typename Item>
QueueSize operator+ (const Ptr<Item>& lhs, const QueueSize& rhs);


template <typename Item>
QueueSize operator+ (const QueueSize& lhs, const Ptr<Item>& rhs)
{
  if (lhs.GetUnit () == QueueSizeUnit::PACKETS)
    {
      return QueueSize (lhs.GetUnit (), lhs.GetValue () + 1);
    }
  if (lhs.GetUnit () == QueueSizeUnit::BYTES)
    {
      return QueueSize (lhs.GetUnit (), lhs.GetValue () + rhs->GetSize ());
    }
  NS_FATAL_ERROR ("Unknown queue size mode");
}

template <typename Item>
QueueSize operator+ (const Ptr<Item>& lhs, const QueueSize& rhs)
{
  if (rhs.GetUnit () == QueueSizeUnit::PACKETS)
    {
      return QueueSize (rhs.GetUnit (), rhs.GetValue () + 1);
    }
  if (rhs.GetUnit () == QueueSizeUnit::BYTES)
    {
      return QueueSize (rhs.GetUnit (), rhs.GetValue () + lhs->GetSize ());
    }
  NS_FATAL_ERROR ("Unknown queue size mode");
}


} // namespace ns3

#endif /* QUEUE_SIZE_H */