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

Headers for Trigger frames. More...

#include "ctrl-headers.h"

+ Inheritance diagram for ns3::CtrlTriggerHeader:
+ Collaboration diagram for ns3::CtrlTriggerHeader:

Public Types

typedef std::list< CtrlTriggerUserInfoField >::const_iterator ConstIterator
 User Info fields list const iterator. More...
 
typedef std::list< CtrlTriggerUserInfoField >::iterator Iterator
 User Info fields list iterator. More...
 

Public Member Functions

 CtrlTriggerHeader ()
 
 CtrlTriggerHeader (TriggerFrameType type, const WifiTxVector &txVector)
 Constructor. More...
 
 ~CtrlTriggerHeader ()
 
CtrlTriggerUserInfoFieldAddUserInfoField (void)
 Append a new User Info field to this Trigger frame and return a non-const reference to it. More...
 
CtrlTriggerUserInfoFieldAddUserInfoField (const CtrlTriggerUserInfoField &userInfo)
 Append the given User Info field to this Trigger frame and return a non-const reference to it. More...
 
ConstIterator begin (void) const
 Get a const iterator pointing to the first User Info field in the list. More...
 
Iterator begin (void)
 Get an iterator pointing to the first User Info field in the list. More...
 
uint32_t Deserialize (Buffer::Iterator start)
 
ConstIterator end (void) const
 Get a const iterator indicating past-the-last User Info field in the list. More...
 
Iterator end (void)
 Get an iterator indicating past-the-last User Info field in the list. More...
 
ConstIterator FindUserInfoWithAid (ConstIterator start, uint16_t aid12) const
 Get a const iterator pointing to the first User Info field found (starting from the one pointed to by the given iterator) whose AID12 subfield is set to the given value. More...
 
ConstIterator FindUserInfoWithAid (uint16_t aid12) const
 Get a const iterator pointing to the first User Info field found whose AID12 subfield is set to the given value. More...
 
ConstIterator FindUserInfoWithRaRuAssociated (ConstIterator start) const
 Get a const iterator pointing to the first User Info field found (starting from the one pointed to by the given iterator) which allocates a Random Access RU for associated stations. More...
 
ConstIterator FindUserInfoWithRaRuAssociated (void) const
 Get a const iterator pointing to the first User Info field found which allocates a Random Access RU for associated stations. More...
 
ConstIterator FindUserInfoWithRaRuUnassociated (ConstIterator start) const
 Get a const iterator pointing to the first User Info field found (starting from the one pointed to by the given iterator) which allocates a Random Access RU for unassociated stations. More...
 
ConstIterator FindUserInfoWithRaRuUnassociated (void) const
 Get a const iterator pointing to the first User Info field found which allocates a Random Access RU for unassociated stations. More...
 
int8_t GetApTxPower (void) const
 Get the power value (dBm) indicated by the AP TX Power subfield of the Common Info field. More...
 
CtrlTriggerHeader GetCommonInfoField (void) const
 Get a copy of the Common Info field of this Trigger frame. More...
 
bool GetCsRequired (void) const
 Get the CS Required subfield of the Common Info field. More...
 
uint16_t GetGuardInterval (void) const
 Get the guard interval duration (in nanoseconds) of the solicited HE TB PPDU. More...
 
WifiTxVector GetHeTbTxVector (uint16_t staId) const
 Get the TX vector that the station with the given STA-ID will use to send the HE TB PPDU solicited by this Trigger Frame. More...
 
TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
uint8_t GetLtfType (void) const
 Get the LTF type of the solicited HE TB PPDU. More...
 
bool GetMoreTF (void) const
 Get the More TF subfield of the Common Info field. More...
 
std::size_t GetNUserInfoFields (void) const
 Get the number of User Info fields in this Trigger Frame. More...
 
uint32_t GetSerializedSize (void) const
 
TriggerFrameType GetType (void) const
 Get the Trigger Frame type. More...
 
const char * GetTypeString (void) const
 Return a string corresponding to the Trigger Frame type. More...
 
uint16_t GetUlBandwidth (void) const
 Get the bandwidth of the solicited HE TB PPDU. More...
 
uint16_t GetUlLength (void) const
 Get the UL Length subfield of the Common Info field. More...
 
uint16_t GetUlSpatialReuse (void) const
 Get the UL Spatial Reuse subfield of the Common Info field. More...
 
bool IsBasic (void) const
 Check if this is a Basic Trigger frame. More...
 
bool IsBfrp (void) const
 Check if this is a Beamforming Report Poll Trigger frame. More...
 
bool IsBqrp (void) const
 Check if this is a Bandwidth Query Report Poll Trigger frame. More...
 
bool IsBsrp (void) const
 Check if this is a Buffer Status Report Poll Trigger frame. More...
 
bool IsGcrMuBar (void) const
 Check if this is a Groupcast with Retries (GCR) MU-BAR Trigger frame. More...
 
