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:

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:

AthstatsWifiTraceSink is expected to write its output to a file (not to stdout).

only a subset of the metrics supported by athstats is supported by AthstatsWifiTraceSink

AthstatsWifiTraceSink does never produce a cumulative report.

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
	p	the packet being received

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

function to be called when the net device transmits a packet

Parameters:

	context
	p	the packet being transmitted

static TypeId ns3::AthstatsWifiTraceSink::GetTypeId ( void ) [static]

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::BaseStationNetDevice/BsIpcsPacketClassifier/$ns3::AthstatsWifiTraceSink
/NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/LinkManager/$ns3::AthstatsWifiTraceSink
/NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/SSManager/$ns3::AthstatsWifiTraceSink
/NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/ServiceFlowManager/$ns3::AthstatsWifiTraceSink
/NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/Classifier/$ns3::AthstatsWifiTraceSink
/NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/LinkManager/$ns3::AthstatsWifiTraceSink
/NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/SSScheduler/$ns3::AthstatsWifiTraceSink
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier/$ns3::AthstatsWifiTraceSink
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/LinkManager/$ns3::AthstatsWifiTraceSink
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/SSManager/$ns3::AthstatsWifiTraceSink
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/ServiceFlowManager/$ns3::AthstatsWifiTraceSink
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/Classifier/$ns3::AthstatsWifiTraceSink
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/LinkManager/$ns3::AthstatsWifiTraceSink
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/SSScheduler/$ns3::AthstatsWifiTraceSink
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BandwidthManager/$ns3::AthstatsWifiTraceSink
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BurstProfileManager/$ns3::AthstatsWifiTraceSink
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/ConnectionManager/$ns3::AthstatsWifiTraceSink

Attributes defined for this type:

Interval: Time interval between reports
- Set with class: TimeValue
- Underlying type: Time
- Initial value: 1000000000ns
- Flags: construct write read

No TraceSources defined for this type.

Reimplemented from ns3::Object.

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

Open a file for output

Parameters:

name

the name of the file to be opened.

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

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

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

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

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
	address	the MAC address of the remote station

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
	address	the MAC address of the remote station

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
	address	the MAC address of the remote station

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
	address	the MAC address of the remote station

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

src/helper/athstats-helper.h
doc/introspected-doxygen.h

ns3::AthstatsWifiTraceSink Class Reference

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation