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

The CF Parameter SetThis class knows how to serialise and deserialise the CF Parameter Set. More...

#include "cf-parameter-set.h"

+ Inheritance diagram for ns3::CfParameterSet:
+ Collaboration diagram for ns3::CfParameterSet:

Public Member Functions

 CfParameterSet ()
 
uint8_t DeserializeInformationField (Buffer::Iterator start, uint8_t length)
 Deserialize information field function. More...
 
WifiInformationElementId ElementId () const
 Element ID function. More...
 
uint8_t GetCFPCount (void) const
 Return the CFP Count in DTIM frames unit. More...
 
uint64_t GetCFPDurRemainingUs (void) const
 Return the CFP DurRemaining in microseconds. More...
 
uint64_t GetCFPMaxDurationUs (void) const
 Return the CFP MaxDuration in microseconds. More...
 
uint8_t GetCFPPeriod (void) const
 Return the CFP Period in DTIM frames unit. More...
 
uint8_t GetInformationFieldSize () const
 Get information field size function. More...
 
uint16_t GetSerializedSize () const
 Return the serialized size of this EDCA Parameter Set. More...
 
Buffer::Iterator Serialize (Buffer::Iterator start) const
 This information element is a bit special in that it is only included if the STA is a QoS STA. More...
 
void SerializeInformationField (Buffer::Iterator start) const
 Serialize information field function. More...
 
void SetCFPCount (uint8_t cfpcount)
 Set the CFP Count in DTIM frames unit. More...
 
void SetCFPDurRemainingUs (uint64_t cfpdurremaining)
 Set the CFP MaxDuration in microseconds. More...
 
void SetCFPMaxDurationUs (uint64_t cfpmaxduration)
 Set the CFP MaxDuration in microseconds. More...
 
void SetCFPPeriod (uint8_t cfpperiod)
 Set the CFP Period in DTIM frames unit. More...
 
void SetPcfSupported (uint8_t pcfSupported)
 Set PCF supported 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...
 
virtual void Print (std::ostream &os) const
 Generate human-readable form of IE. 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

uint8_t m_CFPCount
 CFP Count. More...
 
uint64_t m_CFPDurRemaining
 CFP DurRemaining. More...
 
uint64_t m_CFPMaxDuration
 CFP MaxDuration. More...
 
uint8_t m_CFPPeriod
 CFP Period. More...
 
uint8_t m_pcfSupported
 This is used to decide if this element should be added to the frame or not. More...
 

Detailed Description

The CF Parameter Set

This class knows how to serialise and deserialise the CF Parameter Set.

Definition at line 34 of file cf-parameter-set.h.

Constructor & Destructor Documentation

ns3::CfParameterSet::CfParameterSet ( )

Definition at line 25 of file cf-parameter-set.cc.

Member Function Documentation

uint8_t ns3::CfParameterSet::DeserializeInformationField ( Buffer::Iterator  start,
uint8_t  length 
)
virtual

Deserialize information field function.

Parameters
startthe iterator
lengththe length
Returns
the size

Implements ns3::WifiInformationElement.

Definition at line 87 of file cf-parameter-set.cc.

References m_CFPCount, m_CFPDurRemaining, m_CFPMaxDuration, m_CFPPeriod, NS_ASSERT, ns3::Buffer::Iterator::ReadLsbtohU16(), ns3::Buffer::Iterator::ReadU8(), and visualizer.core::start().

+ Here is the call graph for this function:

WifiInformationElementId ns3::CfParameterSet::ElementId ( ) const
virtual

Element ID function.

Returns
the wifi information element ID

Implements ns3::WifiInformationElement.

Definition at line 35 of file cf-parameter-set.cc.

References IE_CF_PARAMETER_SET.

uint8_t ns3::CfParameterSet::GetCFPCount ( void  ) const

Return the CFP Count in DTIM frames unit.

Returns
the CFP Count in DTIM frames unit

Definition at line 102 of file cf-parameter-set.cc.

References m_CFPCount.

Referenced by ns3::operator<<(), and ns3::StaWifiMac::Receive().

+ Here is the caller graph for this function:

uint64_t ns3::CfParameterSet::GetCFPDurRemainingUs ( void  ) const

Return the CFP DurRemaining in microseconds.

Returns
the CFP DurRemaining in microseconds

Definition at line 120 of file cf-parameter-set.cc.

References m_CFPDurRemaining.

Referenced by ns3::operator<<(), and ns3::StaWifiMac::Receive().

+ Here is the caller graph for this function:

uint64_t ns3::CfParameterSet::GetCFPMaxDurationUs ( void  ) const

Return the CFP MaxDuration in microseconds.

Returns
the CFP MaxDuration in microseconds.

Definition at line 114 of file cf-parameter-set.cc.

References m_CFPMaxDuration.