bool IsMuBar (void) const
 Check if this is a MU-BAR Trigger frame. More...
 
bool IsMuRts (void) const
 Check if this is a MU-RTS Trigger frame. More...
 
bool IsNfrp (void) const
 Check if this is a NDP Feedback Report Poll Trigger frame. More...
 
bool IsValid (void) const
 Check the validity of this Trigger frame. More...
 
CtrlTriggerHeaderoperator= (const CtrlTriggerHeader &trigger)
 Copy assignment operator. More...
 
void Print (std::ostream &os) const
 
void Serialize (Buffer::Iterator start) const
 
void SetApTxPower (int8_t power)
 Set the AP TX Power subfield of the Common Info field. More...
 
void SetCsRequired (bool cs)
 Set the CS Required subfield of the Common Info field. More...
 
void SetGiAndLtfType (uint16_t guardInterval, uint8_t ltfType)
 Set the GI And LTF Type subfield of the Common Info field. More...
 
void SetMoreTF (bool more)
 Set the More TF subfield of the Common Info field. More...
 
void SetType (TriggerFrameType type)
 Set the Trigger frame type. More...
 
void SetUlBandwidth (uint16_t bw)
 Set the bandwidth of the solicited HE TB PPDU. More...
 
void SetUlLength (uint16_t len)
 Set the UL Length subfield of the Common Info field. More...
 
void SetUlSpatialReuse (uint16_t sr)
 Set the UL Spatial Reuse subfield of the Common Info field. More...
 
- Public Member Functions inherited from ns3::Header
virtual ~Header ()
 
virtual uint32_t Deserialize (Buffer::Iterator start, Buffer::Iterator end)
 Deserialize the object from a buffer iterator. More...
 
virtual uint32_t Deserialize (Buffer::Iterator start)=0
 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 const char * GetTypeString (TriggerFrameType type)
 Return a string corresponding to the given Trigger Frame type. 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

uint8_t m_apTxPower
 Tx Power used by AP to transmit the Trigger Frame. More...
 
bool m_csRequired
 Carrier Sense required. More...
 
uint8_t m_giAndLtfType
 GI And LTF Type subfield. More...
 
bool m_moreTF
 True if a subsequent Trigger frame follows. More...
 
uint8_t m_triggerType
 Common Info field. More...
 
uint8_t m_ulBandwidth
 UL BW subfield. More...
 
uint16_t m_ulLength
 Value for the L-SIG Length field. More...
 
uint16_t m_ulSpatialReuse
 Value for the Spatial Reuse field in HE-SIG-A. More...
 
std::list< CtrlTriggerUserInfoFieldm_userInfoFields
 List of User Info fields. 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

Headers for Trigger frames.


Introspection did not find any typical Config paths.

802.11ax amendment defines eight types of Trigger frames (see Section 9.3.1.23 of D3.0):

  • Basic
  • Beamforming Report Poll (BFRP)
  • Multi-User Block Ack Request (MU-BAR)
  • Multi-User Request To Send (MU-RTS)
  • Buffer Status Report Poll (BSRP)
  • Groupcast with Retries (GCR) MU-BAR
  • Bandwidth Query Report Poll (BQRP)
  • NDP Feedback Report Poll (NFRP) For now only the Basic, MU-BAR, MU-RTS, BSRP and BQRP variants are supported. Basic Trigger is also the default variant.

The Padding field is optional, given that other techniques (post-EOF A-MPDU padding, aggregating other MPDUs in the A-MPDU) are available to satisfy the minimum time requirement. Currently, however, a Padding field of the minimum length (2 octets) is appended to every Trigger frame that is transmitted. In such a way, deserialization stops when a User Info field with the AID12 subfield set to 4095 (which indicates the start of a Padding field) is encountered.


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

Definition at line 885 of file ctrl-headers.h.

Member Typedef Documentation

◆ ConstIterator

User Info fields list const iterator.

Definition at line 1140 of file ctrl-headers.h.

◆ Iterator

User Info fields list iterator.

Definition at line 1143 of file ctrl-headers.h.

Constructor & Destructor Documentation

◆ CtrlTriggerHeader() [1/2]

ns3::CtrlTriggerHeader::CtrlTriggerHeader ( )

Definition at line 1534 of file ctrl-headers.cc.

◆ CtrlTriggerHeader() [2/2]

ns3::CtrlTriggerHeader::CtrlTriggerHeader ( TriggerFrameType  type,
const WifiTxVector txVector 
)

Constructor.

Construct a Trigger Frame of the given type from the values stored in the given TX vector. In particular:

  • the UL Bandwidth, UL Length and GI And LTF Type subfields of the Common Info field are set based on the values stored in the TX vector;
  • as many User Info fields as the number of entries in the HeMuUserInfoMap of the TX vector are added to the Trigger Frame. The AID12, RU Allocation, UL MCS and SS Allocation subfields of each User Info field are set based on the values stored in the corresponding entry of the HeMuUserInfoMap.
