Root announcement (RANN) element. More...

#include "ie-dot11s-rann.h"

Inheritance diagram for ns3::dot11s::IeRann:

Collaboration diagram for ns3::dot11s::IeRann:

Public Member Functions
	IeRann ()

virtual	~IeRann ()

void	DecrementTtl ()
	Decrement TTL function. More...

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

virtual WifiInformationElementId	ElementId () const

uint32_t	GetDestSeqNumber ()
	Get destination sequence number value. More...

uint8_t	GetFlags ()
	Get flags value. More...

uint8_t	GetHopcount ()
	Get hop count value. More...

virtual uint8_t	GetInformationFieldSize () const
	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 ()
	Get metric value. More...

Mac48Address	GetOriginatorAddress ()
	Get originator address value. More...

uint8_t	GetTtl ()
	Get TTL value. More...

void	IncrementMetric (uint32_t metric)
	Increment metric. More...

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

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

void	SetDestSeqNumber (uint32_t dest_seq_number)
	Set destination sequence number value. More...

void	SetFlags (uint8_t flags)
	Set flags field. More...

void	SetHopcount (uint8_t hopcount)
	Set hop count value to number of hops from the originating root mesh STA to the mesh STA transmitting this element. More...

void	SetMetric (uint32_t metric)
	Set metric value to cumulative metric from originating root mesh STA to the mesh STA transmitting the announcement. More...

void	SetOriginatorAddress (Mac48Address originator_address)
	Set originator address value. More...

void	SetTTL (uint8_t ttl)
	Set TTL value to the remaining number of hops allowed. More...

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

Buffer::Iterator	Deserialize (Buffer::Iterator i)
	Deserialize entire IE, which must be present. More...

Buffer::Iterator	DeserializeIfPresent (Buffer::Iterator i)
	Deserialize entire IE if it is present. More...

virtual WifiInformationElementId	ElementIdExt () const

virtual uint16_t	GetSerializedSize () const
	Get the size of the serialized IE including Element ID and length fields. More...

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

virtual 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 (void) const
	Get the reference count of the object. More...

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

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

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

Private Attributes
uint32_t	m_destSeqNumber
	destination sequence number More...

uint8_t	m_flags
	flags More...

uint8_t	m_hopcount
	hop count More...

uint32_t	m_metric
	metric More...

Mac48Address	m_originatorAddress
	originator address More...

uint8_t	m_ttl
	TTL. More...

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

Detailed Description

Root announcement (RANN) element.

Definition at line 33 of file ie-dot11s-rann.h.

Constructor & Destructor Documentation

◆ IeRann()

ns3::dot11s::IeRann::IeRann ( )

Definition at line 32 of file ie-dot11s-rann.cc.

◆ ~IeRann()

ns3::dot11s::IeRann::~IeRann ( )

virtual

Definition at line 29 of file ie-dot11s-rann.cc.

Member Function Documentation

◆ DecrementTtl()

void ns3::dot11s::IeRann::DecrementTtl ( )

Decrement TTL function.

Definition at line 100 of file ie-dot11s-rann.cc.

References m_hopcount, and m_ttl.

◆ DeserializeInformationField()

uint8_t ns3::dot11s::IeRann::DeserializeInformationField	(	Buffer::Iterator	start,
		uint8_t	length
	)

virtual

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

Returns: the number of bytes read

Implements ns3::WifiInformationElement.

Definition at line 128 of file ie-dot11s-rann.cc.

References ns3::Buffer::Iterator::GetDistanceFrom(), m_destSeqNumber, m_flags, m_hopcount, m_metric, m_originatorAddress, m_ttl, ns3::ReadFrom(), ns3::Buffer::Iterator::ReadLsbtohU32(), ns3::Buffer::Iterator::ReadU8(), and visualizer.core::start().

Here is the call graph for this function:

◆ ElementId()

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

virtual

Returns: Own unique Element ID

Implements ns3::WifiInformationElement.

Definition at line 38 of file ie-dot11s-rann.cc.

References IE_RANN.

◆ GetDestSeqNumber()

uint32_t ns3::dot11s::IeRann::GetDestSeqNumber ( )

Get destination sequence number value.

Returns: the destination sequence number

Definition at line 90 of file ie-dot11s-rann.cc.

References m_destSeqNumber.

◆ GetFlags()

uint8_t ns3::dot11s::IeRann::GetFlags ( )

Get flags value.

Returns: the flags

Definition at line 75 of file ie-dot11s-rann.cc.

References m_flags.

◆ GetHopcount()

uint8_t ns3::dot11s::IeRann::GetHopcount ( )

Get hop count value.

Returns: the hop count

Definition at line 80 of file ie-dot11s-rann.cc.

References m_hopcount.

◆ GetInformationFieldSize()

uint8_t ns3::dot11s::IeRann::GetInformationFieldSize ( ) const

virtual

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)

Returns: the length of serialized information

Implements ns3::WifiInformationElement.

Definition at line 140 of file ie-dot11s-rann.cc.

◆ GetMetric()

uint32_t ns3::dot11s::IeRann::GetMetric ( void )

Get metric value.

Returns: the metric

Definition at line 95 of file ie-dot11s-rann.cc.

References m_metric.

◆ GetOriginatorAddress()

Mac48Address ns3::dot11s::IeRann::GetOriginatorAddress ( )

Get originator address value.

Returns: the MAC address of the originator

Definition at line 113 of file ie-dot11s-rann.cc.

References m_originatorAddress.

◆ GetTtl()

uint8_t ns3::dot11s::IeRann::GetTtl ( void )

Get TTL value.

Returns: the TTL

