EMANE::Models::IEEE80211ABG::NeighborEntry Class Reference

Defines a 1 hop nbr and its bandwidth utilization. More...

#include <neighborentry.h>

Public Member Functions
	NeighborEntry ()
void	updateChannelActivity (const Microseconds &utilizationMicroseconds, std::uint8_t type, const TimePoint &activityTime, float fRxPowerMilliWatts, size_t numPackets=1)
void	storeUtilization ()
EMANE::TimePoint	getLastActivityTime () const
Microseconds	getUtilizationMicroseconds (std::uint8_t msgTypeMask) const
size_t	getNumberOfPackets (std::uint8_t msgTypeMask) const
float	getRxPowerMilliWatts (std::uint8_t msgTypeMask) const
float	getEstimatedNumCommonNeighbors () const
void	setEstimatedNumCommonNeighbors (float num)
float	getHiddenChannelActivity () const
void	setHiddenChannelActivity (float fActivity)
void	setAverageHiddenRxPowerMilliWatts (float dAverageHiddenRxPowerMilliWatts)
float	getAverageHiddenRxPowerMilliWatts () const
void	setAverageCommonRxPowerMilliWatts (float dAverageCommonRxPowerMilliWatts)
float	getAverageCommonRxPowerMilliWatts () const
void	setOneHopNeighbors (const NbrSet &nbrs)
void	setHiddenNeighbors (const NbrSet &nbrs)
void	setCommonNeighbors (const NbrSet &nbrs)
const NbrSet &	getOneHopNeighbors () const
const NbrSet &	getCommonNeighbors () const
const NbrSet &	getHiddenNeighbors () const
bool	isOneHopNbr (EMANE::NEMId id) const
bool	isCommonNbr (EMANE::NEMId id) const
bool	isHiddenNbr (EMANE::NEMId id) const

Detailed Description

Defines a 1 hop nbr and its bandwidth utilization.

Definition at line 59 of file neighborentry.h.

Constructor & Destructor Documentation

NeighborEntry()

EMANE::Models::IEEE80211ABG::NeighborEntry::NeighborEntry

(

)

constructor

Definition at line 37 of file neighborentry.cc.

Member Function Documentation

getAverageCommonRxPowerMilliWatts()

float EMANE::Models::IEEE80211ABG::NeighborEntry::getAverageCommonRxPowerMilliWatts

(

)

const

Definition at line 154 of file neighborentry.cc.

getAverageHiddenRxPowerMilliWatts()

float EMANE::Models::IEEE80211ABG::NeighborEntry::getAverageHiddenRxPowerMilliWatts

(

)

const

Definition at line 139 of file neighborentry.cc.

getCommonNeighbors()

const EMANE::Models::IEEE80211ABG::NbrSet & EMANE::Models::IEEE80211ABG::NeighborEntry::getCommonNeighbors

(

)

const

Definition at line 246 of file neighborentry.cc.

getEstimatedNumCommonNeighbors()

float EMANE::Models::IEEE80211ABG::NeighborEntry::getEstimatedNumCommonNeighbors

(

)

const

Definition at line 122 of file neighborentry.cc.

getHiddenChannelActivity()

float EMANE::Models::IEEE80211ABG::NeighborEntry::getHiddenChannelActivity

(

)

const

Definition at line 86 of file neighborentry.cc.

getHiddenNeighbors()

const EMANE::Models::IEEE80211ABG::NbrSet & EMANE::Models::IEEE80211ABG::NeighborEntry::getHiddenNeighbors

(

)

const

Definition at line 253 of file neighborentry.cc.

getLastActivityTime()

EMANE::TimePoint EMANE::Models::IEEE80211ABG::NeighborEntry::getLastActivityTime

(

)

const

Definition at line 58 of file neighborentry.cc.

getNumberOfPackets()

size_t EMANE::Models::IEEE80211ABG::NeighborEntry::getNumberOfPackets

(

std::uint8_t

msgTypeMask

)

const

gets the number of utilization packets

Parameters

msgTypeMask

the msg type (unicast, unicast rts/cts, broadcast)

Returns

the number of utilization packets

Definition at line 102 of file neighborentry.cc.

getOneHopNeighbors()

const EMANE::Models::IEEE80211ABG::NbrSet & EMANE::Models::IEEE80211ABG::NeighborEntry::getOneHopNeighbors