Parameters
typethe Trigger frame type
txVectorthe TX vector used to build this Trigger Frame

Definition at line 1546 of file ctrl-headers.cc.

References AddUserInfoField(), ns3::WifiTxVector::GetChannelWidth(), ns3::WifiTxVector::GetGuardInterval(), ns3::WifiTxVector::GetHeMuUserInfoMap(), ns3::WifiTxVector::GetLength(), m_giAndLtfType, m_triggerType, ns3::CtrlTriggerUserInfoField::SetAid12(), ns3::CtrlTriggerUserInfoField::SetRuAllocation(), ns3::CtrlTriggerUserInfoField::SetSsAllocation(), SetUlBandwidth(), SetUlLength(), and ns3::CtrlTriggerUserInfoField::SetUlMcs().

+ Here is the call graph for this function:

◆ ~CtrlTriggerHeader()

ns3::CtrlTriggerHeader::~CtrlTriggerHeader ( )

Definition at line 1571 of file ctrl-headers.cc.

Member Function Documentation

◆ AddUserInfoField() [1/2]

CtrlTriggerUserInfoField & ns3::CtrlTriggerHeader::AddUserInfoField ( void  )

Append a new User Info field to this Trigger frame and return a non-const reference to it.

Make sure to call this method after setting the type of the Trigger frame.

Returns
a non-const reference to the newly added User Info field

Definition at line 1989 of file ctrl-headers.cc.

References m_triggerType, and m_userInfoFields.

Referenced by CtrlTriggerHeader(), Deserialize(), and ns3::GetMuBarSize().

+ Here is the caller graph for this function:

◆ AddUserInfoField() [2/2]

CtrlTriggerUserInfoField & ns3::CtrlTriggerHeader::AddUserInfoField ( const CtrlTriggerUserInfoField userInfo)

Append the given User Info field to this Trigger frame and return a non-const reference to it.

Make sure that the type of the given User Info field matches the type of this Trigger Frame.

Parameters
userInfothe User Info field to append to this Trigger Frame
Returns
a non-const reference to the newly added User Info field

Definition at line 1996 of file ctrl-headers.cc.

References ns3::CtrlTriggerUserInfoField::GetType(), m_triggerType, m_userInfoFields, and NS_ABORT_MSG_IF.

+ Here is the call graph for this function:

◆ begin() [1/2]

CtrlTriggerHeader::ConstIterator ns3::CtrlTriggerHeader::begin ( void  ) const

Get a const iterator pointing to the first User Info field in the list.

Returns
a const iterator pointing to the first User Info field in the list

Definition at line 2005 of file ctrl-headers.cc.

References m_userInfoFields.

Referenced by ns3::RrMultiUserScheduler::TrySendingBsrpTf().

+ Here is the caller graph for this function:

◆ begin() [2/2]

CtrlTriggerHeader::Iterator ns3::CtrlTriggerHeader::begin ( void  )

Get an iterator pointing to the first User Info field in the list.

Returns
an iterator pointing to the first User Info field in the list

Definition at line 2017 of file ctrl-headers.cc.

References m_userInfoFields.

◆ Deserialize()

uint32_t ns3::CtrlTriggerHeader::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 1678 of file ctrl-headers.cc.

References AddUserInfoField(), ns3::BFRP_TRIGGER, ns3::CtrlTriggerUserInfoField::Deserialize(), ns3::GCR_MU_BAR_TRIGGER, ns3::Buffer::Iterator::GetDistanceFrom(), m_apTxPower, m_csRequired, m_giAndLtfType, m_moreTF, m_triggerType, m_ulBandwidth, m_ulLength, m_ulSpatialReuse, m_userInfoFields, ns3::NFRP_TRIGGER, NS_ABORT_MSG_IF, ns3::Buffer::Iterator::Prev(), ns3::Buffer::Iterator::ReadLsbtohU64(), ns3::Buffer::Iterator::ReadU16(), and visualizer.core::start().

+ Here is the call graph for this function:

◆ end() [1/2]

CtrlTriggerHeader::ConstIterator ns3::CtrlTriggerHeader::end ( void  ) const

Get a const iterator indicating past-the-last User Info field in the list.

Returns
a const iterator indicating past-the-last User Info field in the list

Definition at line 2011 of file ctrl-headers.cc.

References m_userInfoFields.

Referenced by FindUserInfoWithAid(), ns3::HeFrameExchangeManager::GetHeTbTxVector(), GetHeTbTxVector(), ns3::HeFrameExchangeManager::ReceiveMpdu(), and ns3::RrMultiUserScheduler::TrySendingBasicTf().

+ Here is the caller graph for this function:

◆ end() [2/2]

CtrlTriggerHeader::Iterator ns3::CtrlTriggerHeader::end ( void  )

Get an iterator indicating past-the-last User Info field in the list.

