5G-LENA: ns3::ScenarioParameters Class Reference

Searching...

No Matches

Basic simulation scenario parameters. More...

#include "scenario-parameters.h"

Inheritance diagram for ns3::ScenarioParameters:

Public Types
enum	SiteSectorizationType { NONE = 0 , SINGLE = 1 , TRIPLE = 3 }
	Type of site sectorization. More...

Public Member Functions
virtual	~ScenarioParameters ()
	~ScenarioParameters

uint32_t	GetNumSectorsPerSite () const
	Gets the number of sectors per site.

void	SetBsHeight (double h)
	SetGnbHeight.

void	SetRMaParameters ()
	Sets rural Macro scenario parameters.

void	SetScenarioParameters (const ScenarioParameters &scenario)
	Sets parameters to the specified scenario.

void	SetScenarioParameters (const std::string &scenario)
	Sets parameters to the specified scenario.

void	SetSectorization (SiteSectorizationType numSectors)
	Sets the number of sectors of every site.

void	SetSectorization (uint32_t numSectors)
	Sets the number of sectors of every site.

void	SetUMaParameters ()
	Sets the Urban Macro (UMa) scenario parameters.

void	SetUMiParameters ()
	Sets the Urban Micro (UMi) scenario parameters.

void	SetUtHeight (double h)
	SetUeHeight.

Public Attributes
double	m_antennaOffset {-1.0}
	Cell antenna offset in meters w.r.t. site location.

double	m_bsHeight {-1.0}
	Height of gNB nodes.

double	m_isd {-1.0}
	Inter-site distance (ISD) in meters.

double	m_minBsUtDistance {-1.0}
	Minimum distance between BS and UT in meters.

SiteSectorizationType	m_sectorization {NONE}
	Number of sectors per site.

double	m_utHeight {-1.0}
	Height of UE nodes.

Static Public Attributes
static double	MAX_ANTENNA_OFFSET = 1

Detailed Description

Basic simulation scenario parameters.

Definition at line 16 of file scenario-parameters.h.

Member Enumeration Documentation

◆ SiteSectorizationType

enum ns3::ScenarioParameters::SiteSectorizationType

Type of site sectorization.

Enumerator
NONE	Unconfigured value.
SINGLE	Site with a 360º-width sector.
TRIPLE	Site with 3 120º-width sectors.

Definition at line 22 of file scenario-parameters.h.

Constructor & Destructor Documentation

◆ ~ScenarioParameters()

ns3::ScenarioParameters::~ScenarioParameters ( )

virtual

~ScenarioParameters

Definition at line 12 of file scenario-parameters.cc.

Member Function Documentation

◆ GetNumSectorsPerSite()

uint32_t ns3::ScenarioParameters::GetNumSectorsPerSite ( ) const

Gets the number of sectors per site.

Definition at line 29 of file scenario-parameters.cc.

References m_sectorization.

Referenced by ns3::FileScenarioHelper::CreateScenario(), and ns3::HexagonalGridScenarioHelper::GetHexagonalCellCenter().

Here is the caller graph for this function:

◆ SetBsHeight()

void ns3::ScenarioParameters::SetBsHeight ( double h )

SetGnbHeight.

Parameters

h height

Definition at line 17 of file scenario-parameters.cc.

References m_bsHeight.

◆ SetRMaParameters()

void ns3::ScenarioParameters::SetRMaParameters ( )

Sets rural Macro scenario parameters.

Definition at line 101 of file scenario-parameters.cc.

References m_antennaOffset, m_bsHeight, m_isd, m_minBsUtDistance, m_sectorization, m_utHeight, and TRIPLE.

Referenced by SetScenarioParameters().

Here is the caller graph for this function:

◆ SetScenarioParameters() [1/2]

void ns3::ScenarioParameters::SetScenarioParameters ( const ScenarioParameters & scenario )

Sets parameters to the specified scenario.

Parameters

scenario Scenario to simulate

Definition at line 68 of file scenario-parameters.cc.

References m_antennaOffset, m_bsHeight, m_isd, m_minBsUtDistance, m_sectorization, and m_utHeight.

◆ SetScenarioParameters() [2/2]

void ns3::ScenarioParameters::SetScenarioParameters ( const std::string & scenario )

Sets parameters to the specified scenario.

Parameters

scenario Scenario to simulate

Definition at line 47 of file scenario-parameters.cc.

References SetRMaParameters(), SetUMaParameters(), and SetUMiParameters().

Here is the call graph for this function:

◆ SetSectorization() [1/2]

void ns3::ScenarioParameters::SetSectorization ( SiteSectorizationType numSectors )

Sets the number of sectors of every site.

Parameters

numSectors Number of sectors. Values can be 1 or 3.

Definition at line 35 of file scenario-parameters.cc.

References m_sectorization.

Referenced by SetSectorization().

Here is the caller graph for this function:

◆ SetSectorization() [2/2]

void ns3::ScenarioParameters::SetSectorization ( uint32_t numSectors )

Sets the number of sectors of every site.

Parameters

numSectors Number of sectors. Values can be 1 or 3.

Definition at line 41 of file scenario-parameters.cc.

References SetSectorization().

Here is the call graph for this function:

◆ SetUMaParameters()

