A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::AnimRxInfo Class Reference

AnimRxInfo helper class. More...

#include <animation-interface-helper.h>

+ Collaboration diagram for ns3::AnimRxInfo:

Public Member Functions

 AnimRxInfo ()
 Default constructor. More...
 
 AnimRxInfo (const Time &fbRx, Ptr< const NetDevice > nd, double rxRange)
 Constructor. More...
 
bool IsPhyRxComplete ()
 Check if Wifi Phy Rx is Complete. More...
 
void SetPhyRxComplete ()
 Set Wifi Phy Rx Complete. More...
 

Public Attributes

double m_fbRx
 First bit receive time. More...
 
double m_lbRx
 Last bit receive time. More...
 
Ptr< const NetDevicem_rxnd
 Ptr to receiving NetDevice. More...
 
double rxRange
 Reception range. More...
 

Private Attributes

bool m_PhyRxComplete
 

Detailed Description

AnimRxInfo helper class.

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

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

Constructor & Destructor Documentation

ns3::AnimRxInfo::AnimRxInfo ( )
inline

Default constructor.

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

ns3::AnimRxInfo::AnimRxInfo ( const Time fbRx,
Ptr< const NetDevice nd,
double  rxRange 
)
inline

Constructor.

Parameters
fbRxFirst-bit Receive time
ndNetDevice where packet was received
rxRangeReception range

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

Member Function Documentation

bool ns3::AnimRxInfo::IsPhyRxComplete ( )

Check if Wifi Phy Rx is Complete.

Returns
true if Wifi Phy Rx is complete

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

References m_PhyRxComplete.

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

+ Here is the caller graph for this function:

void ns3::AnimRxInfo::SetPhyRxComplete ( )

Set Wifi Phy Rx Complete.

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

References m_PhyRxComplete.

Referenced by ns3::AnimPacketInfo::ProcessRxEnd().

+ Here is the caller graph for this function:

Member Data Documentation

double ns3::AnimRxInfo::m_fbRx

First bit receive time.

Parameters
m_fbRxFirst bit receive time

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

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

double ns3::AnimRxInfo::m_lbRx

Last bit receive time.

Parameters
m_lbRxLast bit receive time

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

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

bool ns3::AnimRxInfo::m_PhyRxComplete
private

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

Referenced by IsPhyRxComplete(), and SetPhyRxComplete().

Ptr<const NetDevice> ns3::AnimRxInfo::m_rxnd
double ns3::AnimRxInfo::rxRange

Reception range.

Parameters
rxRangeReception range

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

Referenced by ns3::AnimPacketInfo::ProcessRxEnd().


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