A Discrete-Event Network Simulator
API
ns3::AmpduSubframeHeader Class Reference

Introspection did not find any typical Config paths. More...

#include "ampdu-subframe-header.h"

+ Inheritance diagram for ns3::AmpduSubframeHeader:
+ Collaboration diagram for ns3::AmpduSubframeHeader:

Public Member Functions

 AmpduSubframeHeader ()
 
virtual ~AmpduSubframeHeader ()
 
virtual uint32_t Deserialize (Buffer::Iterator start)
 
uint8_t GetCrc (void) const
 Return the CRC field. More...
 
bool GetEof (void) const
 Return the EOF field. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
uint16_t GetLength (void) const
 Return the length field. More...
 
virtual uint32_t GetSerializedSize (void) const
 
uint8_t GetSig (void) const
 Return the SIG field. More...
 
virtual void Print (std::ostream &os) const
 
virtual void Serialize (Buffer::Iterator start) const
 
void SetCrc (uint8_t crc)
 Set the CRC field. More...
 
void SetEof (bool eof)
 Set the EOF field. More...
 
void SetLength (uint16_t length)
 Set the length field. More...
 
void SetSig ()
 Set the SIG field. More...
 
- Public Member Functions inherited from ns3::Header
virtual ~Header ()
 
- 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)
 
- 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...
 

Protected Attributes

uint8_t m_crc
 CRC field. More...
 
bool m_eof
 EOF field. More...
 
uint16_t m_length
 length field More...
 
uint8_t m_sig
 SIG 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...
 

Detailed Description

Introspection did not find any typical Config paths.


No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 16 bytes (on a 64-bit architecture).

Definition at line 34 of file ampdu-subframe-header.h.

Constructor & Destructor Documentation

ns3::AmpduSubframeHeader::AmpduSubframeHeader ( )

Definition at line 46 of file ampdu-subframe-header.cc.

ns3::AmpduSubframeHeader::~AmpduSubframeHeader ( )
virtual

Definition at line 52 of file ampdu-subframe-header.cc.

Member Function Documentation

uint32_t ns3::AmpduSubframeHeader::Deserialize ( Buffer::Iterator  start)
virtual
Parameters
startan 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 71 of file ampdu-subframe-header.cc.

References ns3::Buffer::Iterator::GetDistanceFrom(), m_crc, m_eof, m_length, m_sig, ns3::Buffer::Iterator::ReadLsbtohU16(), ns3::Buffer::Iterator::ReadU8(), and visualizer.core::start().

+ Here is the call graph for this function:

uint8_t ns3::AmpduSubframeHeader::GetCrc ( void  ) const

Return the CRC field.

Returns
the CRC field

Definition at line 117 of file ampdu-subframe-header.cc.

References m_crc.

Referenced by ns3::WifiPhyHelper::PcapSniffRxEvent(), and ns3::WifiPhyHelper::PcapSniffTxEvent().

+ Here is the caller graph for this function:

bool ns3::AmpduSubframeHeader::GetEof ( void  ) const

Return the EOF field.

Returns
the EOF field

Definition at line 135 of file ampdu-subframe-header.cc.

References m_eof.

Referenced by ns3::WifiPhyHelper::PcapSniffRxEvent(), and ns3::WifiPhyHelper::PcapSniffTxEvent().

+ Here is the caller graph for this function:

TypeId ns3::AmpduSubframeHeader::GetInstanceTypeId ( void  ) const
virtual

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 41 of file ampdu-subframe-header.cc.

References GetTypeId().

+ Here is the call graph for this function:

uint16_t ns3::AmpduSubframeHeader::GetLength ( void  ) const

Return the length field.

Returns
the length field

Definition at line 129 of file ampdu-subframe-header.cc.

References m_length.

Referenced by ns3::MpduAggregator::Deaggregate(), ns3::WifiPhyHelper::PcapSniffRxEvent(), and ns3::WifiPhyHelper::PcapSniffTxEvent().

