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

Signal event for a packet. More...

#include <interference-helper.h>

+ Inheritance diagram for ns3::InterferenceHelper::Event:
+ Collaboration diagram for ns3::InterferenceHelper::Event:

Public Member Functions

 Event (uint32_t size, WifiMode payloadMode, enum WifiPreamble preamble, Time duration, double rxPower, WifiTxVector txvector)
 Create an Event with the given parameters. More...
 
 ~Event ()
 
Time GetDuration (void) const
 Return the duration of the signal. More...
 
Time GetEndTime (void) const
 Return the end time of the signal. More...
 
WifiMode GetPayloadMode (void) const
 Return the Wi-Fi mode used for the payload. More...
 
enum WifiPreamble GetPreambleType (void) const
 Return the preamble type of the packet. More...
 
double GetRxPowerW (void) const
 Return the receive power (w). More...
 
uint32_t GetSize (void) const
 Return the size of the packet (bytes). More...
 
Time GetStartTime (void) const
 Return the start time of the signal. More...
 
WifiTxVector GetTxVector (void) const
 Return the TXVECTOR of the packet. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< InterferenceHelper::Event >
 SimpleRefCount ()
 Constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 

Private Attributes

Time m_endTime
 
WifiMode m_payloadMode
 
enum WifiPreamble m_preamble
 
double m_rxPowerW
 
uint32_t m_size
 
Time m_startTime
 
WifiTxVector m_txVector
 

Additional Inherited Members

- Static Public Member Functions inherited from ns3::SimpleRefCount< InterferenceHelper::Event >
static void Cleanup (void)
 Noop. More...
 

Detailed Description

Signal event for a packet.

Definition at line 47 of file interference-helper.h.

Constructor & Destructor Documentation

ns3::InterferenceHelper::Event::Event ( uint32_t  size,
WifiMode  payloadMode,
enum WifiPreamble  preamble,
Time  duration,
double  rxPower,
WifiTxVector  txvector 
)

Create an Event with the given parameters.

Parameters
sizepacket size
payloadModeWi-Fi mode used for the payload
preamblepreamble type
durationduration of the signal
rxPowerthe receive power (w)
txvectorTXVECTOR of the packet

Definition at line 35 of file interference-helper.cc.

ns3::InterferenceHelper::Event::~Event ( )

Definition at line 47 of file interference-helper.cc.

Member Function Documentation

Time ns3::InterferenceHelper::Event::GetDuration ( void  ) const

Return the duration of the signal.

Returns
the duration of the signal

Definition at line 52 of file interference-helper.cc.

Time ns3::InterferenceHelper::Event::GetEndTime ( void  ) const

Return the end time of the signal.

Returns
the end time of the signal

Definition at line 62 of file interference-helper.cc.

WifiMode ns3::InterferenceHelper::Event::GetPayloadMode ( void  ) const

Return the Wi-Fi mode used for the payload.

Returns
the Wi-Fi mode used for the payload

Definition at line 77 of file interference-helper.cc.

enum WifiPreamble ns3::InterferenceHelper::Event::GetPreambleType ( void  ) const

Return the preamble type of the packet.

Returns
the preamble type of the packet

Definition at line 82 of file interference-helper.cc.

double ns3::InterferenceHelper::Event::GetRxPowerW ( void  ) const

Return the receive power (w).

Returns
the receive power (w)

Definition at line 67 of file interference-helper.cc.

uint32_t ns3::InterferenceHelper::Event::GetSize ( void  ) const

Return the size of the packet (bytes).

Returns
the size of the packet (bytes)

Definition at line 72 of file interference-helper.cc.

Time ns3::InterferenceHelper::Event::GetStartTime ( void  ) const

Return the start time of the signal.

Returns
the start time of the signal

Definition at line 57 of file interference-helper.cc.

WifiTxVector ns3::InterferenceHelper::Event::GetTxVector ( void  ) const

Return the TXVECTOR of the packet.

Returns
the TXVECTOR of the packet

Definition at line 88 of file interference-helper.cc.

Member Data Documentation

Time ns3::InterferenceHelper::Event::m_endTime
private

Definition at line 118 of file interference-helper.h.

WifiMode ns3::InterferenceHelper::Event::m_payloadMode
private

Definition at line 115 of file interference-helper.h.

enum WifiPreamble ns3::InterferenceHelper::Event::m_preamble
private

Definition at line 116 of file interference-helper.h.

double ns3::InterferenceHelper::Event::m_rxPowerW
private

Definition at line 119 of file interference-helper.h.

uint32_t ns3::InterferenceHelper::Event::m_size
private

Definition at line 114 of file interference-helper.h.

Time ns3::InterferenceHelper::Event::m_startTime
private

Definition at line 117 of file interference-helper.h.

WifiTxVector ns3::InterferenceHelper::Event::m_txVector
private

Definition at line 120 of file interference-helper.h.


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