ns3::WifiChannelConfig Struct Reference

Struct defining the configuration of a wifi channel, which can be made of one or multiple channel segments. More...

#include "wifi-types.h"

Collaboration diagram for ns3::WifiChannelConfig:

Classes
struct	Segment
	a channel segment, as a struct with units for channel width More...
struct	SegmentWithoutUnits
	a channel segment, as a struct without units for channel width (to be deprecated when using strong types) More...

Public Types
using	TupleWithoutUnits
	a channel segment, as a tuple without units for channel width (to be deprecated when using strong types)

Public Member Functions
	WifiChannelConfig ()=default
	WifiChannelConfig (const Segment &segment)
	Construct a channel config from a channel segment.
	WifiChannelConfig (const SegmentWithoutUnits &s)
	Construct a channel config from a segment without units for channel width.
	WifiChannelConfig (const std::list< TupleWithoutUnits > &tuples)
	Construct a channel config from a list of tuples without units for channel width.
Segment &	front ()
const Segment &	front () const
auto	operator<=> (const WifiChannelConfig &rhs) const =default
	Three-way comparison operator.

Static Public Member Functions
static WifiChannelConfig	FromString (const std::string &settings, WifiStandard standard=WIFI_STANDARD_UNSPECIFIED)
	Get the wifi channel config from a WifiPhy::ChannelSettings string.

Public Attributes
std::vector< Segment >	segments
	channel config

Detailed Description

Struct defining the configuration of a wifi channel, which can be made of one or multiple channel segments.

Definition at line 93 of file wifi-types.h.

Member Typedef Documentation

TupleWithoutUnits

using ns3::WifiChannelConfig::TupleWithoutUnits

Initial value:

 std::tuple<uint64_t ,
                                         uint64_t ,
                                         WifiPhyBand ,
                                         uint64_t >

a channel segment, as a tuple without units for channel width (to be deprecated when using strong types)

Definition at line 193 of file wifi-types.h.

Constructor & Destructor Documentation

WifiChannelConfig() [1/4]

ns3::WifiChannelConfig::WifiChannelConfig ( )

default

Referenced by WifiChannelConfig(), FromString(), and operator<=>().

Here is the caller graph for this function:

WifiChannelConfig() [2/4]

ns3::WifiChannelConfig::WifiChannelConfig ( const Segment & segment )

inline

Construct a channel config from a channel segment.

Parameters

segment

the channel segment

Definition at line 176 of file wifi-types.h.

References segments.

WifiChannelConfig() [3/4]

ns3::WifiChannelConfig::WifiChannelConfig ( const SegmentWithoutUnits & s )

inline

Construct a channel config from a segment without units for channel width.

Parameters

s	the segment without units for channel width

Definition at line 186 of file wifi-types.h.

References WifiChannelConfig().

Here is the call graph for this function:

WifiChannelConfig() [4/4]

ns3::WifiChannelConfig::WifiChannelConfig

(

const std::list< TupleWithoutUnits > &

tuples

)

Construct a channel config from a list of tuples without units for channel width.

Parameters

tuples

the list of tuples without units for channel width

Definition at line 16 of file wifi-types.cc.

Member Function Documentation

FromString()

WifiChannelConfig ns3::WifiChannelConfig::FromString ( const std::string & settings, WifiStandard standard = WIFI_STANDARD_UNSPECIFIED )

static

Get the wifi channel config from a WifiPhy::ChannelSettings string.

Parameters

settings	the WifiPhy::ChannelSettings string
standard	the Wi-Fi standard

Returns

the wifi channel config object

Definition at line 24 of file wifi-types.cc.

References WifiChannelConfig(), ns3::WifiPhy::GetChannelSegmentsChecker(), ns3::WifiPhy::SetUnspecifiedChannelParams(), and ns3::WIFI_STANDARD_UNSPECIFIED.

Referenced by WifiStaticEmlsrTest::GetPhyHelper(), and WifiStaticInfraBssTest::GetPhyHelper().

Here is the call graph for this function:

Here is the caller graph for this function:

front() [1/2]

Segment & ns3::WifiChannelConfig::front ( )

inline

Returns

a reference to the first channel segment

Definition at line 222 of file wifi-types.h.

References segments.

front() [2/2]

const Segment & ns3::WifiChannelConfig::front ( ) const

inline

Returns

a const reference to the first channel segment

Definition at line 216 of file wifi-types.h.

References segments.

Referenced by ns3::WifiPhy::SetOperatingChannel().

Here is the caller graph for this function:

operator<=>()

auto ns3::WifiChannelConfig::operator<=> ( const WifiChannelConfig & rhs ) const

default

Three-way comparison operator.

Parameters

rhs	right hand side

Returns

deduced comparison type

References WifiChannelConfig().

Here is the call graph for this function:

Member Data Documentation

segments

std::vector<Segment> ns3::WifiChannelConfig::segments

channel config

Definition at line 167 of file wifi-types.h.

Referenced by WifiChannelConfig(), front(), front(), ns3::WifiPhy::SetOperatingChannel(), and ns3::WifiPhy::SetUnspecifiedChannelParams().

---

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

• src/wifi/model/wifi-types.h
• src/wifi/model/wifi-types.cc