Returns
an iterator indicating past-the-last User Info field in the list

Definition at line 2023 of file ctrl-headers.cc.

References m_userInfoFields.

◆ FindUserInfoWithAid() [1/2]

CtrlTriggerHeader::ConstIterator ns3::CtrlTriggerHeader::FindUserInfoWithAid ( ConstIterator  start,
uint16_t  aid12 
) const

Get a const iterator pointing to the first User Info field found (starting from the one pointed to by the given iterator) whose AID12 subfield is set to the given value.

Parameters
starta const iterator pointing to the User Info field to start the search from
aid12the value of the AID12 subfield to match
Returns
a const iterator pointing to the User Info field matching the specified criterion, if any, or an iterator indicating past-the-last User Info field.

Definition at line 2035 of file ctrl-headers.cc.

References end(), ns3::CtrlTriggerUserInfoField::GetAid12(), and visualizer.core::start().

Referenced by FindUserInfoWithAid(), FindUserInfoWithRaRuAssociated(), FindUserInfoWithRaRuUnassociated(), ns3::HeFrameExchangeManager::GetHeTbTxVector(), GetHeTbTxVector(), ns3::HeFrameExchangeManager::ReceiveBasicTrigger(), ns3::HeFrameExchangeManager::ReceiveMpdu(), and ns3::RrMultiUserScheduler::TrySendingBasicTf().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ FindUserInfoWithAid() [2/2]

CtrlTriggerHeader::ConstIterator ns3::CtrlTriggerHeader::FindUserInfoWithAid ( uint16_t  aid12) const

Get a const iterator pointing to the first User Info field found whose AID12 subfield is set to the given value.

Parameters
aid12the value of the AID12 subfield to match
Returns
a const iterator pointing to the User Info field matching the specified criterion, if any, or an iterator indicating past-the-last User Info field.

Definition at line 2044 of file ctrl-headers.cc.

References FindUserInfoWithAid(), and m_userInfoFields.

+ Here is the call graph for this function:

◆ FindUserInfoWithRaRuAssociated() [1/2]

CtrlTriggerHeader::ConstIterator ns3::CtrlTriggerHeader::FindUserInfoWithRaRuAssociated ( ConstIterator  start) const

Get a const iterator pointing to the first User Info field found (starting from the one pointed to by the given iterator) which allocates a Random Access RU for associated stations.

Parameters
starta const iterator pointing to the User Info field to start the search from
Returns
a const iterator pointing to the User Info field matching the specified criterion, if any, or an iterator indicating past-the-last User Info field.

Definition at line 2050 of file ctrl-headers.cc.

References FindUserInfoWithAid(), and visualizer.core::start().

+ Here is the call graph for this function:

◆ FindUserInfoWithRaRuAssociated() [2/2]

CtrlTriggerHeader::ConstIterator ns3::CtrlTriggerHeader::FindUserInfoWithRaRuAssociated ( void  ) const

Get a const iterator pointing to the first User Info field found which allocates a Random Access RU for associated stations.

Returns
a const iterator pointing to the User Info field matching the specified criterion, if any, or an iterator indicating past-the-last User Info field.

Definition at line 2056 of file ctrl-headers.cc.

References FindUserInfoWithAid().

+ Here is the call graph for this function:

◆ FindUserInfoWithRaRuUnassociated() [1/2]

CtrlTriggerHeader::ConstIterator ns3::CtrlTriggerHeader::FindUserInfoWithRaRuUnassociated ( ConstIterator  start) const

Get a const iterator pointing to the first User Info field found (starting from the one pointed to by the given iterator) which allocates a Random Access RU for unassociated stations.

Parameters
starta const iterator pointing to the User Info field to start the search from
Returns
a const iterator pointing to the User Info field matching the specified criterion, if any, or an iterator indicating past-the-last User Info field.

Definition at line 2062 of file ctrl-headers.cc.

References FindUserInfoWithAid(), and visualizer.core::start().

+ Here is the call graph for this function:

◆ FindUserInfoWithRaRuUnassociated() [2/2]

CtrlTriggerHeader::ConstIterator ns3::CtrlTriggerHeader::FindUserInfoWithRaRuUnassociated ( void  ) const

Get a const iterator pointing to the first User Info field found which allocates a Random Access RU for unassociated stations.

Returns
a const iterator pointing to the User Info field matching the specified criterion, if any, or an iterator indicating past-the-last User Info field.

Definition at line 2068 of file ctrl-headers.cc.

References FindUserInfoWithAid().

+ Here is the call graph for this function:

◆ GetApTxPower()

int8_t ns3::CtrlTriggerHeader::GetApTxPower ( void  ) const

Get the power value (dBm) indicated by the AP TX Power subfield of the Common Info field.

Returns
the AP TX Power (dBm) per 20 MHz

Definition at line 1961 of file ctrl-headers.cc.

References m_apTxPower.

