A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::dot11s::IeBeaconTiming Class Reference

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

#include <ie-dot11s-beacon-timing.h>

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

Public Types

typedef std::vector< Ptr
< IeBeaconTimingUnit > > 
NeighboursTimingUnitsList
 This type is a list of timing elements obtained from neighbours with their beacons: More...
 

Public Member Functions

 IeBeaconTiming ()
 
void AddNeighboursTimingElementUnit (uint16_t aid, Time last_beacon, Time beacon_interval)
 
void ClearTimingElement ()
 
void DelNeighboursTimingElementUnit (uint16_t aid, Time last_beacon, Time beacon_interval)
 
NeighboursTimingUnitsList GetNeighboursTimingElementsList ()
 This methods are needed for beacon collision avoidance module: More...
 
bool operator== (WifiInformationElement const &a) const
 Compare two IEs for equality by ID & Length, and then through memcmp of serialised version. More...
 
Inherited from WifiInformationElement
virtual WifiInformationElementId ElementId () const
 Own unique Element ID. 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...
 
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...
 
virtual uint8_t DeserializeInformationField (Buffer::Iterator i, uint8_t length)
 Deserialize information (i.e., the body of the IE, not including the Element ID and length octets) More...
 
virtual void Print (std::ostream &os) const
 In addition, a subclass may optionally override the following... 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...
 
Buffer::Iterator Serialize (Buffer::Iterator i) const
 Serialize entire IE including Element ID and length fields. More...
 
virtual bool operator< (WifiInformationElement const &a) const
 Compare information elements using Element ID. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< WifiInformationElement >
 SimpleRefCount ()
 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. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 

Static Private Member Functions

static uint8_t AidToU8 (uint16_t x)
 
static uint16_t BeaconIntervalToU16 (Time x)
 
static uint16_t TimestampToU16 (Time x)
 Converters: More...
 

Private Attributes

NeighboursTimingUnitsList m_neighbours
 
uint16_t m_numOfUnits
 Timing element parameters: More...
 

Additional Inherited Members

- Static Public Member Functions inherited from ns3::SimpleRefCount< WifiInformationElement >
static void Cleanup (void)
 Noop. More...
 

Detailed Description

See 7.3.2.89 of 802.11s draft 2.07.

Definition at line 60 of file ie-dot11s-beacon-timing.h.

Constructor & Destructor Documentation

ns3::dot11s::IeBeaconTiming::IeBeaconTiming ( )

Definition at line 70 of file ie-dot11s-beacon-timing.cc.

Member Function Documentation

void ns3::dot11s::IeBeaconTiming::AddNeighboursTimingElementUnit ( uint16_t  aid,
Time  last_beacon,
Time  beacon_interval 
)
uint8_t ns3::dot11s::IeBeaconTiming::AidToU8 ( uint16_t  x)
staticprivate

Definition at line 181 of file ie-dot11s-beacon-timing.cc.

Referenced by AddNeighboursTimingElementUnit(), and DelNeighboursTimingElementUnit().

+ Here is the caller graph for this function:

uint16_t ns3::dot11s::IeBeaconTiming::BeaconIntervalToU16 ( Time  x)
staticprivate

Definition at line 176 of file ie-dot11s-beacon-timing.cc.

References ns3::Time::GetMicroSeconds().

Referenced by AddNeighboursTimingElementUnit(), and DelNeighboursTimingElementUnit().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::dot11s::IeBeaconTiming::ClearTimingElement ( )

Definition at line 117 of file ie-dot11s-beacon-timing.cc.

References m_neighbours.

Referenced by ns3::dot11s::PeerLink::DoDispose().

+ Here is the caller graph for this function:

void ns3::dot11s::IeBeaconTiming::DelNeighboursTimingElementUnit ( uint16_t  aid,
Time  last_beacon,
Time  beacon_interval 
)

Definition at line 103 of file ie-dot11s-beacon-timing.cc.

References AidToU8(), BeaconIntervalToU16(), m_neighbours, m_numOfUnits, and TimestampToU16().

+ Here is the call graph for this function:

uint8_t ns3::dot11s::IeBeaconTiming::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 153 of file ie-dot11s-beacon-timing.cc.

References ns3::Buffer::Iterator::GetDistanceFrom(), m_neighbours, m_numOfUnits, ns3::Buffer::Iterator::ReadLsbtohU16(), ns3::Buffer::Iterator::ReadU8(), ns3::dot11s::IeBeaconTimingUnit::SetAid(), ns3::dot11s::IeBeaconTimingUnit::SetBeaconInterval(), ns3::dot11s::IeBeaconTimingUnit::SetLastBeacon(), and visualizer.core::start().

+ Here is the call graph for this function:

WifiInformationElementId ns3::dot11s::IeBeaconTiming::ElementId ( ) const
virtual

Own unique Element ID.

Implements ns3::WifiInformationElement.

Definition at line 66 of file ie-dot11s-beacon-timing.cc.

References IE11S_BEACON_TIMING.

Referenced by Print().

+ Here is the caller graph for this function:

uint8_t ns3::dot11s::IeBeaconTiming::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 126 of file ie-dot11s-beacon-timing.cc.

References m_numOfUnits.

IeBeaconTiming::NeighboursTimingUnitsList ns3::dot11s::IeBeaconTiming::GetNeighboursTimingElementsList ( )

This methods are needed for beacon collision avoidance module:

Definition at line 75 of file ie-dot11s-beacon-timing.cc.

References m_neighbours.

bool ns3::dot11s::IeBeaconTiming::operator== ( WifiInformationElement const &  a) const
virtual

Compare two IEs for equality by ID & Length, and then through memcmp of serialised version.

Parameters
aanother information element to compare with
Returns
true if the two IEs are equal, false otherwise

Reimplemented from ns3::WifiInformationElement.

Definition at line 192 of file ie-dot11s-beacon-timing.cc.

References m_neighbours, m_numOfUnits, and ns3::PeekPointer().

+ Here is the call graph for this function:

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

In addition, a subclass may optionally override the following...

Generate human-readable form of IE

Parameters
osoutput stream

Reimplemented from ns3::WifiInformationElement.

Definition at line 131 of file ie-dot11s-beacon-timing.cc.

References ElementId(), m_neighbours, and m_numOfUnits.

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

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::dot11s::IeBeaconTiming::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 143 of file ie-dot11s-beacon-timing.cc.

References m_neighbours, ns3::Buffer::Iterator::WriteHtolsbU16(), and ns3::Buffer::Iterator::WriteU8().

+ Here is the call graph for this function:

uint16_t ns3::dot11s::IeBeaconTiming::TimestampToU16 ( Time  x)
staticprivate

Converters:

Definition at line 169 of file ie-dot11s-beacon-timing.cc.

References ns3::Time::GetMicroSeconds().

Referenced by AddNeighboursTimingElementUnit(), and DelNeighboursTimingElementUnit().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Member Data Documentation

uint16_t ns3::dot11s::IeBeaconTiming::m_numOfUnits
private

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