+ Here is the caller graph for this function:

uint32_t ns3::AmpduSubframeHeader::GetSerializedSize ( void  ) const
virtual
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 57 of file ampdu-subframe-header.cc.

uint8_t ns3::AmpduSubframeHeader::GetSig ( void  ) const

Return the SIG field.

Returns
the SIG field

Definition at line 123 of file ampdu-subframe-header.cc.

References m_sig.

TypeId ns3::AmpduSubframeHeader::GetTypeId ( void  )
static

Definition at line 30 of file ampdu-subframe-header.cc.

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::AmpduSubframeHeader::Print ( std::ostream &  os) const
virtual
Parameters
osoutput 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 83 of file ampdu-subframe-header.cc.

References m_crc, m_eof, m_length, and m_sig.

void ns3::AmpduSubframeHeader::Serialize ( Buffer::Iterator  start) const
virtual
Parameters
startan 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 63 of file ampdu-subframe-header.cc.

References m_crc, m_eof, m_length, m_sig, ns3::Buffer::Iterator::WriteHtolsbU16(), and ns3::Buffer::Iterator::WriteU8().

+ Here is the call graph for this function:

void ns3::AmpduSubframeHeader::SetCrc ( uint8_t  crc)

Set the CRC field.

Parameters
crc

Definition at line 92 of file ampdu-subframe-header.cc.

References m_crc.

Referenced by ns3::MpduStandardAggregator::AddHeaderAndPad(), ns3::MpduStandardAggregator::Aggregate(), and ns3::MpduStandardAggregator::AggregateVhtSingleMpdu().

+ Here is the caller graph for this function:

void ns3::AmpduSubframeHeader::SetEof ( bool  eof)

Set the EOF field.

Parameters
eof

Definition at line 111 of file ampdu-subframe-header.cc.

References m_eof.

Referenced by ns3::MpduStandardAggregator::AddHeaderAndPad(), and ns3::MpduStandardAggregator::AggregateVhtSingleMpdu().

+ Here is the caller graph for this function:

void ns3::AmpduSubframeHeader::SetLength ( uint16_t  length)

Set the length field.

Parameters
length

Definition at line 105 of file ampdu-subframe-header.cc.

References m_length.

Referenced by ns3::MpduStandardAggregator::AddHeaderAndPad(), ns3::MpduStandardAggregator::Aggregate(), and ns3::MpduStandardAggregator::AggregateVhtSingleMpdu().

+ Here is the caller graph for this function:

void ns3::AmpduSubframeHeader::SetSig ( )

Set the SIG field.

Parameters
crc

Definition at line 98 of file ampdu-subframe-header.cc.

References m_sig.

Referenced by ns3::MpduStandardAggregator::AddHeaderAndPad(), ns3::MpduStandardAggregator::Aggregate(), and ns3::MpduStandardAggregator::AggregateVhtSingleMpdu().

+ Here is the caller graph for this function:

Member Data Documentation

uint8_t ns3::AmpduSubframeHeader::m_crc
protected

CRC field.

Definition at line 97 of file ampdu-subframe-header.h.

Referenced by Deserialize(), GetCrc(), Print(), Serialize(), and SetCrc().

bool ns3::AmpduSubframeHeader::m_eof
protected

EOF field.

Definition at line 100 of file ampdu-subframe-header.h.

Referenced by Deserialize(), GetEof(), Print(), Serialize(), and SetEof().

uint16_t ns3::AmpduSubframeHeader::m_length
protected

length field

Definition at line 99 of file ampdu-subframe-header.h.

Referenced by Deserialize(), GetLength(), Print(), Serialize(), and SetLength().

uint8_t ns3::AmpduSubframeHeader::m_sig
protected

SIG field.

Definition at line 98 of file ampdu-subframe-header.h.

Referenced by Deserialize(), GetSig(), Print(), Serialize(), and SetSig().


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