Referenced by ns3::HeFrameExchangeManager::GetHeTbTxVector().

+ Here is the caller graph for this function:

◆ GetCommonInfoField()

CtrlTriggerHeader ns3::CtrlTriggerHeader::GetCommonInfoField ( void  ) const

Get a copy of the Common Info field of this Trigger frame.

Note that the User Info fields are excluded.

Returns
a Trigger frame including a copy of the Common Info field of this frame.

Definition at line 1980 of file ctrl-headers.cc.

References m_userInfoFields.

◆ GetCsRequired()

bool ns3::CtrlTriggerHeader::GetCsRequired ( void  ) const

Get the CS Required subfield of the Common Info field.

Returns
the CS Required subfield

Definition at line 1858 of file ctrl-headers.cc.

References m_csRequired.

Referenced by ns3::HeFrameExchangeManager::ReceiveBasicTrigger(), and ns3::HeFrameExchangeManager::SendQosNullFramesInTbPpdu().

+ Here is the caller graph for this function:

◆ GetGuardInterval()

uint16_t ns3::CtrlTriggerHeader::GetGuardInterval ( void  ) const

Get the guard interval duration (in nanoseconds) of the solicited HE TB PPDU.

Returns
the guard interval duration (in nanoseconds) of the solicited HE TB PPDU

Definition at line 1914 of file ctrl-headers.cc.

References m_giAndLtfType, and NS_FATAL_ERROR.

Referenced by GetHeTbTxVector(), TestMultiUserScheduler::SelectTxFormat(), ns3::RrMultiUserScheduler::TrySendingBasicTf(), and ns3::RrMultiUserScheduler::TrySendingBsrpTf().

+ Here is the caller graph for this function:

◆ GetHeTbTxVector()

WifiTxVector ns3::CtrlTriggerHeader::GetHeTbTxVector ( uint16_t  staId) const

Get the TX vector that the station with the given STA-ID will use to send the HE TB PPDU solicited by this Trigger Frame.

Note that the TX power level is not set by this method.

Parameters
staIdthe STA-ID of a station addressed by this Trigger Frame
Returns
the TX vector of the solicited HE TB PPDU

Definition at line 1823 of file ctrl-headers.cc.

References end(), FindUserInfoWithAid(), GetGuardInterval(), ns3::HePhy::GetHeMcs(), GetUlBandwidth(), GetUlLength(), NS_ASSERT, ns3::WifiTxVector::SetChannelWidth(), ns3::WifiTxVector::SetGuardInterval(), ns3::WifiTxVector::SetHeMuUserInfo(), ns3::WifiTxVector::SetLength(), ns3::WifiTxVector::SetPreambleType(), and ns3::WIFI_PREAMBLE_HE_TB.

Referenced by ns3::HeFrameExchangeManager::GetHeTbTxVector().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::CtrlTriggerHeader::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 1609 of file ctrl-headers.cc.

References GetTypeId().

+ Here is the call graph for this function:

◆ GetLtfType()

uint8_t ns3::CtrlTriggerHeader::GetLtfType ( void  ) const

Get the LTF type of the solicited HE TB PPDU.

Returns
the LTF type of the solicited HE TB PPDU

Definition at line 1931 of file ctrl-headers.cc.

References m_giAndLtfType, and NS_FATAL_ERROR.

◆ GetMoreTF()

bool ns3::CtrlTriggerHeader::GetMoreTF ( void  ) const

Get the More TF subfield of the Common Info field.

Returns
the More TF subfield

Definition at line 1846 of file ctrl-headers.cc.

References m_moreTF.

◆ GetNUserInfoFields()

std::size_t ns3::CtrlTriggerHeader::GetNUserInfoFields ( void  ) const

Get the number of User Info fields in this Trigger Frame.

Returns
the number of User Info fields in this Trigger Frame

Definition at line 2029 of file ctrl-headers.cc.

References m_userInfoFields.

Referenced by OfdmaAckSequenceTest::CheckResults(), and ns3::RrMultiUserScheduler::TrySendingBsrpTf().

+ Here is the caller graph for this function:

◆ GetSerializedSize()

uint32_t ns3::CtrlTriggerHeader::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 1627 of file ctrl-headers.cc.

References ns3::GCR_MU_BAR_TRIGGER, m_triggerType, and m_userInfoFields.

Referenced by ns3::GetMuBarSize().

+ Here is the caller graph for this function:

◆ GetType()

TriggerFrameType ns3::CtrlTriggerHeader::GetType ( void  ) const

Get the Trigger Frame type.

Returns
the Trigger Frame type

Definition at line 1727 of file ctrl-headers.cc.

References m_triggerType.

Referenced by GetTypeString().

+ Here is the caller graph for this function:

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 1598 of file ctrl-headers.cc.

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetTypeString() [1/2]

const char * ns3::CtrlTriggerHeader::GetTypeString ( void  ) const

