DSSS SIG PHY header. More...

#include "dsss-ppdu.h"

Inheritance diagram for ns3::DsssPpdu::DsssSigHeader:

Collaboration diagram for ns3::DsssPpdu::DsssSigHeader:

Public Member Functions
	DsssSigHeader ()

virtual	~DsssSigHeader ()

uint32_t	Deserialize (Buffer::Iterator start) override

TypeId	GetInstanceTypeId (void) const override
	Get the most derived TypeId for this Object. More...

uint16_t	GetLength (void) const
	Return the LENGTH field of L-SIG (in bytes). More...

uint64_t	GetRate (void) const
	Return the RATE field of L-SIG (in bit/s). More...

uint32_t	GetSerializedSize (void) const override

void	Print (std::ostream &os) const override

void	Serialize (Buffer::Iterator start) const override

void	SetLength (uint16_t length)
	Fill the LENGTH field of L-SIG (in bytes). More...

void	SetRate (uint64_t rate)
	Fill the RATE field of L-SIG (in bit/s). More...

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

virtual uint32_t	Deserialize (Buffer::Iterator start)=0
	Deserialize the object from a buffer iterator. More...

virtual uint32_t	Deserialize (Buffer::Iterator start, Buffer::Iterator end)
	Deserialize the object from a buffer iterator. More...

Public Member Functions inherited from ns3::Chunk
virtual uint32_t	Deserialize (Buffer::Iterator start, Buffer::Iterator end)
	Deserialize the object from a buffer iterator. More...

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor. More...

void	GetAttribute (std::string name, AttributeValue &value) const
	Get the value of an attribute, raising fatal errors if unsuccessful. More...

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising erros. More...

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful. More...

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors. More...

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context. More...

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context. More...

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context. More...

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context. More...

Static Public Member Functions
static TypeId	GetTypeId (void)
	Get the type ID. More...

Static Public Member Functions inherited from ns3::Header
static TypeId	GetTypeId (void)
	Get the type ID. More...

Static Public Member Functions inherited from ns3::Chunk
static TypeId	GetTypeId (void)
	Get the type ID. More...

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)
	Get the type ID. More...

Private Attributes
uint16_t	m_length
	LENGTH field. More...

uint8_t	m_rate
	RATE field. More...

Additional Inherited Members
Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes. More...

virtual void	NotifyConstructionCompleted (void)
	Notifier called once the ObjectBase is fully constructed. More...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

Detailed Description

DSSS SIG PHY header.

See section 16.2.2 in IEEE 802.11-2016.

Definition at line 53 of file dsss-ppdu.h.

Constructor & Destructor Documentation

◆ DsssSigHeader()

ns3::DsssPpdu::DsssSigHeader::DsssSigHeader ( )

Definition at line 71 of file dsss-ppdu.cc.

◆ ~DsssSigHeader()

ns3::DsssPpdu::DsssSigHeader::~DsssSigHeader ( )

virtual

Definition at line 77 of file dsss-ppdu.cc.

Member Function Documentation

◆ Deserialize()

uint32_t ns3::DsssPpdu::DsssSigHeader::Deserialize ( Buffer::Iterator start )

overridevirtual

Parameters

start an iterator which points to where the header should read from.

Returns: the number of bytes read.

This method is used by Packet::RemoveHeader to re-create a header from the byte buffer of a packet. The data read is expected to match bit-for-bit the representation of this header in real networks.

Note that data is not actually removed from the buffer to which the iterator points. Both Packet::RemoveHeader() and Packet::PeekHeader() call Deserialize(), but only the RemoveHeader() has additional statements to remove the header bytes from the underlying buffer and associated metadata.

Implements ns3::Header.

Definition at line 187 of file dsss-ppdu.cc.

References ns3::Buffer::Iterator::GetDistanceFrom(), ns3::Buffer::Iterator::ReadU16(), ns3::Buffer::Iterator::ReadU8(), and visualizer.core::start().

Here is the call graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::DsssPpdu::DsssSigHeader::GetInstanceTypeId ( void ) const

overridevirtual

Get the most derived TypeId for this Object.

This method is typically implemented by ns3::Object::GetInstanceTypeId but some classes which derive from ns3::ObjectBase directly have to implement it themselves.

Returns: The TypeId associated to the most-derived type of this instance.

