Utils module
Classes that are used in different points of the code.
Files
- file introspected-doxygen.h
- Automatic doxygen for TypeIds Doxygen docs generated from the TypeId database.
Classes
- class ns3::BeamConfId
- struct ns3::BeamConfIdHash
- Calculate the hash of a BeamConfId.
- struct ns3::BeamIdHash
- Calculate the hash of a BeamId.
- struct ns3::DciInfoElementTdma
- Scheduling information. Despite the name, it is not TDMA.
- struct ns3::DlCqiInfo
- The DlCqiInfo struct.
- struct ns3::DlHarqInfo
- A struct that contains info for the DL HARQ.
- struct ns3::GnbPhyPacketCountParameter
- The GnbPhyPacketCountParameter struct.
- struct ns3::HarqInfo
- Store information about HARQ.
- struct ns3::MacCeElement
- See section 4.3.14 macCEListElement.
- struct ns3::MacCeValue
- The MacCeValue struct.
- class ns3::NrBearerStatsCalculator
- class ns3::NrBearerStatsConnector
- class ns3::NrBsrMessage
- the BSR message
- class ns3::NrControlMessage
- The NrControlMessage class.
- class ns3::NrDlCqiMessage
- The message that represents a DL CQI message.
- class ns3::NrDlDciMessage
- The message that represents a DL DCI message.
- class ns3::NrDlHarqFeedbackMessage
- DlHarqFeedback message.
- class ns3::NrMibMessage
- Abstract model for broadcasting the Master Information Block (MIB) within the control channel (BCCH).
- class ns3::NrRachPreambleMessage
- Abstract model for the Random Access Preamble.
- class ns3::NrRarMessage
- Abstract model for the MAC Random Access Response message.
- class ns3::NrSib1Message
- Abstract model for broadcasting the System Information Block Type 1 (SIB1) within the control channel (BCCH).
- class ns3::NrSRMessage
- SR message.
- class ns3::NrSrsMessage
- NrSrsMessage message.
- class ns3::NrUlDciMessage
- The message that represents a UL DCI message.
- struct ns3::OperationBandInfo
- Operation band information structure.
- struct ns3::RlcListElement
- The RlcListElement struct.
- struct ns3::RlcPduInfo
- The RlcPduInfo struct.
- struct ns3::RxPacketTraceParams
- The RxPacketTraceParams struct.
- class ns3::SfnSf
- The SfnSf class.
- struct ns3::SlotAllocInfo
- The SlotAllocInfo struct.
- struct ns3::TbAllocInfo
- The TbAllocInfo struct.
- struct ns3::TbInfoElement
- The TbInfoElement struct.
- struct ns3::UePhyPacketCountParameter
- The UePhyPacketCountParameter struct.
- struct ns3::UlCqiInfo
- The UlCqiInfo struct.
- struct ns3::UlHarqInfo
- A struct that contains info for the UL HARQ.
Enums
- enum LteNrTddSlotType: uint8_t { DL = 0, S = 1, F = 2, UL = 3 }
- Available TDD slot types. Ordering is important.
Typedefs
- using BandwidthPartInfoConstPtr = std::unique_ptr<const BandwidthPartInfo>
- unique_ptr of a const BandwidthPartInfo
- using BandwidthPartInfoPtr = std::unique_ptr<BandwidthPartInfo>
- unique_ptr of BandwidthPartInfo
- using BandwidthPartInfoPtrVector = std::vector<std::reference_wrapper<BandwidthPartInfoPtr>>
- vector of unique_ptr of BandwidthPartInfo
- using BeamformingVector = std::pair<complexVector_t, BeamId>
- Physical representation of a beam.
- using ComponentCarrierInfoPtr = std::unique_ptr<ComponentCarrierInfo>
- unique_ptr of ComponentCarrierInfo
Functions
- auto CreateDirectionalBfv(const Ptr<const UniformPlanarArray>& antenna, uint16_t sector, double elevation) -> complexVector_t
- Creates a beamforming vector for a given sector and elevation.
- auto CreateDirectionalBfvAz(const Ptr<const UniformPlanarArray>& antenna, double azimuth, double zenith) -> complexVector_t
- Creates a beamforming vector for a given azimuth and zenith.
- auto CreateQuasiOmniBfv(uint32_t antennaRows, uint32_t antennaColumns) -> complexVector_t
- Create a quasi omni beamforming vector.
Variables
- static const uint8_t MAX_CC_INTER_BAND
- static const uint8_t MAX_CC_INTRA_BAND
- . 16, 8
- const BeamId OMNI_BEAM_ID
- Name of the OMNI beam.
- const BeamId PREDEFINED_BEAM_ID
- Reserved ID for the predefined directional beam if it cannot be expressed through sector and elevation.
Enum documentation
enum LteNrTddSlotType: uint8_t
Available TDD slot types. Ordering is important.
Enumerators | |
---|---|
DL |
DL CTRL + DL DATA. |
S |
DL CTRL + DL DATA + UL CTRL. |
F |
DL CTRL + DL DATA + UL DATA + UL CTRL. |
UL |
UL DATA + UL CTRL. |
Typedef documentation
typedef std::pair<complexVector_t, BeamId> BeamformingVector
Physical representation of a beam.
Contains the vector of the antenna weight, as well as the beam id. These values are stored as std::pair, and we provide utilities functions to extract them.
Function documentation
complexVector_t CreateDirectionalBfv(const Ptr<const UniformPlanarArray>& antenna, uint16_t sector, double elevation)
Creates a beamforming vector for a given sector and elevation.
Parameters | |
---|---|
antenna | Antenna array for which will be created the beamforming vector |
sector | sector to be used |
elevation | elevation to be used |
Returns | the beamforming vector |
complexVector_t CreateDirectionalBfvAz(const Ptr<const UniformPlanarArray>& antenna, double azimuth, double zenith)
Creates a beamforming vector for a given azimuth and zenith.
Parameters | |
---|---|
antenna | Antenna array for which will be created the beamforming vector |
azimuth | azimuth to be used |
zenith | zenith to be used |
Returns | the beamforming vector |
complexVector_t CreateQuasiOmniBfv(uint32_t antennaRows, uint32_t antennaColumns)
Create a quasi omni beamforming vector.
Parameters | |
---|---|
antennaRows | Number of rows in antenna array |
antennaColumns | Number of columns in the antenna array |
Returns | the beamforming vector |
Variable documentation
static const uint8_t MAX_CC_INTER_BAND
16 . 16 ( one operation band)