Return a string corresponding to the Trigger Frame type.

Returns
a string corresponding to the Trigger Frame type.

Definition at line 1733 of file ctrl-headers.cc.

References GetType().

Referenced by Print().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetTypeString() [2/2]

const char * ns3::CtrlTriggerHeader::GetTypeString ( TriggerFrameType  type)
static

Return a string corresponding to the given Trigger Frame type.

Parameters
typethe Trigger Frame type
Returns
a string corresponding to the Trigger Frame type.

Definition at line 1739 of file ctrl-headers.cc.

References ns3::BASIC_TRIGGER, ns3::BFRP_TRIGGER, ns3::BQRP_TRIGGER, ns3::BSRP_TRIGGER, FOO, ns3::GCR_MU_BAR_TRIGGER, ns3::MU_BAR_TRIGGER, ns3::MU_RTS_TRIGGER, and ns3::NFRP_TRIGGER.

◆ GetUlBandwidth()

uint16_t ns3::CtrlTriggerHeader::GetUlBandwidth ( void  ) const

Get the bandwidth of the solicited HE TB PPDU.

Returns
the bandwidth (20, 40, 80 or 160)

Definition at line 1887 of file ctrl-headers.cc.

References m_ulBandwidth.

Referenced by GetHeTbTxVector(), IsValid(), Print(), and ns3::RrMultiUserScheduler::TrySendingBasicTf().

+ Here is the caller graph for this function:

◆ GetUlLength()

uint16_t ns3::CtrlTriggerHeader::GetUlLength ( void  ) const

Get the UL Length subfield of the Common Info field.

Returns
the UL Length subfield

Definition at line 1817 of file ctrl-headers.cc.

References m_ulLength.

Referenced by GetHeTbTxVector(), ns3::HeFrameExchangeManager::ReceiveBasicTrigger(), and ns3::HeFrameExchangeManager::SendQosNullFramesInTbPpdu().

+ Here is the caller graph for this function:

◆ GetUlSpatialReuse()

uint16_t ns3::CtrlTriggerHeader::GetUlSpatialReuse ( void  ) const

Get the UL Spatial Reuse subfield of the Common Info field.

Returns
the UL Spatial Reuse subfield

Definition at line 1974 of file ctrl-headers.cc.

References m_ulSpatialReuse.

◆ IsBasic()

bool ns3::CtrlTriggerHeader::IsBasic ( void  ) const

Check if this is a Basic Trigger frame.

Returns
true if this is a Basic Trigger frame, false otherwise

Definition at line 1763 of file ctrl-headers.cc.

References ns3::BASIC_TRIGGER, and m_triggerType.

Referenced by OfdmaAckSequenceTest::CheckResults(), ns3::HeFrameExchangeManager::ReceiveBasicTrigger(), ns3::HeFrameExchangeManager::ReceiveMpdu(), ns3::HeFrameExchangeManager::SendQosNullFramesInTbPpdu(), and ns3::WifiDefaultAckManager::TryUlMuTransmission().

+ Here is the caller graph for this function:

◆ IsBfrp()

bool ns3::CtrlTriggerHeader::IsBfrp ( void  ) const

Check if this is a Beamforming Report Poll Trigger frame.

Returns
true if this is a Beamforming Report Poll Trigger frame, false otherwise

Definition at line 1769 of file ctrl-headers.cc.

References ns3::BFRP_TRIGGER, and m_triggerType.

◆ IsBqrp()

bool ns3::CtrlTriggerHeader::IsBqrp ( void  ) const

Check if this is a Bandwidth Query Report Poll Trigger frame.

Returns
true if this is a Bandwidth Query Report Poll Trigger frame, false otherwise

Definition at line 1799 of file ctrl-headers.cc.

References ns3::BQRP_TRIGGER, and m_triggerType.

◆ IsBsrp()

bool ns3::CtrlTriggerHeader::IsBsrp ( void  ) const

Check if this is a Buffer Status Report Poll Trigger frame.

Returns
true if this is a Buffer Status Report Poll Trigger frame, false otherwise

Definition at line 1787 of file ctrl-headers.cc.

References ns3::BSRP_TRIGGER, and m_triggerType.

Referenced by OfdmaAckSequenceTest::CheckResults(), ns3::HeFrameExchangeManager::ReceiveMpdu(), ns3::HeFrameExchangeManager::SendQosNullFramesInTbPpdu(), and ns3::WifiDefaultAckManager::TryUlMuTransmission().

+ Here is the caller graph for this function:

◆ IsGcrMuBar()

bool ns3::CtrlTriggerHeader::IsGcrMuBar ( void  ) const

Check if this is a Groupcast with Retries (GCR) MU-BAR Trigger frame.

Returns
true if this is a Groupcast with Retries (GCR) MU-BAR Trigger frame, false otherwise

Definition at line 1793 of file ctrl-headers.cc.

