nix-vector.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2009 The Georgia Institute of Technology 
 *
 * 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
 *
 * Authors: Josh Pelkey <jpelkey@gatech.edu>
 */

#ifndef NIX_VECTOR_H
#define NIX_VECTOR_H

#include "ns3/ptr.h"
#include "ns3/simple-ref-count.h"
#include "ns3/buffer.h"

namespace ns3 {

class NixVector : public SimpleRefCount<NixVector>
{
public:
  NixVector ();
  ~NixVector ();
  Ptr<NixVector> Copy (void) const;
  NixVector (const NixVector &o);
  NixVector &operator = (const NixVector &o);
  void AddNeighborIndex (uint32_t newBits, uint32_t numberOfBits);
  uint32_t ExtractNeighborIndex (uint32_t numberOfBits);
  uint32_t GetRemainingBits (void);
  uint32_t GetSerializedSize (void) const;
  uint32_t Serialize (uint32_t* buffer, uint32_t maxSize) const;
  uint32_t Deserialize (const uint32_t* buffer, uint32_t size);
  uint32_t BitCount (uint32_t numberOfNeighbors) const;


private:
  typedef std::vector<uint32_t> NixBits_t;

  /* for printing of nix-vector */
  void DumpNixVector (std::ostream &os) const;
  /* for printing of nix-vector */
  friend std::ostream & operator << ( std::ostream &outs, const NixVector &nix);

  /* the actual nix-vector */
  NixBits_t m_nixVector;

  /* for tracking where we are
   * in the nix-vector
   */
  uint32_t m_used;

  /* for tracking how many bits we
   * have used in the current vector
   * entry. need this in order to
   * expand the vector passed 32bits
   */
  uint32_t m_currentVectorBitSize;

  /* a counter of how total bits are in
   * the nix-vector
   */
  uint32_t m_totalBitSize;

  /* internal for pretty printing of nix-vector */
  void PrintDec2BinNixFill (uint32_t, uint32_t, std::ostream &os) const;

  /* internal for pretty printing of nix-vector */
  void PrintDec2BinNix (uint32_t, uint32_t, std::ostream &os) const;
};
} // namespace ns3

#endif /* NIX_VECTOR_H */