a IEEE 802.11s Mesh ID 7.3.2.88 of 802.11s draft 3.0 More...

#include "ie-dot11s-metric-report.h"

Inheritance diagram for ns3::dot11s::IeLinkMetricReport:

Collaboration diagram for ns3::dot11s::IeLinkMetricReport:

Public Member Functions
	IeLinkMetricReport ()

	IeLinkMetricReport (uint32_t metric)
	Constructor. More...

uint16_t	DeserializeInformationField (Buffer::Iterator start, uint16_t length) override
	Deserialize information (i.e., the body of the IE, not including the Element ID and length octets) More...

WifiInformationElementId	ElementId () const override
	Get the wifi information element ID. More...

uint16_t	GetInformationFieldSize () const override
	Length of serialized information (i.e., the length of the body of the IE, not including the Element ID and length octets. More...

uint32_t	GetMetric () const
	Get metric value. More...

void	Print (std::ostream &os) const override
	Generate human-readable form of IE. More...

void	SerializeInformationField (Buffer::Iterator i) const override
	Serialize information (i.e., the body of the IE, not including the Element ID and length octets) More...

void	SetMetric (uint32_t metric)
	Set metric value. More...

Public Member Functions inherited from ns3::WifiInformationElement
virtual	~WifiInformationElement ()

Buffer::Iterator	Deserialize (Buffer::Iterator i)
	Deserialize entire IE (which may possibly be fragmented into multiple elements), which must be present. More...

Buffer::Iterator	DeserializeIfPresent (Buffer::Iterator i)
	Deserialize entire IE (which may possibly be fragmented into multiple elements) if it is present. More...

virtual WifiInformationElementId	ElementIdExt () const
	Get the wifi information element ID extension. More...

uint16_t	GetSerializedSize () const
	Get the size of the serialized IE including Element ID and length fields (for every element this IE is possibly fragmented into). More...

virtual bool	operator== (const WifiInformationElement &a) const
	Compare two IEs for equality by ID & Length, and then through memcmp of serialised version. More...

Buffer::Iterator	Serialize (Buffer::Iterator i) const
	Serialize entire IE including Element ID and length fields. More...

Public Member Functions inherited from ns3::SimpleRefCount< WifiInformationElement >
	SimpleRefCount ()
	Default constructor. More...

	SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
	Copy constructor. More...

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

SimpleRefCount &	operator= (const SimpleRefCount &o[[maybe_unused]])
	Assignment operator. More...

void	Ref () const
	Increment the reference count. More...

void	Unref () const
	Decrement the reference count. More...

Private Attributes
uint32_t	m_metric
	metric More...

Friends
bool	operator< (const IeLinkMetricReport &a, const IeLinkMetricReport &b)
	less than operator More...

bool	operator== (const IeLinkMetricReport &a, const IeLinkMetricReport &b)
	equality operator More...

bool	operator> (const IeLinkMetricReport &a, const IeLinkMetricReport &b)
	greater than operator More...

Detailed Description

a IEEE 802.11s Mesh ID 7.3.2.88 of 802.11s draft 3.0

Definition at line 36 of file ie-dot11s-metric-report.h.

Constructor & Destructor Documentation

◆ IeLinkMetricReport() [1/2]

ns3::dot11s::IeLinkMetricReport::IeLinkMetricReport ( )

Definition at line 28 of file ie-dot11s-metric-report.cc.

◆ IeLinkMetricReport() [2/2]

ns3::dot11s::IeLinkMetricReport::IeLinkMetricReport ( uint32_t metric )

Constructor.

Parameters

metric the metric

Definition at line 33 of file ie-dot11s-metric-report.cc.

References m_metric.

Member Function Documentation

◆ DeserializeInformationField()

uint16_t ns3::dot11s::IeLinkMetricReport::DeserializeInformationField	(	Buffer::Iterator	start,
		uint16_t	length
	)

overridevirtual

Deserialize information (i.e., the body of the IE, not including the Element ID and length octets)

Parameters

start	an iterator which points to where the information should be written.
length	the expected number of bytes to read

Returns: the number of bytes read

Implements ns3::WifiInformationElement.

Definition at line 69 of file ie-dot11s-metric-report.cc.

References ns3::Buffer::Iterator::GetDistanceFrom(), m_metric, ns3::Buffer::Iterator::ReadLsbtohU32(), and two-ray-to-three-gpp-ch-calibration::start.

Here is the call graph for this function:

◆ ElementId()

WifiInformationElementId ns3::dot11s::IeLinkMetricReport::ElementId ( ) const

overridevirtual

Get the wifi information element ID.

Returns: the wifi information element ID

Implements ns3::WifiInformationElement.

Definition at line 39 of file ie-dot11s-metric-report.cc.

References IE_MESH_LINK_METRIC_REPORT.

◆ GetInformationFieldSize()

uint16_t ns3::dot11s::IeLinkMetricReport::GetInformationFieldSize ( ) const

overridevirtual

Length of serialized information (i.e., the length of the body of the IE, not including the Element ID and length octets.

This is the value that will appear in the second octet of the entire IE - the length field - if the IE is not fragmented)

Returns: the length of serialized information

Implements ns3::WifiInformationElement.

Definition at line 45 of file ie-dot11s-metric-report.cc.

◆ GetMetric()

uint32_t ns3::dot11s::IeLinkMetricReport::GetMetric ( ) const

Get metric value.

Returns: the metric

Definition at line 51 of file ie-dot11s-metric-report.cc.

References m_metric.

◆ Print()

void ns3::dot11s::IeLinkMetricReport::Print ( std::ostream & os ) const

overridevirtual

Generate human-readable form of IE.

Parameters

os	output stream

Reimplemented from ns3::WifiInformationElement.

Definition at line 77 of file ie-dot11s-metric-report.cc.

References m_metric.

Referenced by ns3::dot11s::operator<<().

Here is the caller graph for this function:

◆ SerializeInformationField()

void ns3::dot11s::IeLinkMetricReport::SerializeInformationField ( Buffer::Iterator start ) const

overridevirtual

Serialize information (i.e., the body of the IE, not including the Element ID and length octets)

Parameters

start an iterator which points to where the information should be written.

Implements ns3::WifiInformationElement.

Definition at line 63 of file ie-dot11s-metric-report.cc.

References m_metric, and ns3::Buffer::Iterator::WriteHtolsbU32().

Here is the call graph for this function:

◆ SetMetric()

void ns3::dot11s::IeLinkMetricReport::SetMetric ( uint32_t metric )

Set metric value.

Parameters

metric the metric

Definition at line 57 of file ie-dot11s-metric-report.cc.

References m_metric.

Friends And Related Function Documentation

◆ operator<

bool operator<	(	const IeLinkMetricReport &	a,
		const IeLinkMetricReport &	b
	)

friend

less than operator

Parameters

a	lhs
b	lhs

Returns: true if equal

Definition at line 88 of file ie-dot11s-metric-report.cc.

◆ operator==

bool operator==	(	const IeLinkMetricReport &	a,
		const IeLinkMetricReport &	b
	)

friend

equality operator

Parameters

a	lhs
b	lhs

Returns: true if equal

Definition at line 83 of file ie-dot11s-metric-report.cc.

◆ operator>

bool operator>	(	const IeLinkMetricReport &	a,
		const IeLinkMetricReport &	b
	)

friend

greater than operator

Parameters

a	lhs
b	lhs

Returns: true if equal

Definition at line 95 of file ie-dot11s-metric-report.cc.

Member Data Documentation

◆ m_metric

uint32_t ns3::dot11s::IeLinkMetricReport::m_metric

private

metric

Definition at line 65 of file ie-dot11s-metric-report.h.

Referenced by IeLinkMetricReport(), DeserializeInformationField(), GetMetric(), Print(), SerializeInformationField(), and SetMetric().

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

src/mesh/model/dot11s/ie-dot11s-metric-report.h
src/mesh/model/dot11s/ie-dot11s-metric-report.cc

Public Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ IeLinkMetricReport() [1/2]

◆ IeLinkMetricReport() [2/2]

Member Function Documentation

◆ DeserializeInformationField()

◆ ElementId()

◆ GetInformationFieldSize()

◆ GetMetric()

◆ Print()

◆ SerializeInformationField()

◆ SetMetric()

Friends And Related Function Documentation

◆ operator<

◆ operator==

◆ operator>

Member Data Documentation

◆ m_metric