ns-3
ns3::AthstatsWifiTraceSink Class Reference

trace sink for wifi device that mimics madwifi's athstats tool. More...

#include <athstats-helper.h>

Inheritance diagram for ns3::AthstatsWifiTraceSink:
Collaboration diagram for ns3::AthstatsWifiTraceSink:

List of all members.

Public Member Functions

void DevTxTrace (std::string context, Ptr< const Packet > p)
void DevRxTrace (std::string context, Ptr< const Packet > p)
void TxRtsFailedTrace (std::string context, Mac48Address address)
void TxDataFailedTrace (std::string context, Mac48Address address)
void TxFinalRtsFailedTrace (std::string context, Mac48Address address)
void TxFinalDataFailedTrace (std::string context, Mac48Address address)
void PhyRxOkTrace (std::string context, Ptr< const Packet > packet, double snr, WifiMode mode, enum WifiPreamble preamble)
void PhyRxErrorTrace (std::string context, Ptr< const Packet > packet, double snr)
void PhyTxTrace (std::string context, Ptr< const Packet > packet, WifiMode mode, WifiPreamble preamble, uint8_t txPower)
void PhyStateTrace (std::string context, Time start, Time duration, enum WifiPhy::State state)
void Open (std::string const &name)

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::AthstatsWifiTraceSink.

Detailed Description

trace sink for wifi device that mimics madwifi's athstats tool.

The AthstatsWifiTraceSink class is a trace sink to be connected to several of the traces available within a wifi device. The purpose of AthstatsWifiTraceSink is to mimic the behavior of the athstats tool distributed wih the madwifi driver. In particular, the reproduced behavior is that obtained when executing athstats without parameters: a report written in text format is produced every fixed interval, based on the events observed by the wifi device.

Differences with the "real" athstats:


Member Function Documentation

void ns3::AthstatsWifiTraceSink::DevRxTrace ( std::string  context,
Ptr< const Packet p 
)

function to be called when the net device receives a packet

Parameters:
context
pthe packet being received

References NS_LOG_FUNCTION.

void ns3::AthstatsWifiTraceSink::DevTxTrace ( std::string  context,
Ptr< const Packet p 
)

function to be called when the net device transmits a packet

Parameters:
context
pthe packet being transmitted

References NS_LOG_FUNCTION.

This method returns the TypeId associated to ns3::AthstatsWifiTraceSink.

This object is accessible through the following paths with Config::Set and Config::Connect:

  • /NodeList/[i]/DeviceList/[i]/$ns3::AlohaNoackNetDevice/Phy/$ns3::AthstatsWifiTraceSink
  • /NodeList/[i]/DeviceList/[i]/$ns3::NonCommunicatingNetDevice/Phy/$ns3::AthstatsWifiTraceSink

Attributes defined for this type:

  • Interval: Time interval between reports
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +1000000000.0ns
    • Flags: construct write read

No TraceSources defined for this type.

Reimplemented from ns3::Object.

References ns3::Seconds(), and ns3::TypeId::SetParent().

void ns3::AthstatsWifiTraceSink::Open ( std::string const &  name)

Open a file for output

Parameters:
namethe name of the file to be opened.

References NS_ABORT_MSG_IF, NS_ABORT_MSG_UNLESS, NS_ASSERT_MSG, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

void ns3::AthstatsWifiTraceSink::PhyRxErrorTrace ( std::string  context,
Ptr< const Packet packet,
double  snr 
)

Function to be called when a frame reception by the PHY layer of the considered device resulted in an error due to a failure in the CRC check of the frame

Parameters:
context
packet
snr

References NS_LOG_FUNCTION.

void ns3::AthstatsWifiTraceSink::PhyRxOkTrace ( std::string  context,
Ptr< const Packet packet,
double  snr,
WifiMode  mode,
enum WifiPreamble  preamble 
)

Function to be called when the PHY layer of the considered device receives a frame

Parameters:
context
packet
snr
mode
preamble

References NS_LOG_FUNCTION.

void ns3::AthstatsWifiTraceSink::PhyStateTrace ( std::string  context,
Time  start,
Time  duration,
enum WifiPhy::State  state 
)

Function to be called when the PHY layer of the considered device changes state

Parameters:
context
start
duration
state

References NS_LOG_FUNCTION.

void ns3::AthstatsWifiTraceSink::PhyTxTrace ( std::string  context,
Ptr< const Packet packet,
WifiMode  mode,
WifiPreamble  preamble,
uint8_t  txPower 
)

Function to be called when a frame is being transmitted by the PHY layer of the considered device

Parameters:
context
packet
mode
preamble
txPower

References NS_LOG_FUNCTION.

void ns3::AthstatsWifiTraceSink::TxDataFailedTrace ( std::string  context,
Mac48Address  address 
)

Function to be called when a data frame transmission by the considered device has failed

Parameters:
context
addressthe MAC address of the remote station

References NS_LOG_FUNCTION.

void ns3::AthstatsWifiTraceSink::TxFinalDataFailedTrace ( std::string  context,
Mac48Address  address 
)

Function to be called when the transmission of a data frame has exceeded the retry limit

Parameters:
context
addressthe MAC address of the remote station

References NS_LOG_FUNCTION.

void ns3::AthstatsWifiTraceSink::TxFinalRtsFailedTrace ( std::string  context,
Mac48Address  address 
)

Function to be called when the transmission of a RTS frame has exceeded the retry limit

Parameters:
context
addressthe MAC address of the remote station

References NS_LOG_FUNCTION.

void ns3::AthstatsWifiTraceSink::TxRtsFailedTrace ( std::string  context,
Mac48Address  address 
)

Function to be called when a RTS frame transmission by the considered device has failed

Parameters:
context
addressthe MAC address of the remote station

References NS_LOG_FUNCTION.


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