Referenced by ns3::operator<<(), and ns3::StaWifiMac::Receive().

+ Here is the caller graph for this function:

uint8_t ns3::CfParameterSet::GetCFPPeriod ( void  ) const

Return the CFP Period in DTIM frames unit.

Returns
the CFP Period in DTIM frames unit

Definition at line 108 of file cf-parameter-set.cc.

References m_CFPPeriod.

Referenced by ns3::operator<<().

+ Here is the caller graph for this function:

uint8_t ns3::CfParameterSet::GetInformationFieldSize ( void  ) const
virtual

Get information field size function.

Returns
the information field size

Implements ns3::WifiInformationElement.

Definition at line 47 of file cf-parameter-set.cc.

References m_pcfSupported, and NS_ASSERT.

uint16_t ns3::CfParameterSet::GetSerializedSize ( void  ) const

Return the serialized size of this EDCA Parameter Set.

Returns
the serialized size of this EDCA Parameter Set

Definition at line 65 of file cf-parameter-set.cc.

References ns3::WifiInformationElement::GetSerializedSize(), and m_pcfSupported.

+ Here is the call graph for this function:

Buffer::Iterator ns3::CfParameterSet::Serialize ( Buffer::Iterator  start) const

This information element is a bit special in that it is only included if the STA is a QoS STA.

To support this we override the Serialize and GetSerializedSize methods of WifiInformationElement.

Parameters
start
Returns
an iterator

Definition at line 55 of file cf-parameter-set.cc.

References m_pcfSupported, and ns3::WifiInformationElement::Serialize().

+ Here is the call graph for this function:

void ns3::CfParameterSet::SerializeInformationField ( Buffer::Iterator  start) const
virtual

Serialize information field function.

Parameters
startthe iterator

Implements ns3::WifiInformationElement.

Definition at line 75 of file cf-parameter-set.cc.

References m_CFPCount, m_CFPDurRemaining, m_CFPMaxDuration, m_CFPPeriod, m_pcfSupported, ns3::Buffer::Iterator::WriteHtolsbU16(), and ns3::Buffer::Iterator::WriteU8().

+ Here is the call graph for this function:

void ns3::CfParameterSet::SetCFPCount ( uint8_t  cfpcount)

Set the CFP Count in DTIM frames unit.

Parameters
cfpcountthe CFP Count in DTIM frames unit

Definition at line 126 of file cf-parameter-set.cc.

References m_CFPCount.

Referenced by ns3::ApWifiMac::GetCfParameterSet().

+ Here is the caller graph for this function:

void ns3::CfParameterSet::SetCFPDurRemainingUs ( uint64_t  cfpdurremaining)

Set the CFP MaxDuration in microseconds.

Parameters
cfpdurremainingthe CFP DurRemaining in microseconds

Definition at line 144 of file cf-parameter-set.cc.

References m_CFPDurRemaining.

Referenced by ns3::ApWifiMac::GetCfParameterSet().

+ Here is the caller graph for this function:

void ns3::CfParameterSet::SetCFPMaxDurationUs ( uint64_t  cfpmaxduration)

Set the CFP MaxDuration in microseconds.

Parameters
cfpmaxdurationthe CFP MaxDuration in microseconds

Definition at line 138 of file cf-parameter-set.cc.

References m_CFPMaxDuration.

Referenced by ns3::ApWifiMac::GetCfParameterSet().

+ Here is the caller graph for this function:

void ns3::CfParameterSet::SetCFPPeriod ( uint8_t  cfpperiod)

Set the CFP Period in DTIM frames unit.

Parameters
cfpperiodthe CFP Period in DTIM frames unit

Definition at line 132 of file cf-parameter-set.cc.

References m_CFPPeriod.

Referenced by ns3::ApWifiMac::GetCfParameterSet().

+ Here is the caller graph for this function:

void ns3::CfParameterSet::SetPcfSupported ( uint8_t  pcfSupported)

Set PCF supported function.

Parameters
pcfSupportedthe PCF supported indicator

Definition at line 41 of file cf-parameter-set.cc.

References m_pcfSupported.

Referenced by ns3::ApWifiMac::GetCfParameterSet().

+ Here is the caller graph for this function:

Member Data Documentation

uint8_t ns3::CfParameterSet::m_CFPCount
private
uint64_t ns3::CfParameterSet::m_CFPDurRemaining
private
uint64_t ns3::CfParameterSet::m_CFPMaxDuration
private
uint8_t ns3::CfParameterSet::m_CFPPeriod
private
uint8_t ns3::CfParameterSet::m_pcfSupported
private

This is used to decide if this element should be added to the frame or not.

Definition at line 143 of file cf-parameter-set.h.

Referenced by GetInformationFieldSize(), GetSerializedSize(), Serialize(), SerializeInformationField(), and SetPcfSupported().


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