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

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

#include <ie-dot11s-id.h>

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

Public Member Functions

 IeMeshId ()
 
 IeMeshId (std::string s)
 
bool IsBroadcast (void) const
 
bool IsEqual (IeMeshId const &o) const
 
char * PeekString (void) const
 
Inherited from WifiInformationElement
virtual WifiInformationElementId ElementId () const
 Own unique Element ID. 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 start, 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...
 
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...
 
- 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...
 
virtual bool operator== (WifiInformationElement const &a) const
 Compare two IEs for equality by ID & Length, and then through memcmp of serialised version. 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...
 

Private Attributes

uint8_t m_meshId [33]
 

Friends

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

Additional Inherited Members

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

Detailed Description

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

Definition at line 34 of file ie-dot11s-id.h.

Constructor & Destructor Documentation

ns3::dot11s::IeMeshId::IeMeshId ( )

Definition at line 27 of file ie-dot11s-id.cc.

References m_meshId.

ns3::dot11s::IeMeshId::IeMeshId ( std::string  s)

Definition at line 34 of file ie-dot11s-id.cc.

References m_meshId, and NS_ASSERT.

Member Function Documentation

uint8_t ns3::dot11s::IeMeshId::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 107 of file ie-dot11s-id.cc.

References ns3::Buffer::Iterator::GetDistanceFrom(), m_meshId, NS_ASSERT, ns3::Buffer::Iterator::Read(), and visualizer.core::start().

Referenced by ns3::dot11s::PeerLinkFrameStart::Deserialize().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

Own unique Element ID.

Implements ns3::WifiInformationElement.

Definition at line 53 of file ie-dot11s-id.cc.

References IE11S_MESH_ID.

Referenced by ns3::dot11s::PeerLinkFrameStart::Deserialize(), and Print().

+ Here is the caller graph for this function:

uint8_t ns3::dot11s::IeMeshId::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 86 of file ie-dot11s-id.cc.

References m_meshId, and NS_ASSERT.

Referenced by ns3::dot11s::PeerLinkFrameStart::Deserialize(), and ns3::dot11s::PeerLinkFrameStart::GetSerializedSize().

+ Here is the caller graph for this function:

bool ns3::dot11s::IeMeshId::IsBroadcast ( void  ) const

Definition at line 72 of file ie-dot11s-id.cc.

References m_meshId.

bool ns3::dot11s::IeMeshId::IsEqual ( IeMeshId const &  o) const

Definition at line 58 of file ie-dot11s-id.cc.

References m_meshId.

Referenced by ns3::dot11s::operator==(), and ns3::dot11s::PeerManagementProtocolMac::Receive().

+ Here is the caller graph for this function:

char * ns3::dot11s::IeMeshId::PeekString ( void  ) const

Definition at line 81 of file ie-dot11s-id.cc.

References m_meshId.

Referenced by Print().

+ Here is the caller graph for this function:

void ns3::dot11s::IeMeshId::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 116 of file ie-dot11s-id.cc.

References ElementId(), and PeekString().

Referenced by ns3::dot11s::operator<<(), and ns3::dot11s::PeerLinkFrameStart::Print().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::dot11s::IeMeshId::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 97 of file ie-dot11s-id.cc.

References m_meshId, and ns3::Buffer::Iterator::WriteU8().

+ Here is the call graph for this function:

Friends And Related Function Documentation

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

Definition at line 123 of file ie-dot11s-id.cc.

Member Data Documentation

uint8_t ns3::dot11s::IeMeshId::m_meshId[33]
private

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