References ns3::GCR_MU_BAR_TRIGGER, and m_triggerType.

◆ IsMuBar()

bool ns3::CtrlTriggerHeader::IsMuBar ( void  ) const

Check if this is a MU-BAR Trigger frame.

Returns
true if this is a MU-BAR Trigger frame, false otherwise

Definition at line 1775 of file ctrl-headers.cc.

References m_triggerType, and ns3::MU_BAR_TRIGGER.

Referenced by ns3::HeFrameExchangeManager::ReceiveMpdu(), and ns3::BlockAckManager::ScheduleBar().

+ Here is the caller graph for this function:

◆ IsMuRts()

bool ns3::CtrlTriggerHeader::IsMuRts ( void  ) const

Check if this is a MU-RTS Trigger frame.

Returns
true if this is a MU-RTS Trigger frame, false otherwise

Definition at line 1781 of file ctrl-headers.cc.

References m_triggerType, and ns3::MU_RTS_TRIGGER.

◆ IsNfrp()

bool ns3::CtrlTriggerHeader::IsNfrp ( void  ) const

Check if this is a NDP Feedback Report Poll Trigger frame.

Returns
true if this is a NDP Feedback Report Poll Trigger frame, false otherwise

Definition at line 1805 of file ctrl-headers.cc.

References m_triggerType, and ns3::NFRP_TRIGGER.

◆ IsValid()

bool ns3::CtrlTriggerHeader::IsValid ( void  ) const

Check the validity of this Trigger frame.

TODO Implement the checks listed in Section 27.5.3.2.3 of 802.11ax amendment D3.0 (Allowed settings of the Trigger frame fields and TRS Control subfield).

This function shall be invoked before transmitting and upon receiving a Trigger frame.

Returns
true if the Trigger frame is valid, false otherwise.

Definition at line 2074 of file ctrl-headers.cc.

References ns3::HeRu::DoesOverlap(), GetUlBandwidth(), and m_userInfoFields.

+ Here is the call graph for this function:

◆ operator=()

CtrlTriggerHeader & ns3::CtrlTriggerHeader::operator= ( const CtrlTriggerHeader trigger)

Copy assignment operator.

Parameters
triggerthe Trigger frame to copy
Returns
a reference to the copied object

Ensure that the type of this Trigger Frame is set to the type of the given Trigger Frame before copying the User Info fields.

Definition at line 1576 of file ctrl-headers.cc.

References m_apTxPower, m_csRequired, m_giAndLtfType, m_moreTF, m_triggerType, m_ulBandwidth, m_ulLength, m_ulSpatialReuse, and m_userInfoFields.

◆ Print()

void ns3::CtrlTriggerHeader::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 1615 of file ctrl-headers.cc.

References GetTypeString(), GetUlBandwidth(), m_ulLength, and m_userInfoFields.

+ Here is the call graph for this function:

◆ Serialize()

void ns3::CtrlTriggerHeader::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 1649 of file ctrl-headers.cc.

References ns3::BFRP_TRIGGER, ns3::GCR_MU_BAR_TRIGGER, m_apTxPower, m_csRequired, m_giAndLtfType, m_moreTF, m_triggerType, m_ulBandwidth, m_ulLength, m_ulSpatialReuse, m_userInfoFields, ns3::NFRP_TRIGGER, NS_ABORT_MSG_IF, visualizer.core::start(), ns3::Buffer::Iterator::WriteHtolsbU16(), and ns3::Buffer::Iterator::WriteHtolsbU64().

+ Here is the call graph for this function:

◆ SetApTxPower()

void ns3::CtrlTriggerHeader::SetApTxPower ( int8_t  power)

Set the AP TX Power subfield of the Common Info field.

Parameters
powerthe value (from -20 to 40) for the AP TX Power (dBm)

Definition at line 1952 of file ctrl-headers.cc.

References m_apTxPower, and NS_ABORT_MSG_IF.

Referenced by ns3::HeFrameExchangeManager::SetTargetRssi().

+ Here is the caller graph for this function:

◆ SetCsRequired()

void ns3::CtrlTriggerHeader::SetCsRequired ( bool  cs)

Set the CS Required subfield of the Common Info field.

Parameters
csthe value for the CS Required subfield

Definition at line 1852 of file ctrl-headers.cc.

References m_csRequired.

◆ SetGiAndLtfType()

void ns3::CtrlTriggerHeader::SetGiAndLtfType ( uint16_t  guardInterval,
uint8_t  ltfType 
)

Set the GI And LTF Type subfield of the Common Info field.

Allowed combinations are:

  • 1x LTF + 1.6us GI
  • 2x LTF + 1.6us GI
  • 4x LTF + 3.2us GI
Parameters
guardIntervalthe guard interval duration (in nanoseconds)
ltfTypethe HE-LTF type (1, 2 or 4)

Definition at line 1893 of file ctrl-headers.cc.

References m_giAndLtfType, and NS_FATAL_ERROR.