Implements ns3::ObjectBase.

Definition at line 93 of file dsss-ppdu.cc.

◆ GetLength()

uint16_t ns3::DsssPpdu::DsssSigHeader::GetLength ( void ) const

Return the LENGTH field of L-SIG (in bytes).

Returns: the LENGTH field of L-SIG expressed in bytes

Definition at line 172 of file dsss-ppdu.cc.

Referenced by ns3::DsssPpdu::GetTxDuration().

Here is the caller graph for this function:

◆ GetRate()

uint64_t ns3::DsssPpdu::DsssSigHeader::GetRate ( void ) const

Return the RATE field of L-SIG (in bit/s).

Returns: the RATE field of L-SIG expressed in bit/s

Definition at line 141 of file dsss-ppdu.cc.

References NS_ASSERT_MSG.

Referenced by ns3::DsssPpdu::DoGetTxVector().

Here is the caller graph for this function:

◆ GetSerializedSize()

uint32_t ns3::DsssPpdu::DsssSigHeader::GetSerializedSize ( void ) const

overridevirtual

Returns: the expected size of the header.

This method is used by Packet::AddHeader to store a header into the byte buffer of a packet. This method should return the number of bytes which are needed to store the full header data by Serialize.

Implements ns3::Header.

Definition at line 106 of file dsss-ppdu.cc.

◆ GetTypeId()

TypeId ns3::DsssPpdu::DsssSigHeader::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

Definition at line 82 of file dsss-ppdu.cc.

References ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ Print()

void ns3::DsssPpdu::DsssSigHeader::Print ( std::ostream & os ) const

overridevirtual

Parameters

os output stream This method is used by Packet::Print to print the content of a header as ascii data to a c++ output stream. Although the header is free to format its output as it wishes, it is recommended to follow a few rules to integrate with the packet pretty printer: start with flags, small field values located between a pair of parens. Values should be separated by whitespace. Follow the parens with the important fields, separated by whitespace. i.e.: (field1 val1 field2 val2 field3 val3) field4 val4 field5 val5

Implements ns3::Header.

Definition at line 99 of file dsss-ppdu.cc.

◆ Serialize()

void ns3::DsssPpdu::DsssSigHeader::Serialize ( Buffer::Iterator start ) const

overridevirtual

Parameters

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

This method is used by Packet::AddHeader to store a header into the byte buffer of a packet. The data written is expected to match bit-for-bit the representation of this header in a real network.

Implements ns3::Header.

Definition at line 178 of file dsss-ppdu.cc.

References visualizer.core::start().

Here is the call graph for this function:

◆ SetLength()

void ns3::DsssPpdu::DsssSigHeader::SetLength ( uint16_t length )

Fill the LENGTH field of L-SIG (in bytes).

Parameters

length the LENGTH field of L-SIG expressed in bytes

Definition at line 166 of file dsss-ppdu.cc.

Referenced by ns3::DsssPpdu::DsssPpdu().

Here is the caller graph for this function:

◆ SetRate()

void ns3::DsssPpdu::DsssSigHeader::SetRate ( uint64_t rate )

Fill the RATE field of L-SIG (in bit/s).

Parameters

rate	the RATE field of L-SIG expressed in bit/s

Definition at line 112 of file dsss-ppdu.cc.

References NS_ASSERT_MSG.

Referenced by ns3::DsssPpdu::DsssPpdu().

Here is the caller graph for this function:

Member Data Documentation

◆ m_length

uint16_t ns3::DsssPpdu::DsssSigHeader::m_length

private

LENGTH field.

Definition at line 98 of file dsss-ppdu.h.

◆ m_rate

uint8_t ns3::DsssPpdu::DsssSigHeader::m_rate

private

RATE field.

Definition at line 97 of file dsss-ppdu.h.

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

src/wifi/model/non-ht/dsss-ppdu.h
src/wifi/model/non-ht/dsss-ppdu.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DsssSigHeader()

◆ ~DsssSigHeader()

Member Function Documentation

◆ Deserialize()

◆ GetInstanceTypeId()

◆ GetLength()

◆ GetRate()

◆ GetSerializedSize()

◆ GetTypeId()

◆ Print()

◆ Serialize()

◆ SetLength()

◆ SetRate()

Member Data Documentation

◆ m_length

◆ m_rate