void ns3::ScenarioParameters::SetUMaParameters ( )

Sets the Urban Macro (UMa) scenario parameters.

Definition at line 79 of file scenario-parameters.cc.

References m_antennaOffset, m_bsHeight, m_isd, m_minBsUtDistance, m_sectorization, m_utHeight, and TRIPLE.

Referenced by SetScenarioParameters().

Here is the caller graph for this function:

◆ SetUMiParameters()

void ns3::ScenarioParameters::SetUMiParameters ( )

Sets the Urban Micro (UMi) scenario parameters.

Definition at line 90 of file scenario-parameters.cc.

References m_antennaOffset, m_bsHeight, m_isd, m_minBsUtDistance, m_sectorization, m_utHeight, and TRIPLE.

Referenced by SetScenarioParameters().

Here is the caller graph for this function:

◆ SetUtHeight()

void ns3::ScenarioParameters::SetUtHeight ( double h )

SetUeHeight.

Parameters

h heights

Definition at line 23 of file scenario-parameters.cc.

References m_utHeight.

Member Data Documentation

◆ m_antennaOffset

double ns3::ScenarioParameters::m_antennaOffset {-1.0}

Cell antenna offset in meters w.r.t. site location.

Definition at line 92 of file scenario-parameters.h.

Referenced by ns3::FileScenarioHelper::CreateScenario(), ns3::NodeDistributionScenarioInterface::GetAntennaPosition(), SetRMaParameters(), SetScenarioParameters(), SetUMaParameters(), and SetUMiParameters().

◆ m_bsHeight

double ns3::ScenarioParameters::m_bsHeight {-1.0}

Height of gNB nodes.

Definition at line 88 of file scenario-parameters.h.

Referenced by ns3::FileScenarioHelper::Add(), ns3::FileScenarioHelper::CreateScenario(), ns3::GridScenarioHelper::CreateScenario(), ns3::HexagonalGridScenarioHelper::CreateScenario(), ns3::HexagonalGridScenarioHelper::CreateScenarioWithMobility(), SetBsHeight(), SetRMaParameters(), SetScenarioParameters(), SetUMaParameters(), and SetUMiParameters().

◆ m_isd

double ns3::ScenarioParameters::m_isd {-1.0}

Inter-site distance (ISD) in meters.

Definition at line 87 of file scenario-parameters.h.

Referenced by ns3::FileScenarioHelper::CreateScenario(), ns3::HexagonalGridScenarioHelper::CreateScenario(), ns3::HexagonalGridScenarioHelper::CreateScenarioWithMobility(), SetRMaParameters(), SetScenarioParameters(), SetUMaParameters(), and SetUMiParameters().

◆ m_minBsUtDistance

double ns3::ScenarioParameters::m_minBsUtDistance {-1.0}

Minimum distance between BS and UT in meters.

Definition at line 91 of file scenario-parameters.h.

◆ m_sectorization

SiteSectorizationType ns3::ScenarioParameters::m_sectorization {NONE}

Number of sectors per site.

Definition at line 90 of file scenario-parameters.h.

Referenced by ns3::FileScenarioHelper::CreateScenario(), ns3::NodeDistributionScenarioInterface::GetAntennaOrientationDegrees(), GetNumSectorsPerSite(), ns3::NodeDistributionScenarioInterface::GetSectorIndex(), ns3::NodeDistributionScenarioInterface::GetSiteIndex(), ns3::NodeDistributionScenarioInterface::SetBsNumber(), SetRMaParameters(), SetScenarioParameters(), SetSectorization(), ns3::NodeDistributionScenarioInterface::SetSitesNumber(), SetUMaParameters(), and SetUMiParameters().

◆ m_utHeight

double ns3::ScenarioParameters::m_utHeight {-1.0}

Height of UE nodes.

Definition at line 89 of file scenario-parameters.h.

Referenced by ns3::FileScenarioHelper::CreateScenario(), ns3::GridScenarioHelper::CreateScenario(), ns3::HexagonalGridScenarioHelper::CreateScenario(), ns3::HexagonalGridScenarioHelper::CreateScenarioWithMobility(), SetRMaParameters(), SetScenarioParameters(), SetUMaParameters(), SetUMiParameters(), and SetUtHeight().

◆ MAX_ANTENNA_OFFSET

double ns3::ScenarioParameters::MAX_ANTENNA_OFFSET = 1

static

Maximum distance between a sector antenna panel and the site it belongs to

Definition at line 95 of file scenario-parameters.h.

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

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Enumeration Documentation

◆ SiteSectorizationType

Constructor & Destructor Documentation

◆ ~ScenarioParameters()

Member Function Documentation

◆ GetNumSectorsPerSite()

◆ SetBsHeight()

◆ SetRMaParameters()

◆ SetScenarioParameters() [1/2]

◆ SetScenarioParameters() [2/2]

◆ SetSectorization() [1/2]

◆ SetSectorization() [2/2]

◆ SetUMaParameters()

◆ SetUMiParameters()

◆ SetUtHeight()

Member Data Documentation

◆ m_antennaOffset

◆ m_bsHeight

◆ m_isd

◆ m_minBsUtDistance

◆ m_sectorization

◆ m_utHeight

◆ MAX_ANTENNA_OFFSET