5G-LENA: Utils

Searching...

No Matches

Classes that are used in different points of the code. More...

Files
file	introspected-doxygen.h
	Automatic doxygen for TypeIds Doxygen docs generated from the TypeId database.

Classes
struct	ns3::BeamIdHash
	Calculate the hash of a BeamId. More...

struct	ns3::DciInfoElementTdma
	Scheduling information. Despite the name, it is not TDMA. More...

struct	ns3::DlCqiInfo
	The DlCqiInfo struct. More...

struct	ns3::DlHarqInfo
	A struct that contains info for the DL HARQ. More...

struct	ns3::ExpectedTb
	Information about the expected transport block at a certain point in the slot. More...

struct	ns3::GnbPhyPacketCountParameter
	The GnbPhyPacketCountParameter struct. More...

struct	ns3::HarqInfo
	Store information about HARQ. More...

struct	ns3::MacCeElement
	See section 4.3.14 macCEListElement. More...

struct	ns3::MacCeValue
	The MacCeValue struct. More...

class	ns3::NrBearerStatsCalculator

class	ns3::NrBearerStatsConnector

class	ns3::NrBsrMessage
	the BSR message More...

class	ns3::NrControlMessage
	The NrControlMessage class. More...

class	ns3::NrDlCqiMessage
	The message that represents a DL CQI message. More...

class	ns3::NrDlDciMessage
	The message that represents a DL DCI message. More...

class	ns3::NrDlHarqFeedbackMessage
	DlHarqFeedback message. More...

class	ns3::NrMibMessage
	Abstract model for broadcasting the Master Information Block (MIB) within the control channel (BCCH). More...

class	ns3::NrRachPreambleMessage
	Abstract model for the Random Access Preamble. More...

class	ns3::NrRarMessage
	Abstract model for the MAC Random Access Response message. More...

class	ns3::NrSib1Message
	Abstract model for broadcasting the System Information Block Type 1 (SIB1) within the control channel (BCCH). More...

class	ns3::NrSRMessage
	SR message. More...

class	ns3::NrSrsMessage
	NrSrsMessage message. More...

class	ns3::NrUlDciMessage
	The message that represents a UL DCI message. More...

struct	ns3::OperationBandInfo
	Operation band information structure. More...

struct	ns3::RlcListElement
	The RlcListElement struct. More...

struct	ns3::RlcPduInfo
	The RlcPduInfo struct. More...

struct	ns3::RxPacketTraceParams
	The RxPacketTraceParams struct. More...

class	ns3::SfnSf
	The SfnSf class. More...

struct	ns3::SlotAllocInfo
	The SlotAllocInfo struct. More...

struct	ns3::UePhyPacketCountParameter
	The UePhyPacketCountParameter struct. More...

struct	ns3::UlCqiInfo
	The UlCqiInfo struct. More...

struct	ns3::UlHarqInfo
	A struct that contains info for the UL HARQ. More...

Typedefs
typedef std::unique_ptr< const BandwidthPartInfo >	ns3::BandwidthPartInfoConstPtr
	unique_ptr of a const BandwidthPartInfo

typedef std::unique_ptr< BandwidthPartInfo >	ns3::BandwidthPartInfoPtr
	unique_ptr of BandwidthPartInfo

typedef std::vector< std::reference_wrapper< BandwidthPartInfoPtr > >	ns3::BandwidthPartInfoPtrVector
	vector of unique_ptr of BandwidthPartInfo

typedef std::pair< PhasedArrayModel::ComplexVector, BeamId >	ns3::BeamformingVector
	Physical representation of a beam.

typedef std::unique_ptr< ComponentCarrierInfo >	ns3::ComponentCarrierInfoPtr
	unique_ptr of ComponentCarrierInfo

Enumerations
enum	ns3::LteNrTddSlotType : uint8_t { ns3::DL = 0 , ns3::S = 1 , ns3::F = 2 , ns3::UL = 3 }
	Available TDD slot types. Ordering is important. More...

Functions
PhasedArrayModel::ComplexVector	ns3::CreateDirectionalBfv (const Ptr< const UniformPlanarArray > &antenna, uint16_t sector, double elevation)
	Creates a beamforming vector for a given sector and elevation.

PhasedArrayModel::ComplexVector	ns3::CreateDirectionalBfvAz (const Ptr< const UniformPlanarArray > &antenna, double azimuth, double zenith)
	Creates a beamforming vector for a given azimuth and zenith.

PhasedArrayModel::ComplexVector	ns3::CreateQuasiOmniBfv (const Ptr< const UniformPlanarArray > &antenna)
	Create a quasi omni beamforming vector.

Variables
static const uint8_t	ns3::MAX_CC_INTER_BAND

static const uint8_t	ns3::MAX_CC_INTRA_BAND
	. 16, 8

const BeamId	ns3::OMNI_BEAM_ID = BeamId(UINT16_MAX, UINT16_MAX)
	Name of the OMNI beam.

const BeamId	ns3::PREDEFINED_BEAM_ID = BeamId(UINT16_MAX - 1, UINT16_MAX - 1)
	Reserved ID for the predefined directional beam if it cannot be expressed through sector and elevation.

