A Discrete-Event Network Simulator
API
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
ns3::dot11s::AirtimeLinkMetricCalculator Class Reference
Mesh Device » IEEE 802.11s draft

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)
 
void SetHeaderTid (uint8_t tid)
 
void SetTestLength (uint16_t testLength)
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Implement the GetInstanceTypeId method defined in ObjectBase. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCount & operator= (const SimpleRefCount &o)
 Assignment. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId ()
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 Noop. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Attributes

Ptr< Packet > m_testFrame
 
WifiMacHeader m_testHeader
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose (void)
 Destructor implementation. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 
- Related Functions inherited from ns3::ObjectBase
static TypeId GetObjectIid (void)
 Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...
 

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

  • TestLength: Rate should be estimated using test length.
    • Set with class: ns3::UintegerValue
    • Underlying type: uint16_t 1:65535
    • Initial value: 1024
    • Flags: construct write
  • Dot11MetricTid: TID used to calculate metric (data rate)
    • Set with class: ns3::UintegerValue
    • Underlying type: uint8_t 0:255
    • Initial value: 0
    • Flags: construct write

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

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

Constructor & Destructor Documentation

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

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

Member Function Documentation

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

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(), 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:

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

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:

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

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

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

Referenced by GetTypeId().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

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

References m_testFrame.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

Member Data Documentation

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

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

Referenced by CalculateMetric(), and SetTestLength().

WifiMacHeader ns3::dot11s::AirtimeLinkMetricCalculator::m_testHeader
private

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

Referenced by CalculateMetric(), and SetHeaderTid().

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