Definition at line 85 of file ie-dot11s-rann.cc.

References m_ttl.

◆ IncrementMetric()

void ns3::dot11s::IeRann::IncrementMetric ( uint32_t metric )

Increment metric.

Parameters

metric the value to increment

Definition at line 107 of file ie-dot11s-rann.cc.

References m_metric.

◆ Print()

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

virtual

Generate human-readable form of IE.

Parameters

os	output stream

Reimplemented from ns3::WifiInformationElement.

Definition at line 152 of file ie-dot11s-rann.cc.

References m_destSeqNumber, m_flags, m_hopcount, m_metric, m_originatorAddress, and m_ttl.

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

Here is the caller graph for this function:

◆ SerializeInformationField()

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

virtual

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 118 of file ie-dot11s-rann.cc.

References m_destSeqNumber, m_flags, m_hopcount, m_metric, m_originatorAddress, m_ttl, ns3::Buffer::Iterator::WriteHtolsbU32(), ns3::WriteTo(), and ns3::Buffer::Iterator::WriteU8().

Here is the call graph for this function:

◆ SetDestSeqNumber()

void ns3::dot11s::IeRann::SetDestSeqNumber ( uint32_t dest_seq_number )

Set destination sequence number value.

Parameters

dest_seq_number the destination sequence number

Definition at line 59 of file ie-dot11s-rann.cc.

References m_destSeqNumber.

◆ SetFlags()

void ns3::dot11s::IeRann::SetFlags ( uint8_t flags )

Set flags field.

Parameters

flags the flags value to set

Definition at line 44 of file ie-dot11s-rann.cc.

References m_flags.

◆ SetHopcount()

void ns3::dot11s::IeRann::SetHopcount ( uint8_t hopcount )

Set hop count value to number of hops from the originating root mesh STA to the mesh STA transmitting this element.

Parameters

hopcount the hop count

Definition at line 49 of file ie-dot11s-rann.cc.

References m_hopcount.

◆ SetMetric()

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

Set metric value to cumulative metric from originating root mesh STA to the mesh STA transmitting the announcement.

Parameters

metric the metric to set

Definition at line 64 of file ie-dot11s-rann.cc.

References m_metric.

◆ SetOriginatorAddress()

void ns3::dot11s::IeRann::SetOriginatorAddress ( Mac48Address originator_address )

Set originator address value.

Parameters

originator_address the originator MAC address

Definition at line 69 of file ie-dot11s-rann.cc.

References m_originatorAddress.

◆ SetTTL()

void ns3::dot11s::IeRann::SetTTL ( uint8_t ttl )

Set TTL value to the remaining number of hops allowed.

Parameters

ttl the TTL

Definition at line 54 of file ie-dot11s-rann.cc.

References m_ttl.

Friends And Related Function Documentation

◆ operator==

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

friend

equality operator

Parameters

a	lhs
b	rhs

Returns: true if equal

Definition at line 164 of file ie-dot11s-rann.cc.

Member Data Documentation

◆ m_destSeqNumber

uint32_t ns3::dot11s::IeRann::m_destSeqNumber

private

destination sequence number

Definition at line 120 of file ie-dot11s-rann.h.

Referenced by DeserializeInformationField(), GetDestSeqNumber(), Print(), SerializeInformationField(), and SetDestSeqNumber().

◆ m_flags

uint8_t ns3::dot11s::IeRann::m_flags

private

flags

Definition at line 116 of file ie-dot11s-rann.h.

Referenced by DeserializeInformationField(), GetFlags(), Print(), SerializeInformationField(), and SetFlags().

◆ m_hopcount

uint8_t ns3::dot11s::IeRann::m_hopcount

private

hop count

Definition at line 117 of file ie-dot11s-rann.h.

Referenced by DecrementTtl(), DeserializeInformationField(), GetHopcount(), Print(), SerializeInformationField(), and SetHopcount().

◆ m_metric

uint32_t ns3::dot11s::IeRann::m_metric

private

metric

Definition at line 121 of file ie-dot11s-rann.h.

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

◆ m_originatorAddress

Mac48Address ns3::dot11s::IeRann::m_originatorAddress

private

originator address

Definition at line 119 of file ie-dot11s-rann.h.

Referenced by DeserializeInformationField(), GetOriginatorAddress(), Print(), SerializeInformationField(), and SetOriginatorAddress().

◆ m_ttl

uint8_t ns3::dot11s::IeRann::m_ttl

private

TTL.

Definition at line 118 of file ie-dot11s-rann.h.

Referenced by DecrementTtl(), DeserializeInformationField(), GetTtl(), Print(), SerializeInformationField(), and SetTTL().

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

src/mesh/model/dot11s/ie-dot11s-rann.h
src/mesh/model/dot11s/ie-dot11s-rann.cc

Public Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ IeRann()

◆ ~IeRann()

Member Function Documentation

◆ DecrementTtl()

◆ DeserializeInformationField()

◆ ElementId()

◆ GetDestSeqNumber()

◆ GetFlags()

◆ GetHopcount()

◆ GetInformationFieldSize()

◆ GetMetric()

◆ GetOriginatorAddress()

◆ GetTtl()

◆ IncrementMetric()

◆ Print()

◆ SerializeInformationField()

◆ SetDestSeqNumber()

◆ SetFlags()

◆ SetHopcount()

◆ SetMetric()

◆ SetOriginatorAddress()

◆ SetTTL()

Friends And Related Function Documentation

◆ operator==

Member Data Documentation

◆ m_destSeqNumber

◆ m_flags

◆ m_hopcount

◆ m_metric

◆ m_originatorAddress

◆ m_ttl