ns3::BeamId class

Representation of a beam id.

A beam id in ns-3 is a pair that contains the sector, stored as a uint16_t, and the elevation, stored as a double. Utilities functions are provided to extract the values. This ID usually comes with the real physical representation of a Beam, expressed by BeamformingVector.

Constructors, destructors, conversion operators

BeamId(): Default constructor which created beamId with 0 sector and 0 elevation.
BeamId(uint16_t sector, double elevation)

Public functions

auto GetCantor() const -> uint32_t
auto GetElevation() const -> double: Extract the elevation from the beam id.
auto GetSector() const -> uint16_t: Extract the sector from the beam id.
auto operator!=(const BeamId& p) const -> bool: Overrides != operator for the general use case.
auto operator==(const BeamId& p) const -> bool: Objects of this class are used as key in hash table. This class must implement operator ==() to handle collisions.

Function documentation

ns3::BeamId::BeamId(uint16_t sector, double elevation)

Parameters
sector	species the sector of the beam
elevation	specifies the elevation of the beam

\constructor Constructor used to configure both sector and elevation.

uint32_t ns3::BeamId::GetCantor() const

Returns	Returns the Cantor function value of this BeamId

double ns3::BeamId::GetElevation() const

Extract the elevation from the beam id.

Returns	the elevation of the beam

uint16_t ns3::BeamId::GetSector() const

Extract the sector from the beam id.

Returns	The sector of the beam

bool ns3::BeamId::operator!=(const BeamId& p) const

Overrides != operator for the general use case.

Parameters
p	BeamId with which we compare this object

bool ns3::BeamId::operator==(const BeamId& p) const

Objects of this class are used as key in hash table. This class must implement operator ==() to handle collisions.

Parameters
p	BeamId with which we compare this object