A Discrete-Event Network Simulator
API
ns3::dot11s::IePrep Class Reference

See 7.3.2.97 of 802.11s draft 2.07. More...

#include "ie-dot11s-prep.h"

+ Inheritance diagram for ns3::dot11s::IePrep:
+ Collaboration diagram for ns3::dot11s::IePrep:

Public Member Functions

 IePrep ()
 
 ~IePrep ()
 
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
 
Mac48Address GetDestinationAddress () const
 Get destination address function. More...
 
uint32_t GetDestinationSeqNumber () const
 Get destination sequence number function. More...
 
uint8_t GetFlags () const
 Get flags function. More...
 
uint8_t GetHopcount () const
 Get hop count function. 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 GetLifetime () const
 Get lifetime function. More...
 
uint32_t GetMetric () const
 Get metric function. More...
 
Mac48Address GetOriginatorAddress () const
 Get originator address function. More...
 
uint32_t GetOriginatorSeqNumber () const
 Get originator sequence number. More...
 
uint32_t GetTtl () const
 Get TTL function. More...
 
void IncrementMetric (uint32_t metric)
 Increment metric function. 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 SetDestinationAddress (Mac48Address dest_address)
 Set destination address function. More...
 
void SetDestinationSeqNumber (uint32_t dest_seq_number)
 Set destination sequence number function. More...
 
void SetFlags (uint8_t flags)
 Set flags function. More...
 
void SetHopcount (uint8_t hopcount)
 Set hop count function. More...
 
void SetLifetime (uint32_t lifetime)
 Set lifetime function. More...
 
void SetMetric (uint32_t metric)
 Set metric function. More...
 
void SetOriginatorAddress (Mac48Address originator_address)
 Set originator address function. More...
 
void SetOriginatorSeqNumber (uint32_t originator_seq_number)
 Set originator sequence number function. More...
 