(

)

const

Definition at line 239 of file neighborentry.cc.

getRxPowerMilliWatts()

float EMANE::Models::IEEE80211ABG::NeighborEntry::getRxPowerMilliWatts

(

std::uint8_t

msgTypeMask

)

const

gets the utilization rx power

Parameters

msgTypeMask

the msg type (unicast, unicast rts/cts, broadcast)

Returns

the utilization rx power sum

Definition at line 168 of file neighborentry.cc.

getUtilizationMicroseconds()

EMANE::Microseconds EMANE::Models::IEEE80211ABG::NeighborEntry::getUtilizationMicroseconds

(

std::uint8_t

msgTypeMask

)

const

gets the bandiwdth utilzation (duration) time

Parameters

msgTypeMask

the msg type (unicast, unicast rts/cts, broadcast)

Returns

the bandiwdth utilzation

Definition at line 66 of file neighborentry.cc.

isCommonNbr()

bool EMANE::Models::IEEE80211ABG::NeighborEntry::isCommonNbr

(

EMANE::NEMId

id

)

const

Definition at line 267 of file neighborentry.cc.

isHiddenNbr()

bool EMANE::Models::IEEE80211ABG::NeighborEntry::isHiddenNbr

(

EMANE::NEMId

id

)

const

Definition at line 274 of file neighborentry.cc.

isOneHopNbr()

bool EMANE::Models::IEEE80211ABG::NeighborEntry::isOneHopNbr

(

EMANE::NEMId

id

)

const

Definition at line 260 of file neighborentry.cc.

setAverageCommonRxPowerMilliWatts()

void EMANE::Models::IEEE80211ABG::NeighborEntry::setAverageCommonRxPowerMilliWatts

(

float

dAverageCommonRxPowerMilliWatts

)

Definition at line 161 of file neighborentry.cc.

setAverageHiddenRxPowerMilliWatts()

void EMANE::Models::IEEE80211ABG::NeighborEntry::setAverageHiddenRxPowerMilliWatts

(

float

dAverageHiddenRxPowerMilliWatts

)

Definition at line 147 of file neighborentry.cc.

setCommonNeighbors()

void EMANE::Models::IEEE80211ABG::NeighborEntry::setCommonNeighbors

(

const NbrSet &

nbrs

)

Definition at line 231 of file neighborentry.cc.

setEstimatedNumCommonNeighbors()

void EMANE::Models::IEEE80211ABG::NeighborEntry::setEstimatedNumCommonNeighbors

(

float

num

)

Definition at line 131 of file neighborentry.cc.

setHiddenChannelActivity()

void EMANE::Models::IEEE80211ABG::NeighborEntry::setHiddenChannelActivity

(

float

fActivity

)

Definition at line 94 of file neighborentry.cc.

setHiddenNeighbors()

void EMANE::Models::IEEE80211ABG::NeighborEntry::setHiddenNeighbors

(

const NbrSet &

nbrs

)

Definition at line 223 of file neighborentry.cc.

setOneHopNeighbors()

void EMANE::Models::IEEE80211ABG::NeighborEntry::setOneHopNeighbors

(

const NbrSet &

nbrs

)

Definition at line 215 of file neighborentry.cc.

storeUtilization()

void EMANE::Models::IEEE80211ABG::NeighborEntry::storeUtilization

(

)

stores previous and resets the current bandwidth utilization parameter(s)

Definition at line 187 of file neighborentry.cc.

updateChannelActivity()

void EMANE::Models::IEEE80211ABG::NeighborEntry::updateChannelActivity	(	const Microseconds &	utilizationMicroseconds,
		std::uint8_t	type,
		const TimePoint &	activityTime,
		float	fRxPowerMilliWatts,
		size_t	numPackets = 1
	)

updates the bandwidth utilization parameters

Parameters

utilizationMicroseconds	the bandwidth (duration) of channel activity
type	the msg type (unicast, unicast rts/cts, broadcast)
activityTime	the absolute time that the activity
fRxPowerMilliWatts	the rx power in milliwatts
numPackets	the number of packets associated with the activity default is 1

Definition at line 201 of file neighborentry.cc.

---

The documentation for this class was generated from the following files:

• neighborentry.h
• neighborentry.cc