This section documents the API of the ns-3 wimax module. More...
Modules | |
wimax module tests | |
Classes | |
class | ns3::BandwidthManager |
This class manage the bandwidth request and grant mechanism. More... | |
class | ns3::BandwidthRequestHeader |
This class implements the bandwidth-request mac Header as described by IEEE Standard for Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems 6.3.2.1.2 Bandwidth request header, page 38. More... | |
class | ns3::BaseStationNetDevice |
class | ns3::BSLinkManager |
class | ns3::BSScheduler |
class | ns3::BSSchedulerRtps |
This class implements a simple downlink scheduler for rtPS flows. More... | |
class | ns3::BSSchedulerSimple |
class | ns3::BsServiceFlowManager |
BsServiceFlowManager. More... | |
class | ns3::BurstProfileManager |
class | ns3::Cid |
Cid class. More... | |
class | ns3::CidFactory |
This class is used exclusively by the BS to allocate CIDs to new connections. More... | |
class | ns3::ClassificationRuleVectorTlvValue |
this class implements the classifier descriptor as a tlv vector More... | |
class | ns3::ConnectionManager |
The same connection manager class serves both for BS and SS though some functions are exclusive to only one of them. More... | |
class | ns3::CsParameters |
CsParameters class. More... | |
class | ns3::CsParamVectorTlvValue |
this class implements the convergence sub-layer descriptor as a tlv vector More... | |
class | ns3::DcdChannelEncodings |
This class implements the DCD channel encodings as described by "IEEE Standard for
Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems" 11.4.1 DCD channel encodings, page 659. More... | |
class | ns3::DlFramePrefixIe |
This class implements the DL Frame Prefix IE as described by IEEE-802.16 standard. More... | |
class | ns3::DsaAck |
This class implements the DSA-ACK message described by "IEEE Standard for
Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems" 6.3.2.3.12 DSA-ACK message, page 64. More... | |
class | ns3::DsaReq |
This class implements the DSA-REQ message described by "IEEE Standard for
Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems" 6.3.2.3.10 DSA-REQ message, page 62. More... | |
class | ns3::DsaRsp |
This class implements the DSA-RSP message described by "IEEE Standard for
Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems" 6.3.2.3.11 DSA-RSP message, page 63. More... | |
class | ns3::FragmentationSubheader |
This class implements the fragmentation sub-header as described by IEEE Standard for Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems 6.3.2.2.1 Fragmentation subheader, page 39. More... | |
class | ns3::GenericMacHeader |
This class implements the Generic mac Header as described by IEEE Standard for Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems 6.3.2.1.1 Generic MAC header, page 36. More... | |
class | ns3::GrantManagementSubheader |
This class implements the grant management sub-header as described by IEEE Standard for Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems 6.3.2.2.2 Grant Management subheader, page 40. More... | |
class | ns3::IpcsClassifier |
class | ns3::IpcsClassifierRecord |
IpcsClassifierRecord class. More... | |
struct | ns3::Ipv4AddressTlvValue::ipv4Addr |
ipv4Addr structure More... | |
struct | ns3::IpcsClassifierRecord::ipv4Addr |
ipv4Addr structure More... | |
class | ns3::Ipv4AddressTlvValue |
Ipv4AddressTlvValue class. More... | |
class | ns3::MacHeaderType |
This class Represents the HT (Header Type) field of generic MAC and bandwidth request headers. More... | |
class | ns3::ManagementMessageType |
Mac Management messages Section 6.3.2.3 MAC Management messages page 42, Table 14 page 43. More... | |
struct | ns3::PortRangeTlvValue::PortRange |
PortRange structure. More... | |
struct | ns3::IpcsClassifierRecord::PortRange |
PortRange structure. More... | |
class | ns3::PortRangeTlvValue |
PortRangeTlvValue class. More... | |
class | ns3::ProtocolTlvValue |
ProtocolTlvValue class. More... | |
struct | ns3::WimaxMacQueue::QueueElement |
QueueElement structure. More... | |
class | ns3::RngReq |
This class implements the ranging request message described by "IEEE Standard for
Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems". More... | |
class | ns3::RngRsp |
This class implements the ranging response message described by "IEEE Standard for
Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems" 6.3.2.3.6 Ranging response (RNG-RSP) message, page 50. More... | |
class | ns3::SendParams |
The SendParams class defines the parameters with which Send() function of a particular PHY is called. More... | |
class | ns3::ServiceFlow |
This class implements service flows as described by the IEEE-802.16 standard. More... | |
class | ns3::ServiceFlowManager |
The same service flow manager class serves both for BS and SS though some functions are exclusive to only one of them. More... | |
class | ns3::ServiceFlowRecord |
this class implements a structure to manage some parameters and statistics related to a service flow More... | |
class | ns3::SfVectorTlvValue |
SfVectorTlvValue class. More... | |
class | ns3::simpleOfdmSendParam |
simpleOfdmSendParam class More... | |
class | ns3::SimpleOfdmWimaxChannel |
SimpleOfdmWimaxChannel class. More... | |
class | ns3::SimpleOfdmWimaxPhy |
SimpleOfdmWimaxPhy class. More... | |
class | ns3::SNRToBlockErrorRateManager |
This class handles the SNR to BlcER traces. More... | |
class | ns3::SNRToBlockErrorRateRecord |
This class represents a record (handled by SnrToBlockErrorRate manager) that keeps a mapping between an SNR value and its corresponding (1) Bit Error Rate, (2) Block Error Rate, (3) Standard deviation, (4 and 5) confidence interval. More... | |
class | ns3::SSLinkManager |
this class implements the link manager of subscriber station net device. More... | |
class | ns3::SSManager |
this class manages a list of SSrecords More... | |
class | ns3::SSRecord |
This class is used by the base station to store some information related to subscriber station in the cell. More... | |
class | ns3::SSScheduler |
class | ns3::SsServiceFlowManager |
SsServiceFlowManager class. More... | |
class | ns3::SubscriberStationNetDevice |
SubscriberStationNetDevice subclass of WimaxNetDevice. More... | |
class | ns3::Tlv |
This class implements the Type-Len-Value structure channel encodings as described by "IEEE Standard for
Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems". More... | |
class | ns3::TlvValue |
The value field of a tlv can take different values (uint8_t, uint16, vector, ...). More... | |
class | ns3::TosTlvValue |
TosTlvValue class. More... | |
class | ns3::U16TlvValue |
U16TlvValue class. More... | |
class | ns3::U32TlvValue |
U32TlvValue class. More... | |
class | ns3::U8TlvValue |
U8TlvValue class. More... | |
class | ns3::UcdChannelEncodings |
This class implements the UCD channel encodings as described by "IEEE Standard for
Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems" 11.3.1 UCD channel encodings, page 651. More... | |
class | ns3::UlJob |
this class implements a structure to compute the priority of service flows More... | |
class | ns3::UplinkScheduler |
Virtual class for uplink scheduler. More... | |
class | ns3::UplinkSchedulerMBQoS |
This class implements a Migration-based Quality of Service uplink scheduler(MBQoS). More... | |
class | ns3::UplinkSchedulerRtps |
This class implements a simple uplink scheduler for rtPS flows. More... | |
class | ns3::UplinkSchedulerSimple |
class | ns3::VectorTlvValue |
this class is used to implement a vector of values in one tlv value field More... | |
class | ns3::WimaxChannel |
The channel object to attach Wimax NetDevices. More... | |
class | ns3::WimaxConnection |
Class to represent WiMAX connections. More... | |
class | ns3::WimaxMacQueue |
Class implementing the device packet queue. More... | |
class | ns3::WimaxMacToMacHeader |
this class implements the mac to mac header needed to dump a wimax pcap file The header format was reverse-engineered by looking at existing live pcap traces which could be opened with wireshark i.e., we have no idea where this is coming from. More... | |
class | ns3::WimaxNetDevice |
Hold together all WiMAX-related objects in a NetDevice. More... | |
class | ns3::WimaxPhy |
This section documents the API of the ns-3 wimax module.
For a generic functional description, please refer to the ns-3 manual.
ClassificationRuleTlvType enumeration.
Enumerator | |
---|---|
Priority | |
ToS | |
Protocol | |
IP_src | |
IP_dst | |
Port_src | |
Port_dst | |
Index |
Definition at line 401 of file wimax-tlv.h.
CommonTypes enumeration.
Enumerator | |
---|---|
HMAC_TUPLE | |
MAC_VERSION_ENCODING | |
CURRENT_TRANSMIT_POWER | |
DOWNLINK_SERVICE_FLOW | |
UPLINK_SERVICE_FLOW | |
VENDOR_ID_EMCODING | |
VENDOR_SPECIFIC_INFORMATION |
Definition at line 87 of file wimax-tlv.h.
confirmation code enumeration as per Table 384 (not all codes implemented)
Enumerator | |
---|---|
CONFIRMATION_CODE_SUCCESS | |
CONFIRMATION_CODE_REJECT |
Definition at line 46 of file service-flow-manager.h.
Confirmation code enumeration.
Enumerator | |
---|---|
CONFIRMATION_CODE_SUCCESS | |
CONFIRMATION_CODE_REJECT |
Definition at line 47 of file ss-service-flow-manager.h.
Confirmation code enumeration.
Enumerator | |
---|---|
CONFIRMATION_CODE_SUCCESS | |
CONFIRMATION_CODE_REJECT |
Definition at line 48 of file bs-service-flow-manager.h.
section 11.13.19.2 CS parameter encoding rules, page 707
Enumerator | |
---|---|
ATM | |
IPV4 | |
IPV6 | |
ETHERNET | |
VLAN | |
IPV4_OVER_ETHERNET | |
IPV6_OVER_ETHERNET | |
IPV4_OVER_VLAN | |
IPV6_OVER_VLAN |
Definition at line 69 of file service-flow.h.
Direction enumeration.
Enumerator | |
---|---|
SF_DIRECTION_DOWN | |
SF_DIRECTION_UP |
Definition at line 43 of file service-flow.h.
Direction enumeration.
Enumerator | |
---|---|
DIRECTION_DOWNLINK | |
DIRECTION_UPLINK |
Definition at line 72 of file wimax-net-device.h.
EventType enumeration.
Enumerator | |
---|---|
EVENT_NONE | |
EVENT_WAIT_FOR_RNG_RSP | |
EVENT_DL_MAP_SYNC_TIMEOUT | |
EVENT_LOST_DL_MAP | |
EVENT_LOST_UL_MAP | |
EVENT_DCD_WAIT_TIMEOUT | |
EVENT_UCD_WAIT_TIMEOUT | |
EVENT_RANG_OPP_WAIT_TIMEOUT |
Definition at line 68 of file ss-net-device.h.
Frame duration code enumeration.
Enumerator | |
---|---|
FRAME_DURATION_2_POINT_5_MS | |
FRAME_DURATION_4_MS | |
FRAME_DURATION_5_MS | |
FRAME_DURATION_8_MS | |
FRAME_DURATION_10_MS | |
FRAME_DURATION_12_POINT_5_MS | |
FRAME_DURATION_20_MS |
Definition at line 51 of file simple-ofdm-wimax-phy.h.
Header type enumeration.
Enumerator | |
---|---|
HEADER_TYPE_GENERIC | |
HEADER_TYPE_BANDWIDTH |
Definition at line 40 of file wimax-mac-header.h.
Header type enumeration.
Enumerator | |
---|---|
HEADER_TYPE_INCREMENTAL | |
HEADER_TYPE_AGGREGATE |
Definition at line 255 of file wimax-mac-header.h.
MacPreamble enumeration.
Enumerator | |
---|---|
SHORT_PREAMBLE | |
LONG_PREAMBLE |
Definition at line 63 of file bs-net-device.h.
Message type enumeration.
Definition at line 47 of file mac-messages.h.
ModulationType enumeration.
Enumerator | |
---|---|
MODULATION_TYPE_BPSK_12 | |
MODULATION_TYPE_QPSK_12 | |
MODULATION_TYPE_QPSK_34 | |
MODULATION_TYPE_QAM16_12 | |
MODULATION_TYPE_QAM16_34 | |
MODULATION_TYPE_QAM64_23 | |
MODULATION_TYPE_QAM64_34 |
Definition at line 49 of file wimax-phy.h.
Modulation type enumeration, Table 356 and 362.
Enumerator | |
---|---|
MODULATION_TYPE_BPSK_12 | |
MODULATION_TYPE_QPSK_12 | |
MODULATION_TYPE_QPSK_34 | |
MODULATION_TYPE_QAM16_12 | |
MODULATION_TYPE_QAM16_34 | |
MODULATION_TYPE_QAM64_23 | |
MODULATION_TYPE_QAM64_34 |
Definition at line 82 of file service-flow.h.
PhyState enumeration.
Enumerator | |
---|---|
PHY_STATE_IDLE | |
PHY_STATE_SCANNING | |
PHY_STATE_TX | |
PHY_STATE_RX |
Definition at line 61 of file wimax-phy.h.
PhyType enumeration.
Enumerator | |
---|---|
SimpleWimaxPhy | |
simpleOfdmWimaxPhy |
Definition at line 70 of file wimax-phy.h.
PropModel enumeration.
Enumerator | |
---|---|
RANDOM_PROPAGATION | |
FRIIS_PROPAGATION | |
LOG_DISTANCE_PROPAGATION | |
COST231_PROPAGATION |
Definition at line 49 of file simple-ofdm-wimax-channel.h.
RangingStatus enumeration.
Enumerator | |
---|---|
RANGING_STATUS_EXPIRED | |
RANGING_STATUS_CONTINUE | |
RANGING_STATUS_ABORT | |
RANGING_STATUS_SUCCESS |
Definition at line 79 of file wimax-net-device.h.
section 11.13.11 Service flow scheduling type, page 701
Enumerator | |
---|---|
SF_TYPE_NONE | |
SF_TYPE_UNDEF | |
SF_TYPE_BE | |
SF_TYPE_NRTPS | |
SF_TYPE_RTPS | |
SF_TYPE_UGS | |
SF_TYPE_ALL |
Definition at line 58 of file service-flow.h.
State enumeration.
Definition at line 52 of file ss-net-device.h.
State enumeration.
Enumerator | |
---|---|
BS_STATE_DL_SUB_FRAME | |
BS_STATE_UL_SUB_FRAME | |
BS_STATE_TTG | |
BS_STATE_RTG |
Definition at line 54 of file bs-net-device.h.
Type enumeration.
Enumerator | |
---|---|
SF_TYPE_PROVISIONED | |
SF_TYPE_ADMITTED | |
SF_TYPE_ACTIVE |
Definition at line 50 of file service-flow.h.
Type enumeration.
Definition at line 333 of file wimax-tlv.h.
Type enumeration.
Enumerator | |
---|---|
Classifier_DSC_Action | |
Packet_Classification_Rule |
Definition at line 380 of file wimax-tlv.h.