void SetTtl (uint8_t ttl)
 Set TTL function. 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...
 
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...
 
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)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (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

Mac48Address m_destinationAddress
 destination address More...
 
uint32_t m_destSeqNumber
 destination sequence number More...
 
uint8_t m_flags
 flags More...
 
uint8_t m_hopcount
 hop count More...
 
uint32_t m_lifetime
 lifetime More...
 
uint32_t m_metric
 metric More...
 
Mac48Address m_originatorAddress
 originator address More...
 
uint32_t m_originatorSeqNumber
 originator sequence number More...
 
uint8_t m_ttl
 TTL. More...
 

Friends

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

Detailed Description

See 7.3.2.97 of 802.11s draft 2.07.

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

Constructor & Destructor Documentation

ns3::dot11s::IePrep::IePrep ( )

Definition at line 33 of file ie-dot11s-prep.cc.

ns3::dot11s::IePrep::~IePrep ( )

Definition at line 30 of file ie-dot11s-prep.cc.

Member Function Documentation

void ns3::dot11s::IePrep::DecrementTtl ( )

Decrement TTL function.

Definition at line 135 of file ie-dot11s-prep.cc.

References m_hopcount, and m_ttl.

uint8_t ns3::dot11s::IePrep::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
startan iterator which points to where the information should be written.
length
Returns
the number of bytes read

Implements ns3::WifiInformationElement.

Definition at line 161 of file ie-dot11s-prep.cc.

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

+ Here is the call graph for this function:

WifiInformationElementId ns3::dot11s::IePrep::ElementId ( ) const
virtual
Returns
Own unique Element ID

Implements ns3::WifiInformationElement.

Definition at line 40 of file ie-dot11s-prep.cc.

References IE_PREP.

Mac48Address ns3::dot11s::IePrep::GetDestinationAddress ( void  ) const

Get destination address function.

Returns
the destination MAC address

Definition at line 110 of file ie-dot11s-prep.cc.

References m_destinationAddress.

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

+ Here is the caller graph for this function:

uint32_t ns3::dot11s::IePrep::GetDestinationSeqNumber ( ) const

Get destination sequence number function.

Returns
the destination sequence number

Definition at line 105 of file ie-dot11s-prep.cc.

References m_destSeqNumber.

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

+ Here is the caller graph for this function:

uint8_t ns3::dot11s::IePrep::GetFlags ( ) const

Get flags function.

Returns
the flags

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

References m_flags.

uint8_t ns3::dot11s::IePrep::GetHopcount ( ) const

Get hop count function.

Returns
the hop count

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

References m_hopcount.

uint8_t ns3::dot11s::IePrep::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 176 of file ie-dot11s-prep.cc.

uint32_t ns3::dot11s::IePrep::GetLifetime ( void  ) const

Get lifetime function.

Returns
the lifetime

Definition at line 130 of file ie-dot11s-prep.cc.

References m_lifetime.

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

+ Here is the caller graph for this function:

uint32_t ns3::dot11s::IePrep::GetMetric ( void  ) const

Get metric function.

Returns
the metric

Definition at line 115 of file ie-dot11s-prep.cc.

References m_metric.

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

+ Here is the caller graph for this function:

Mac48Address ns3::dot11s::IePrep::GetOriginatorAddress ( ) const

Get originator address function.

Returns
the MAC address of the originator

Definition at line 120 of file ie-dot11s-prep.cc.

References m_originatorAddress.

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

+ Here is the caller graph for this function:

uint32_t ns3::dot11s::IePrep::GetOriginatorSeqNumber ( ) const

Get originator sequence number.

Returns
the originator sequence number

Definition at line 125 of file ie-dot11s-prep.cc.

References m_originatorSeqNumber.

uint32_t ns3::dot11s::IePrep::GetTtl ( void  ) const

Get TTL function.

Returns
the TTL

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

References m_ttl.

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

Increment metric function.

Parameters
metricthe metric to increment

Definition at line 142 of file ie-dot11s-prep.cc.

References m_metric.

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

+ Here is the caller graph for this function:

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

Generate human-readable form of IE.

Parameters
osoutput stream

Reimplemented from ns3::WifiInformationElement.

Definition at line 190 of file ie-dot11s-prep.cc.

References m_destinationAddress, m_destSeqNumber, m_flags, m_hopcount, m_lifetime, m_metric, m_originatorAddress, m_originatorSeqNumber, and m_ttl.

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

+ Here is the caller graph for this function:

void ns3::dot11s::IePrep::SerializeInformationField ( Buffer::Iterator  start) const
virtual

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

Parameters
startan iterator which points to where the information should be written.

Implements ns3::WifiInformationElement.

Definition at line 148 of file ie-dot11s-prep.cc.

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

+ Here is the call graph for this function:

void ns3::dot11s::IePrep::SetDestinationAddress ( Mac48Address  dest_address)

Set destination address function.

Parameters
dest_address

Definition at line 65 of file ie-dot11s-prep.cc.

References m_destinationAddress.

Referenced by MeshInformationElementVectorBist::DoRun(), and ns3::dot11s::HwmpProtocol::SendPrep().

+ Here is the caller graph for this function:

void ns3::dot11s::IePrep::SetDestinationSeqNumber ( uint32_t  dest_seq_number)

Set destination sequence number function.

Parameters
dest_seq_numberthe destination sequence number

Definition at line 60 of file ie-dot11s-prep.cc.

References m_destSeqNumber.

Referenced by MeshInformationElementVectorBist::DoRun(), and ns3::dot11s::HwmpProtocol::SendPrep().

+ Here is the caller graph for this function:

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

Set flags function.

Parameters
flagsthe flags to set

Definition at line 45 of file ie-dot11s-prep.cc.

References m_flags.

Referenced by MeshInformationElementVectorBist::DoRun().

+ Here is the caller graph for this function:

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

Set hop count function.

Parameters
hopcountthe hop count

Definition at line 50 of file ie-dot11s-prep.cc.

References m_hopcount.

Referenced by MeshInformationElementVectorBist::DoRun(), and ns3::dot11s::HwmpProtocol::SendPrep().

+ Here is the caller graph for this function:

void ns3::dot11s::IePrep::SetLifetime ( uint32_t  lifetime)

Set lifetime function.

Parameters
lifetimethe lifetime

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

References m_lifetime.

Referenced by MeshInformationElementVectorBist::DoRun(), and ns3::dot11s::HwmpProtocol::SendPrep().

+ Here is the caller graph for this function:

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

Set metric function.

Parameters
metricthe metric to set

Definition at line 70 of file ie-dot11s-prep.cc.

References m_metric.

Referenced by MeshInformationElementVectorBist::DoRun(), and ns3::dot11s::HwmpProtocol::SendPrep().

+ Here is the caller graph for this function:

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

Set originator address function.

Parameters
originator_addressthe originator address

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

References m_originatorAddress.

Referenced by MeshInformationElementVectorBist::DoRun(), and ns3::dot11s::HwmpProtocol::SendPrep().

+ Here is the caller graph for this function:

void ns3::dot11s::IePrep::SetOriginatorSeqNumber ( uint32_t  originator_seq_number)

Set originator sequence number function.

Parameters
originator_seq_numberthe originator sequence number

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

References m_originatorSeqNumber.

Referenced by MeshInformationElementVectorBist::DoRun(), and ns3::dot11s::HwmpProtocol::SendPrep().

+ Here is the caller graph for this function:

void ns3::dot11s::IePrep::SetTtl ( uint8_t  ttl)

Set TTL function.

Parameters
ttlthe TTL

Definition at line 55 of file ie-dot11s-prep.cc.

References m_ttl.

Referenced by MeshInformationElementVectorBist::DoRun(), and ns3::dot11s::HwmpProtocol::SendPrep().

+ Here is the caller graph for this function:

Friends And Related Function Documentation

bool operator== ( const IePrep a,
const IePrep b 
)
friend

equality operator

Parameters
alhs
brhs
Returns
true if equal

Definition at line 198 of file ie-dot11s-prep.cc.

Member Data Documentation

Mac48Address ns3::dot11s::IePrep::m_destinationAddress
private
uint32_t ns3::dot11s::IePrep::m_destSeqNumber
private
uint8_t ns3::dot11s::IePrep::m_flags
private
uint8_t ns3::dot11s::IePrep::m_hopcount
private
uint32_t ns3::dot11s::IePrep::m_lifetime
private
uint32_t ns3::dot11s::IePrep::m_metric
private
Mac48Address ns3::dot11s::IePrep::m_originatorAddress
private
uint32_t ns3::dot11s::IePrep::m_originatorSeqNumber
private
uint8_t ns3::dot11s::IePrep::m_ttl
private

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