A Discrete-Event Network Simulator
API
nix-vector.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2009 The Georgia Institute of Technology
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation;
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program; if not, write to the Free Software
15 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16 *
17 * Authors: Josh Pelkey <jpelkey@gatech.edu>
18 */
19
20#ifndef NIX_VECTOR_H
21#define NIX_VECTOR_H
22
23#include "ns3/buffer.h"
24#include "ns3/ptr.h"
25#include "ns3/simple-ref-count.h"
26
27namespace ns3
28{
29
63class NixVector : public SimpleRefCount<NixVector>
64{
65 public:
66 NixVector();
67 ~NixVector();
71 Ptr<NixVector> Copy() const;
76 NixVector(const NixVector& o);
83 NixVector& operator=(const NixVector& o);
96 void AddNeighborIndex(uint32_t newBits, uint32_t numberOfBits);
130 uint32_t Serialize(uint32_t* buffer, uint32_t maxSize) const;
141 uint32_t Deserialize(const uint32_t* buffer, uint32_t size);
151 uint32_t BitCount(uint32_t numberOfNeighbors) const;
152
157 void SetEpoch(uint32_t epoch);
158
163 uint32_t GetEpoch() const;
164
165 private:
167 typedef std::vector<uint32_t> NixBits_t;
168
176 void DumpNixVector(std::ostream& os) const;
177
185 friend std::ostream& operator<<(std::ostream& os, const NixVector& nix);
186
189
195
197
204 void PrintDec2BinNix(uint32_t decimalNum, uint32_t bitCount, std::ostream& os) const;
205};
206} // namespace ns3
207
208#endif /* NIX_VECTOR_H */
Neighbor-index data structure for nix-vector routing.
Definition: nix-vector.h:64
friend std::ostream & operator<<(std::ostream &os, const NixVector &nix)
Stream insertion operator.
Definition: nix-vector.cc:80
void AddNeighborIndex(uint32_t newBits, uint32_t numberOfBits)
Definition: nix-vector.cc:88
uint32_t m_used
For tracking where we are in the nix-vector.
Definition: nix-vector.h:188
uint32_t GetSerializedSize() const
Definition: nix-vector.cc:199
uint32_t m_epoch
Epoch of the Nix-vector creation.
Definition: nix-vector.h:196
uint32_t GetRemainingBits() const
Definition: nix-vector.cc:323
NixVector & operator=(const NixVector &o)
Definition: nix-vector.cc:55
uint32_t m_totalBitSize
A counter of how total bits are in the nix-vector.
Definition: nix-vector.h:194
uint32_t Serialize(uint32_t *buffer, uint32_t maxSize) const
Definition: nix-vector.cc:213
std::vector< uint32_t > NixBits_t
Typedef: the NixVector bits storage.
Definition: nix-vector.h:167
uint32_t ExtractNeighborIndex(uint32_t numberOfBits)
Definition: nix-vector.cc:144
NixBits_t m_nixVector
the actual nix-vector
Definition: nix-vector.h:187
void SetEpoch(uint32_t epoch)
Set the NixVector Epoch.
Definition: nix-vector.cc:381
void DumpNixVector(std::ostream &os) const
Print the NixVector.
Definition: nix-vector.cc:289
uint32_t Deserialize(const uint32_t *buffer, uint32_t size)
Definition: nix-vector.cc:239
Ptr< NixVector > Copy() const
Definition: nix-vector.cc:69
uint32_t BitCount(uint32_t numberOfNeighbors) const
Definition: nix-vector.cc:331
void PrintDec2BinNix(uint32_t decimalNum, uint32_t bitCount, std::ostream &os) const
Internal for pretty printing of nix-vector (no fill)
Definition: nix-vector.cc:354
uint32_t GetEpoch() const
Get the NixVector Epoch.
Definition: nix-vector.cc:387
A template-based reference counting class.
Every class exported by the ns3 library is enclosed in the ns3 namespace.