Detailed Description

Classes that are used in different points of the code.

Typedef Documentation

◆ BandwidthPartInfoConstPtr

typedef std::unique_ptr<const BandwidthPartInfo> ns3::BandwidthPartInfoConstPtr

unique_ptr of a const BandwidthPartInfo

Definition at line 81 of file cc-bwp-helper.h.

◆ BandwidthPartInfoPtr

typedef std::unique_ptr<BandwidthPartInfo> ns3::BandwidthPartInfoPtr

unique_ptr of BandwidthPartInfo

Definition at line 76 of file cc-bwp-helper.h.

◆ BandwidthPartInfoPtrVector

typedef std::vector<std::reference_wrapper<BandwidthPartInfoPtr> > ns3::BandwidthPartInfoPtrVector

vector of unique_ptr of BandwidthPartInfo

Definition at line 86 of file cc-bwp-helper.h.

◆ BeamformingVector

typedef std::pair<PhasedArrayModel::ComplexVector, BeamId> ns3::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.

See also: GetVector; GetBeamId

Definition at line 27 of file beamforming-vector.h.

◆ ComponentCarrierInfoPtr

typedef std::unique_ptr<ComponentCarrierInfo> ns3::ComponentCarrierInfoPtr

unique_ptr of ComponentCarrierInfo

Definition at line 116 of file cc-bwp-helper.h.

Enumeration Type Documentation

◆ LteNrTddSlotType

enum ns3::LteNrTddSlotType : uint8_t

Available TDD slot types. Ordering is important.

Enumerator
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.

Definition at line 20 of file nr-control-messages.h.

Function Documentation

◆ CreateDirectionalBfv()

PhasedArrayModel::ComplexVector ns3::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

Definition at line 58 of file beamforming-vector.cc.

Referenced by ns3::BeamManager::SetPredefinedBeam(), and ns3::BeamManager::SetSector().

Here is the caller graph for this function:

◆ CreateDirectionalBfvAz()

PhasedArrayModel::ComplexVector ns3::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

Definition at line 86 of file beamforming-vector.cc.

Referenced by ns3::BeamManager::SetSectorAz().

Here is the caller graph for this function:

◆ CreateQuasiOmniBfv()

PhasedArrayModel::ComplexVector ns3::CreateQuasiOmniBfv ( const Ptr< const UniformPlanarArray > & antenna )

Create a quasi omni beamforming vector.

Parameters

antenna Antenna array for which the beamforming vector will be created

Returns: the beamforming vector

Definition at line 14 of file beamforming-vector.cc.

Referenced by ns3::BeamManager::ChangeToQuasiOmniBeamformingVector(), ns3::QuasiOmniDirectPathBeamforming::GetBeamformingVectors(), ns3::DirectPathQuasiOmniBeamforming::GetBeamformingVectors(), and ns3::KroneckerQuasiOmniBeamforming::GetBeamformingVectors().

Here is the caller graph for this function:

Variable Documentation

◆ MAX_CC_INTER_BAND

const uint8_t ns3::MAX_CC_INTER_BAND

static

Initial value:

16 . 16 ( one operation band)

Definition at line 26 of file cc-bwp-helper.h.

◆ MAX_CC_INTRA_BAND

const uint8_t ns3::MAX_CC_INTRA_BAND

static

Initial value:

. 16, 8

Definition at line 24 of file cc-bwp-helper.h.

◆ OMNI_BEAM_ID

const BeamId ns3::OMNI_BEAM_ID = BeamId(UINT16_MAX, UINT16_MAX)

Name of the OMNI beam.

Definition at line 9 of file beam-id.cc.

Referenced by ns3::BeamManager::ChangeToQuasiOmniBeamformingVector(), ns3::CellScanQuasiOmniBeamforming::GetBeamformingVectors(), ns3::QuasiOmniDirectPathBeamforming::GetBeamformingVectors(), ns3::DirectPathQuasiOmniBeamforming::GetBeamformingVectors(), ns3::KroneckerQuasiOmniBeamforming::GetBeamformingVectors(), and ns3::BeamManager::GetBeamId().

◆ PREDEFINED_BEAM_ID

const BeamId ns3::PREDEFINED_BEAM_ID = BeamId(UINT16_MAX - 1, UINT16_MAX - 1)

Reserved ID for the predefined directional beam if it cannot be expressed through sector and elevation.

Definition at line 10 of file beam-id.cc.

Files

Classes

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

◆ BandwidthPartInfoConstPtr

◆ BandwidthPartInfoPtr

◆ BandwidthPartInfoPtrVector

◆ BeamformingVector

◆ ComponentCarrierInfoPtr

Enumeration Type Documentation

◆ LteNrTddSlotType

Function Documentation

◆ CreateDirectionalBfv()

◆ CreateDirectionalBfvAz()

◆ CreateQuasiOmniBfv()

Variable Documentation

◆ MAX_CC_INTER_BAND

◆ MAX_CC_INTRA_BAND

◆ OMNI_BEAM_ID

◆ PREDEFINED_BEAM_ID