A Discrete-Event Network Simulator
Home
Tutorials ▼
English
Documentation ▼
Manual
Models
Contributing
Wiki
Development ▼
API Docs
Issue Tracker
Merge Requests
API
nix-vector.h
Go to the documentation of this file.
1
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2
/*
3
* Copyright (c) 2009 The Georgia Institute of Technology
4
*
5
* This program is free software; you can redistribute it and/or modify
6
* it under the terms of the GNU General Public License version 2 as
7
* published by the Free Software Foundation;
8
*
9
* This program is distributed in the hope that it will be useful,
10
* but WITHOUT ANY WARRANTY; without even the implied warranty of
11
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
* GNU General Public License for more details.
13
*
14
* You should have received a copy of the GNU General Public License
15
* along with this program; if not, write to the Free Software
16
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
*
18
* Authors: Josh Pelkey <jpelkey@gatech.edu>
19
*/
20
21
#ifndef NIX_VECTOR_H
22
#define NIX_VECTOR_H
23
24
#include "ns3/ptr.h"
25
#include "ns3/simple-ref-count.h"
26
#include "ns3/buffer.h"
27
28
namespace
ns3
{
29
63
class
NixVector
:
public
SimpleRefCount
<NixVector>
64
{
65
public
:
66
NixVector
();
67
~NixVector
();
71
Ptr<NixVector>
Copy
(
void
)
const
;
76
NixVector
(
const
NixVector
&o);
83
NixVector
&
operator =
(
const
NixVector
&o);
96
void
AddNeighborIndex
(
uint32_t
newBits,
uint32_t
numberOfBits);
110
uint32_t
ExtractNeighborIndex
(
uint32_t
numberOfBits);
115
uint32_t
GetRemainingBits
(
void
)
const
;
119
uint32_t
GetSerializedSize
(
void
)
const
;
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
187
NixBits_t
m_nixVector
;
188
uint32_t
m_used
;
189
194
uint32_t
m_totalBitSize
;
195
196
uint32_t
m_epoch
;
197
204
void
PrintDec2BinNix
(
uint32_t
decimalNum,
uint32_t
bitCount, std::ostream &os)
const
;
205
};
206
}
// namespace ns3
207
208
#endif
/* NIX_VECTOR_H */
ns3::NixVector
Neighbor-index data structure for nix-vector routing.
Definition:
nix-vector.h:64
ns3::NixVector::operator<<
friend std::ostream & operator<<(std::ostream &os, const NixVector &nix)
Stream insertion operator.
Definition:
nix-vector.cc:79
ns3::NixVector::AddNeighborIndex
void AddNeighborIndex(uint32_t newBits, uint32_t numberOfBits)
Definition:
nix-vector.cc:87
ns3::NixVector::Copy
Ptr< NixVector > Copy(void) const
Definition:
nix-vector.cc:69
ns3::NixVector::m_used
uint32_t m_used
For tracking where we are in the nix-vector.
Definition:
nix-vector.h:188
ns3::NixVector::~NixVector
~NixVector()
Definition:
nix-vector.cc:41
ns3::NixVector::m_epoch
uint32_t m_epoch
Epoch of the Nix-vector creation.
Definition:
nix-vector.h:196
ns3::NixVector::NixVector
NixVector()
Definition:
nix-vector.cc:32
ns3::NixVector::GetRemainingBits
uint32_t GetRemainingBits(void) const
Definition:
nix-vector.cc:321
ns3::NixVector::operator=
NixVector & operator=(const NixVector &o)
Definition:
nix-vector.cc:55
ns3::NixVector::m_totalBitSize
uint32_t m_totalBitSize
A counter of how total bits are in the nix-vector.
Definition:
nix-vector.h:194
ns3::NixVector::GetSerializedSize
uint32_t GetSerializedSize(void) const
Definition:
nix-vector.cc:197
ns3::NixVector::Serialize
uint32_t Serialize(uint32_t *buffer, uint32_t maxSize) const
Definition:
nix-vector.cc:211
ns3::NixVector::NixBits_t
std::vector< uint32_t > NixBits_t
Typedef: the NixVector bits storage.
Definition:
nix-vector.h:167
ns3::NixVector::ExtractNeighborIndex
uint32_t ExtractNeighborIndex(uint32_t numberOfBits)
Definition:
nix-vector.cc:143
ns3::NixVector::m_nixVector
NixBits_t m_nixVector
the actual nix-vector
Definition:
nix-vector.h:187
ns3::NixVector::SetEpoch
void SetEpoch(uint32_t epoch)
Set the NixVector Epoch.
Definition:
nix-vector.cc:379
ns3::NixVector::DumpNixVector
void DumpNixVector(std::ostream &os) const
Print the NixVector.
Definition:
nix-vector.cc:287
ns3::NixVector::Deserialize
uint32_t Deserialize(const uint32_t *buffer, uint32_t size)
Definition:
nix-vector.cc:237
ns3::NixVector::BitCount
uint32_t BitCount(uint32_t numberOfNeighbors) const
Definition:
nix-vector.cc:329
ns3::NixVector::PrintDec2BinNix
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:352
ns3::NixVector::GetEpoch
uint32_t GetEpoch() const
Get the NixVector Epoch.
Definition:
nix-vector.cc:385
ns3::Ptr< NixVector >
ns3::SimpleRefCount
A template-based reference counting class.
Definition:
simple-ref-count.h:73
uint32_t
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
src
network
model
nix-vector.h
Generated on Sun May 1 2022 12:01:39 for ns-3 by
1.9.3