ns3::AnimPacketInfo Class Reference

AnimPacketInfo helper class. More...

#include <animation-interface-helper.h>

Collaboration diagram for ns3::AnimPacketInfo:

Public Member Functions
	AnimPacketInfo ()
	Default constructor. More...
	AnimPacketInfo (Ptr< const NetDevice > tx_nd, const Time &fbTx, const Time &lbTx, Vector txLoc, uint32_t txNodeId=0)
	Constructor. More...
AnimRxInfo	GetRxInfo (Ptr< const NetDevice > nd)
	GetRxInfo. More...
void	ProcessRxBegin (Ptr< const NetDevice > nd, const Time &fbRx)
	Process RxBegin notifications. More...
void	ProcessRxDrop (Ptr< const NetDevice > nd)
	Process RxDrop notifications. More...
bool	ProcessRxEnd (Ptr< const NetDevice > nd, const Time &fbRx, Vector rxLoc)
	Process RxEnd notifications. More...
void	RemoveRxInfo (Ptr< const NetDevice > nd)
	RemoveRxInfo. More...

Public Attributes
double	firstlastbitDelta
	Time delta between First bit Rx and Last bit Rx. More...
double	m_fbTx
	First bit transmission time. More...
double	m_lbTx
	Last bit transmission time. More...
std::map< uint32_t, AnimRxInfo >	m_rx
	Collection of receivers. More...
Vector	m_txLoc
	Transmitter's location. More...
Ptr< const NetDevice >	m_txnd
	Ptr to NetDevice that is transmitting. More...
uint32_t	m_txNodeId
	Tx Node Id if NetDevice is unknown. More...

Detailed Description

AnimPacketInfo helper class.

This helper class keeps of wireless packets transmitted and received including info about the last bit transmit time, first bit transmit time, location of the transmitter and NetDevice transmited on It is intended only for use by the AnimationInterface class.

Definition at line 128 of file animation-interface-helper.h.

Constructor & Destructor Documentation

ns3::AnimPacketInfo::AnimPacketInfo

(

)

Default constructor.

Definition at line 29 of file animation-interface-helper.cc.

ns3::AnimPacketInfo::AnimPacketInfo	(	Ptr< const NetDevice >	tx_nd,
		const Time &	fbTx,
		const Time &	lbTx,
		Vector	txLoc,
		uint32_t	txNodeId = 0
	)

Constructor.

Parameters

tx_nd	Ptr to NetDevice that is transmitting
fbTx	First bit transmit time
lbTx	Last bit transmit time
txLoc	Transmitter Location
txNodeId	Tx Node Id if NetDevice is unknown

Definition at line 35 of file animation-interface-helper.cc.

References m_txnd, and m_txNodeId.

Member Function Documentation

AnimRxInfo ns3::AnimPacketInfo::GetRxInfo

(

Ptr< const NetDevice >

nd

)

GetRxInfo.

Parameters

nd	Ptr to NetDevice where packet was received

Returns

AnimRxInfo object

Definition at line 70 of file animation-interface-helper.cc.

References m_rx, and NS_ASSERT.

Referenced by ns3::AnimationInterface::CsmaMacRxTrace(), ns3::AnimationInterface::CsmaPhyRxEndTrace(), ns3::AnimationInterface::LteRxTrace(), ns3::AnimationInterface::LteSpectrumPhyRxStart(), ns3::AnimationInterface::WifiMacRxTrace(), ns3::AnimationInterface::WifiPhyRxEndTrace(), and ns3::AnimationInterface::WimaxRxTrace().

Here is the caller graph for this function:

void ns3::AnimPacketInfo::ProcessRxBegin	(	Ptr< const NetDevice >	nd,
		const Time &	fbRx
	)

Process RxBegin notifications.

Parameters

nd	Ptr to NetDevice where packet was received
fbRx	First bit receive time

Definition at line 44 of file animation-interface-helper.cc.

References m_rx.

Referenced by ns3::AnimationInterface::LteRxTrace(), ns3::AnimationInterface::LteSpectrumPhyRxStart(), and ns3::AnimationInterface::WimaxRxTrace().

Here is the caller graph for this function:

void ns3::AnimPacketInfo::ProcessRxDrop

(

Ptr< const NetDevice >

nd

)

Process RxDrop notifications.

Parameters

nd	Ptr to NetDevice where packet was dropped on reception

