Airtime link metric calculator. More...

#include "airtime-metric.h"

Inheritance diagram for ns3::dot11s::AirtimeLinkMetricCalculator:

Collaboration diagram for ns3::dot11s::AirtimeLinkMetricCalculator:

Public Member Functions
	AirtimeLinkMetricCalculator ()

uint32_t	CalculateMetric (Mac48Address peerAddress, Ptr< MeshWifiInterfaceMac > mac)
	Airtime link metric is defined in Section 13.9 of IEEE 802.11-2012 as:

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor.

	~Object () override
	Destructor.

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together.

void	Dispose ()
	Dispose of this Object.

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one.

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

template<typename T >
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object.

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object.

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId.

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object.

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one.

bool	IsInitialized () const
	Check if the object has been initialized.

void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor.

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

uint32_t	GetReferenceCount () const
	Get the reference count of the object.

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

virtual TypeId	GetInstanceTypeId () const =0
	Get the most derived TypeId for this Object.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId ()
	Register this type.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Private Member Functions
void	SetHeaderTid (uint8_t tid)
	Set header TID from the Dot11MetricTid attribute.

void	SetTestLength (uint16_t testLength)
	Set number of bytes in test frame (a constant 1024 in the standard)

Private Attributes
Ptr< Packet >	m_testFrame
	test frame

WifiMacHeader	m_testHeader
	test header

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.

virtual void	DoDispose ()
	Destructor implementation.

virtual void	DoInitialize ()
	Initialize() implementation.

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated.

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

Airtime link metric calculator.

Introspection did not find any typical Config paths.

Airtime link metric is defined in 11B.10 of 802.11s Draft D3.0 as:

airtime = (O + Bt/r)* (1 + average retry counter), where:

o – the PHY dependent channel access which includes frame headers, training sequences, access protocol frames, etc.
bt – the test packet length in bits (8192 by default),
r – the current bitrate of the packet,

Final result is expressed in units of 0.01 Time Unit = 10.24 us (as required by 802.11s draft)

Attributes

Dot11MetricTid: TID used to calculate metric (data rate)
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:255
- Initial value: 0
- Flags: constructwrite
TestLength: Number of bytes in test frame (a constant 1024 in the standard)
- Set with class: ns3::UintegerValue
- Underlying type: uint16_t 1:65535
- Initial value: 1024
- Flags: constructwrite

No TraceSources are defined for this type.
Size of this type is 120 bytes (on a 64-bit architecture).

Definition at line 45 of file airtime-metric.h.

Constructor & Destructor Documentation

◆ AirtimeLinkMetricCalculator()

ns3::dot11s::AirtimeLinkMetricCalculator::AirtimeLinkMetricCalculator ( )

Definition at line 51 of file airtime-metric.cc.

Member Function Documentation

◆ CalculateMetric()

uint32_t ns3::dot11s::AirtimeLinkMetricCalculator::CalculateMetric	(	Mac48Address	peerAddress,
		Ptr< MeshWifiInterfaceMac >	mac
	)

Airtime link metric is defined in Section 13.9 of IEEE 802.11-2012 as:

airtime = (O + Bt/r) / (1 - frame error rate), where o – the PHY dependent channel access which includes frame headers, training sequences, access protocol frames, etc. bt – the test packet length in bits (8192 by default), r – the current bitrate of the packet,

Final result is expressed encoded as an unsigned integer in units of 0.01 TU = 10.24 us

Parameters

peerAddress	The peer MAC address
mac	The MAC layer

Returns: the calculated metric in units of 0.01 TU

Definition at line 71 of file airtime-metric.cc.

References ns3::Packet::GetSize(), ns3::Mac48Address::IsGroup(), m_testFrame, m_testHeader, NS_ASSERT, ns3::WifiTxVector::SetMode(), ns3::WifiTxVector::SetPreambleType(), and ns3::WIFI_PREAMBLE_LONG.

Referenced by ns3::dot11s::HwmpProtocol::Install().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::dot11s::AirtimeLinkMetricCalculator::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 31 of file airtime-metric.cc.

References ns3::MakeUintegerAccessor(), SetHeaderTid(), ns3::TypeId::SetParent(), and SetTestLength().

Here is the call graph for this function:

◆ SetHeaderTid()

void ns3::dot11s::AirtimeLinkMetricCalculator::SetHeaderTid ( uint8_t tid )

private

Set header TID from the Dot11MetricTid attribute.

Parameters

tid	the header TID to use to calculate data rate

Definition at line 56 of file airtime-metric.cc.

References m_testHeader, ns3::WifiMacHeader::SetDsFrom(), ns3::WifiMacHeader::SetDsTo(), ns3::WifiMacHeader::SetQosTid(), ns3::WifiMacHeader::SetType(), and ns3::WIFI_MAC_DATA.

Referenced by GetTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetTestLength()

void ns3::dot11s::AirtimeLinkMetricCalculator::SetTestLength ( uint16_t testLength )

private

Set number of bytes in test frame (a constant 1024 in the standard)

Parameters

testLength the test length in bits

Definition at line 65 of file airtime-metric.cc.

References m_testFrame.

Referenced by GetTypeId().

Here is the caller graph for this function:

Member Data Documentation

◆ m_testFrame

Ptr<Packet> ns3::dot11s::AirtimeLinkMetricCalculator::m_testFrame

private

test frame

Definition at line 84 of file airtime-metric.h.

Referenced by CalculateMetric(), and SetTestLength().

◆ m_testHeader

WifiMacHeader ns3::dot11s::AirtimeLinkMetricCalculator::m_testHeader

private

test header

Definition at line 85 of file airtime-metric.h.

Referenced by CalculateMetric(), and SetHeaderTid().

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

src/mesh/model/dot11s/airtime-metric.h
src/mesh/model/dot11s/airtime-metric.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Attributes

Constructor & Destructor Documentation

◆ AirtimeLinkMetricCalculator()

Member Function Documentation

◆ CalculateMetric()

◆ GetTypeId()

◆ SetHeaderTid()

◆ SetTestLength()

Member Data Documentation

◆ m_testFrame

◆ m_testHeader