class
BeamConfIdRepresents the ID of the beam configuration of a PHY. Beam configuration can contain one beamId, or two beamIds. The order of the beams matters. Beam configuration can have either configured only the first beam, or only the second beam or both.
Public static functions
- static auto GetEmptyBeamConfId() -> BeamConfId
- Creates BeamConfId with the first.
Constructors, destructors, conversion operators
- BeamConfId()
- BeamConfId(BeamId firstBeam, BeamId secondBeam)
Public functions
- auto GetFirstBeam() const -> BeamId
- Extract the sector from the beam id.
- auto GetSecondBeam() const -> BeamId
- Extract the elevation from the beam id.
- auto operator!=(const BeamConfId& p) const -> bool
- Overrides != operator for the general use case.
- auto operator==(const BeamConfId& p) const -> bool
- Objects of this class are used as key in hash table. This class must implement operator ==() to handle collisions.
Function documentation
static BeamConfId ns3:: BeamConfId:: GetEmptyBeamConfId()
Creates BeamConfId with the first.
Returns | BeamId (0,0) |
---|
ns3:: BeamConfId:: BeamConfId()
Default constructor
ns3:: BeamConfId:: BeamConfId(BeamId firstBeam,
BeamId secondBeam)
Parameters | |
---|---|
firstBeam | the first beam |
secondBeam | the second beam |
\constructor Constructor used to configure this BeamConfId
If the BeamConfId consists of two beams that the constructor should be called in the following way: BeamConfig (beamId1, beamId2) if there is only the beamId1 BeamConfig (beamId1, BeamId::GetEmptyBeamId() ) if there is only the beamId2 BeamConfig (BeamId::GetEmptyBeamId(), beamId2 )
BeamId ns3:: BeamConfId:: GetFirstBeam() const
Extract the sector from the beam id.
Returns | The sector of the beam |
---|
BeamId ns3:: BeamConfId:: GetSecondBeam() const
Extract the elevation from the beam id.
Returns | the elevation of the beam |
---|
bool ns3:: BeamConfId:: operator!=(const BeamConfId& p) const
Overrides != operator for the general use case.
Parameters | |
---|---|
p | BeamConfId with which we compare this object |
bool ns3:: BeamConfId:: operator==(const BeamConfId& p) const
Objects of this class are used as key in hash table. This class must implement operator ==() to handle collisions.
Parameters | |
---|---|
p | BeamConfId with which we compare this object |