Definition at line 83 of file animation-interface-helper.cc.

bool ns3::AnimPacketInfo::ProcessRxEnd	(	Ptr< const NetDevice >	nd,
		const Time &	fbRx,
		Vector	rxLoc
	)

Process RxEnd notifications.

Parameters

nd	Ptr to NetDevice where packet was received
fbRx	First bit receive time
rxLoc	Location of receiver

Returns

true if RxEnd notification was expected and processed

Definition at line 49 of file animation-interface-helper.cc.

References ns3::CalculateDistance(), firstlastbitDelta, ns3::Time::GetSeconds(), ns3::AnimRxInfo::m_fbRx, ns3::AnimRxInfo::m_lbRx, m_rx, ns3::AnimRxInfo::m_rxnd, m_txLoc, ns3::AnimRxInfo::rxRange, and ns3::AnimRxInfo::SetPhyRxComplete().

Referenced by ns3::AnimationInterface::CsmaPhyRxEndTrace(), ns3::AnimationInterface::LteRxTrace(), ns3::AnimationInterface::LteSpectrumPhyRxStart(), ns3::AnimationInterface::WifiPhyRxEndTrace(), and ns3::AnimationInterface::WimaxRxTrace().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::AnimPacketInfo::RemoveRxInfo

(

Ptr< const NetDevice >

nd

)

RemoveRxInfo.

Parameters

nd	Ptr to NetDevice where packet was received

Definition at line 77 of file animation-interface-helper.cc.

References m_rx.

Member Data Documentation

double ns3::AnimPacketInfo::firstlastbitDelta

Time delta between First bit Rx and Last bit Rx.

Parameters

firstlastbitDelta

Time delta between First bit Rx and Last bit Rx

Definition at line 237 of file animation-interface-helper.h.

Referenced by ns3::AnimationInterface::OutputWirelessPacket(), and ProcessRxEnd().

double ns3::AnimPacketInfo::m_fbTx

First bit transmission time.

Parameters

m_fbTx

First bit transmission time

Definition at line 169 of file animation-interface-helper.h.

Referenced by ns3::AnimationInterface::OutputCsmaPacket(), ns3::AnimationInterface::OutputWirelessPacket(), ns3::AnimationInterface::PurgePendingCsma(), ns3::AnimationInterface::PurgePendingLte(), ns3::AnimationInterface::PurgePendingWifi(), and ns3::AnimationInterface::PurgePendingWimax().

double ns3::AnimPacketInfo::m_lbTx

Last bit transmission time.

Parameters

m_lbTx

Last bit transmission time

Definition at line 176 of file animation-interface-helper.h.

Referenced by ns3::AnimationInterface::CsmaPhyTxEndTrace(), and ns3::AnimationInterface::OutputCsmaPacket().

std::map<uint32_t,AnimRxInfo> ns3::AnimPacketInfo::m_rx

Collection of receivers.

Parameters

m_rx	Collection of receivers

Definition at line 191 of file animation-interface-helper.h.

Referenced by GetRxInfo(), ProcessRxBegin(), ProcessRxEnd(), and RemoveRxInfo().

Vector ns3::AnimPacketInfo::m_txLoc

Transmitter's location.

Parameters

m_txLoc

Transmitter's Location

Definition at line 183 of file animation-interface-helper.h.

Referenced by ProcessRxEnd().

Ptr<const NetDevice> ns3::AnimPacketInfo::m_txnd

Ptr to NetDevice that is transmitting.

Parameters

m_txnd

NetDevice that is transmitting

Definition at line 155 of file animation-interface-helper.h.

Referenced by ns3::AnimationInterface::AddPendingCsmaPacket(), ns3::AnimationInterface::AddPendingLtePacket(), ns3::AnimationInterface::AddPendingWimaxPacket(), AnimPacketInfo(), ns3::AnimationInterface::OutputCsmaPacket(), and ns3::AnimationInterface::OutputWirelessPacket().

uint32_t ns3::AnimPacketInfo::m_txNodeId

Tx Node Id if NetDevice is unknown.

Parameters

m_txNodeId

Tx Node Id if NetDevice is unknown

Definition at line 162 of file animation-interface-helper.h.

Referenced by AnimPacketInfo(), and ns3::AnimationInterface::OutputWirelessPacket().

---

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

• src/netanim/helper/animation-interface-helper.h
• src/netanim/helper/animation-interface-helper.cc