◆ SetMoreTF()

void ns3::CtrlTriggerHeader::SetMoreTF ( bool  more)

Set the More TF subfield of the Common Info field.

Parameters
morethe value for the More TF subfield

Definition at line 1840 of file ctrl-headers.cc.

References m_moreTF.

◆ SetType()

void ns3::CtrlTriggerHeader::SetType ( TriggerFrameType  type)

Set the Trigger frame type.

Parameters
typethe Trigger frame type

Definition at line 1721 of file ctrl-headers.cc.

References m_triggerType.

Referenced by WifiPrimaryChannelsTest::DoSetup(), ns3::GetMuBarSize(), and TestUlOfdmaPowerControl::SendMuBar().

+ Here is the caller graph for this function:

◆ SetUlBandwidth()

void ns3::CtrlTriggerHeader::SetUlBandwidth ( uint16_t  bw)

Set the bandwidth of the solicited HE TB PPDU.

Parameters
bwbandwidth (allowed values: 20, 40, 80, 160)

Definition at line 1864 of file ctrl-headers.cc.

References m_ulBandwidth, and NS_FATAL_ERROR.

Referenced by CtrlTriggerHeader().

+ Here is the caller graph for this function:

◆ SetUlLength()

void ns3::CtrlTriggerHeader::SetUlLength ( uint16_t  len)

Set the UL Length subfield of the Common Info field.

Parameters
lenthe value for the UL Length subfield

Definition at line 1811 of file ctrl-headers.cc.

References m_ulLength.

Referenced by CtrlTriggerHeader(), and TestMultiUserScheduler::SelectTxFormat().

+ Here is the caller graph for this function:

◆ SetUlSpatialReuse()

void ns3::CtrlTriggerHeader::SetUlSpatialReuse ( uint16_t  sr)

Set the UL Spatial Reuse subfield of the Common Info field.

Parameters
srthe value for the UL Spatial Reuse subfield

Definition at line 1968 of file ctrl-headers.cc.

References m_ulSpatialReuse.

Member Data Documentation

◆ m_apTxPower

uint8_t ns3::CtrlTriggerHeader::m_apTxPower
private

Tx Power used by AP to transmit the Trigger Frame.

Definition at line 1253 of file ctrl-headers.h.

Referenced by Deserialize(), GetApTxPower(), operator=(), Serialize(), and SetApTxPower().

◆ m_csRequired

bool ns3::CtrlTriggerHeader::m_csRequired
private

Carrier Sense required.

Definition at line 1250 of file ctrl-headers.h.

Referenced by Deserialize(), GetCsRequired(), operator=(), Serialize(), and SetCsRequired().

◆ m_giAndLtfType

uint8_t ns3::CtrlTriggerHeader::m_giAndLtfType
private

GI And LTF Type subfield.

Definition at line 1252 of file ctrl-headers.h.

Referenced by CtrlTriggerHeader(), Deserialize(), GetGuardInterval(), GetLtfType(), operator=(), Serialize(), and SetGiAndLtfType().

◆ m_moreTF

bool ns3::CtrlTriggerHeader::m_moreTF
private

True if a subsequent Trigger frame follows.

Definition at line 1249 of file ctrl-headers.h.

Referenced by Deserialize(), GetMoreTF(), operator=(), Serialize(), and SetMoreTF().

◆ m_triggerType

uint8_t ns3::CtrlTriggerHeader::m_triggerType
private

◆ m_ulBandwidth

uint8_t ns3::CtrlTriggerHeader::m_ulBandwidth
private

UL BW subfield.

Definition at line 1251 of file ctrl-headers.h.

Referenced by Deserialize(), GetUlBandwidth(), operator=(), Serialize(), and SetUlBandwidth().

◆ m_ulLength

uint16_t ns3::CtrlTriggerHeader::m_ulLength
private

Value for the L-SIG Length field.

Definition at line 1248 of file ctrl-headers.h.

Referenced by Deserialize(), GetUlLength(), operator=(), Print(), Serialize(), and SetUlLength().

◆ m_ulSpatialReuse

uint16_t ns3::CtrlTriggerHeader::m_ulSpatialReuse
private

Value for the Spatial Reuse field in HE-SIG-A.

Definition at line 1254 of file ctrl-headers.h.

Referenced by Deserialize(), GetUlSpatialReuse(), operator=(), Serialize(), and SetUlSpatialReuse().

◆ m_userInfoFields

std::list<CtrlTriggerUserInfoField> ns3::CtrlTriggerHeader::m_userInfoFields
private

List of User Info fields.

list of User Info fields

Definition at line 1258 of file ctrl-headers.h.

Referenced by AddUserInfoField(), begin(), Deserialize(), end(), FindUserInfoWithAid(), GetCommonInfoField(), GetNUserInfoFields(), GetSerializedSize(), IsValid(), operator=(), Print(), and Serialize().


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