nix-vector.h

Go to the documentation of this file.

/*
 * 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 "buffer.h"
 
#include "ns3/ptr.h"
#include "ns3/simple-ref-count.h"
 
namespace ns3
{
 
class NixVector : public SimpleRefCount<NixVector>
{
  public:
    NixVector();
    ~NixVector();
    Ptr<NixVector> Copy() 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() const;
    uint32_t GetSerializedSize() 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;
 
    void SetEpoch(uint32_t epoch);
 
    uint32_t GetEpoch() const;
 
  private:
    typedef std::vector<uint32_t> NixBits_t;
 
    void DumpNixVector(std::ostream& os) const;
 
    friend std::ostream& operator<<(std::ostream& os, const NixVector& nix);
 
    NixBits_t m_nixVector; 
    uint32_t m_used;       
 
    uint32_t m_totalBitSize;
 
    uint32_t m_epoch; 
 
    void PrintDec2BinNix(uint32_t decimalNum, uint32_t bitCount, std::ostream& os) const;
};
} // namespace ns3
 
#endif /* NIX_VECTOR_H */