A Discrete-Event Network Simulator
API
ns3::ThreeGppChannelModel Class Reference

Channel Matrix Generation following 3GPP TR 38.901. More...

#include "three-gpp-channel-model.h"

+ Inheritance diagram for ns3::ThreeGppChannelModel:
+ Collaboration diagram for ns3::ThreeGppChannelModel:

Classes

struct  ParamsTable
 Data structure that stores the parameters of 3GPP TR 38.901, Table 7.5-6, for a certain scenario. More...
 
struct  ThreeGppChannelMatrix
 Extends the struct ChannelMatrix by including information that are used within the class ThreeGppChannelModel. More...
 

Public Member Functions

 ThreeGppChannelModel ()
 Constructor. More...
 
 ~ThreeGppChannelModel ()
 Destructor. More...
 
int64_t AssignStreams (int64_t stream)
 Assign a fixed random variable stream number to the random variables used by this model. More...
 
void DoDispose () override
 Destructor implementation. More...
 
Ptr< const ChannelMatrixGetChannel (Ptr< const MobilityModel > aMob, Ptr< const MobilityModel > bMob, Ptr< const PhasedArrayModel > aAntenna, Ptr< const PhasedArrayModel > bAntenna) override
 Looks for the channel matrix associated to the aMob and bMob pair in m_channelMap. More...
 
Ptr< ChannelConditionModelGetChannelConditionModel () const
 Get the associated channel condition model. More...
 
double GetFrequency (void) const
 Returns the center frequency. More...
 
std::string GetScenario (void) const
 Returns the propagation scenario. More...
 
void SetChannelConditionModel (Ptr< ChannelConditionModel > model)
 Set the channel condition model. More...
 
void SetFrequency (double f)
 Sets the center frequency of the model. More...
 
void SetScenario (const std::string &scenario)
 Sets the propagation scenario. More...
 
- Public Member Functions inherited from ns3::MatrixBasedChannelModel
virtual ~MatrixBasedChannelModel ()
 Destructor for MatrixBasedChannelModel. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject () const
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId ()
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::MatrixBasedChannelModel
static constexpr uint32_t GetKey (uint32_t x1, uint32_t x2)
 Calculate the channel key using the Cantor function. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Member Functions

DoubleVector CalcAttenuationOfBlockage (Ptr< ThreeGppChannelMatrix > params, const DoubleVector &clusterAOA, const DoubleVector &clusterZOA) const
 Applies the blockage model A described in 3GPP TR 38.901. More...
 
bool ChannelMatrixNeedsUpdate (Ptr< const ThreeGppChannelMatrix > channelMatrix, Ptr< const ChannelCondition > channelCondition) const
 Check if the channel matrix has to be updated. More...
 
Ptr< ThreeGppChannelMatrixGetNewChannel (Vector locUT, Ptr< const ChannelCondition > channelCondition, Ptr< const PhasedArrayModel > sAntenna, Ptr< const PhasedArrayModel > uAntenna, Angles &uAngle, Angles &sAngle, double dis2D, double hBS, double hUT) const
 Compute the channel matrix between two devices using the procedure described in 3GPP TR 38.901. More...
 
virtual Ptr< const ParamsTableGetThreeGppTable (Ptr< const ChannelCondition > channelCondition, double hBS, double hUT, double distance2D) const
 Get the parameters needed to apply the channel generation procedure. More...
 
void Shuffle (double *first, double *last) const
 Shuffle the elements of a simple sequence container of type double. More...
 

Static Private Member Functions

static std::pair< double, double > WrapAngles (double azimuthRad, double inclinationRad)
 Wrap an (azimuth, inclination) angle pair in a valid range. More...
 

Private Attributes

bool m_blockage
 enables the blockage model A More...
 
double m_blockerSpeed
 the blocker speed More...
 
Ptr< ChannelConditionModelm_channelConditionModel
 the channel condition model More...
 
std::unordered_map< uint32_t, Ptr< ThreeGppChannelMatrix > > m_channelMap
 map containing the channel realizations More...
 
double m_frequency
 the operating frequency More...
 
Ptr< NormalRandomVariablem_normalRv
 normal random variable More...
 
uint16_t m_numNonSelfBlocking
 number of non-self-blocking regions More...
 
bool m_portraitMode
 true if potrait mode, false if landscape More...
 
std::string m_scenario
 the 3GPP scenario More...
 
Ptr< UniformRandomVariablem_uniformRv
 uniform random variable More...
 
Ptr< UniformRandomVariablem_uniformRvShuffle
 uniform random variable used to shuffle array in GetNewChannel More...
 
Time m_updatePeriod
 the channel update period More...
 

Static Private Attributes

static const uint8_t PHI_INDEX = 0
 index of the PHI value in the m_nonSelfBlocking array More...
 
static const uint8_t R_INDEX = 4
 index of the R value in the m_nonSelfBlocking array More...
 
static const uint8_t THETA_INDEX = 2
 index of the THETA value in the m_nonSelfBlocking array More...
 
static const uint8_t X_INDEX = 1
 index of the X value in the m_nonSelfBlocking array More...
 
static const uint8_t Y_INDEX = 3
 index of the Y value in the m_nonSelfBlocking array More...
 

Additional Inherited Members

- Public Types inherited from ns3::MatrixBasedChannelModel
typedef std::vector< PhasedArrayModel::ComplexVectorComplex2DVector
 type definition for complex matrices More...
 
typedef std::vector< Complex2DVectorComplex3DVector
 type definition for complex 3D matrices More...
 
typedef std::vector< DoubleVectorDouble2DVector
 type definition for matrices of doubles More...
 
typedef std::vector< Double2DVectorDouble3DVector
 type definition for 3D matrices of doubles More...
 
typedef std::vector< double > DoubleVector
 type definition for vectors of doubles More...
 
- Static Public Attributes inherited from ns3::MatrixBasedChannelModel
static const uint8_t AOA_INDEX = 0
 index of the AOA value in the m_angle array More...
 
static const uint8_t AOD_INDEX = 2
 index of the AOD value in the m_angle array More...
 
static const uint8_t ZOA_INDEX = 1
 index of the ZOA value in the m_angle array More...
 
static const uint8_t ZOD_INDEX = 3
 index of the ZOD value in the m_angle array More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

Channel Matrix Generation following 3GPP TR 38.901.


Introspection did not find any typical Config paths.

The class implements the channel matrix generation procedure described in 3GPP TR 38.901.

See also
GetChannel


Attributes

  • Frequency: The operating Frequency in Hz
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 5e+08
    • Flags: construct write read
  • Scenario: The 3GPP scenario (RMa, UMa, UMi-StreetCanyon, InH-OfficeOpen, InH-OfficeMixed)
    • Set with class: StringValue
    • Underlying type:
    • Initial value: UMa
    • Flags: construct write read
  • ChannelConditionModel: Pointer to the channel condition model
  • UpdatePeriod: Specify the channel coherence time
    • Set with class: ns3::TimeValue
    • Underlying type: Time -9.22337e+18ns:+9.22337e+18ns
    • Initial value: +0ns
    • Flags: construct write read
  • Blockage: Enable blockage model A (sec 7.6.4.1)
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: false
    • Flags: construct write read
  • NumNonselfBlocking: number of non-self-blocking regions
    • Set with class: ns3::IntegerValue
    • Underlying type: uint16_t 0:65535
    • Initial value: 4
    • Flags: construct write read
  • PortraitMode: true for portrait mode, false for landscape mode
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: true
    • Flags: construct write read
  • BlockerSpeed: The speed of moving blockers, the unit is m/s
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 1
    • Flags: construct write read

No TraceSources are defined for this type.
Size of this type is 160 bytes (on a 64-bit architecture).

Definition at line 48 of file three-gpp-channel-model.h.

Constructor & Destructor Documentation

◆ ThreeGppChannelModel()

ns3::ThreeGppChannelModel::ThreeGppChannelModel ( )

Constructor.

Definition at line 163 of file three-gpp-channel-model.cc.

References m_normalRv, m_uniformRv, m_uniformRvShuffle, and NS_LOG_FUNCTION.

◆ ~ThreeGppChannelModel()

ns3::ThreeGppChannelModel::~ThreeGppChannelModel ( )

Destructor.

Definition at line 174 of file three-gpp-channel-model.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ AssignStreams()

int64_t ns3::ThreeGppChannelModel::AssignStreams ( int64_t  stream)

Assign a fixed random variable stream number to the random variables used by this model.

Parameters
streamfirst stream index to use
Returns
the number of stream indices assigned by this model

Definition at line 2014 of file three-gpp-channel-model.cc.

References m_normalRv, m_uniformRv, m_uniformRvShuffle, NS_LOG_FUNCTION, and ns3::RandomVariableStream::SetStream().

+ Here is the call graph for this function:

◆ CalcAttenuationOfBlockage()

MatrixBasedChannelModel::DoubleVector ns3::ThreeGppChannelModel::CalcAttenuationOfBlockage ( Ptr< ThreeGppChannelMatrix params,
const DoubleVector clusterAOA,
const DoubleVector clusterZOA 
) const
private

Applies the blockage model A described in 3GPP TR 38.901.

Parameters
paramsthe channel matrix
clusterAOAvector containing the azimuth angle of arrival for each cluster
clusterZOAvector containing the zenith angle of arrival for each cluster
Returns
vector containing the power attenuation for each cluster

Definition at line 1784 of file three-gpp-channel-model.cc.

References ns3::DegreesToRadians(), ns3::UniformRandomVariable::GetValue(), m_blockerSpeed, m_frequency, m_normalRv, m_numNonSelfBlocking, m_portraitMode, m_scenario, m_uniformRv, ns3::Now(), NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_INFO, PHI_INDEX, R_INDEX, THETA_INDEX, X_INDEX, and Y_INDEX.

Referenced by GetNewChannel().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ ChannelMatrixNeedsUpdate()

bool ns3::ThreeGppChannelModel::ChannelMatrixNeedsUpdate ( Ptr< const ThreeGppChannelMatrix channelMatrix,
Ptr< const ChannelCondition channelCondition 
) const
private

Check if the channel matrix has to be updated.

Parameters
channelMatrixchannel matrix
channelConditionthe channel condition
Returns
true if the channel matrix has to be updated, false otherwise

Definition at line 947 of file three-gpp-channel-model.cc.

References ns3::Time::As(), ns3::Time::IsZero(), ns3::ThreeGppChannelModel::ThreeGppChannelMatrix::m_channelCondition, ns3::MatrixBasedChannelModel::ChannelMatrix::m_generatedTime, m_updatePeriod, ns3::Now(), ns3::Simulator::Now(), ns3::Time::NS, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by GetChannel().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ DoDispose()

void ns3::ThreeGppChannelModel::DoDispose ( void  )
overridevirtual

Destructor implementation.

This method is called by Dispose() or by the Object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overridden version of this method and chain up to their parent's implementation once they are done. i.e, for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose() method.

It is safe to call GetObject() from within this method.

Reimplemented from ns3::Object.

Definition at line 180 of file three-gpp-channel-model.cc.

References m_channelConditionModel, and m_channelMap.

◆ GetChannel()

Ptr< const MatrixBasedChannelModel::ChannelMatrix > ns3::ThreeGppChannelModel::GetChannel ( Ptr< const MobilityModel aMob,
Ptr< const MobilityModel bMob,
Ptr< const PhasedArrayModel aAntenna,
Ptr< const PhasedArrayModel bAntenna 
)
overridevirtual

Looks for the channel matrix associated to the aMob and bMob pair in m_channelMap.

If found, it checks if it has to be updated. If not found or if it has to be updated, it generates a new uncorrelated channel matrix using the method GetNewChannel and updates m_channelMap.

Parameters
aMobmobility model of the a device
bMobmobility model of the b device
aAntennaantenna of the a device
bAntennaantenna of the b device
Returns
the channel matrix

Implements ns3::MatrixBasedChannelModel.

Definition at line 971 of file three-gpp-channel-model.cc.

References ChannelMatrixNeedsUpdate(), ns3::Node::GetId(), ns3::MatrixBasedChannelModel::GetKey(), GetNewChannel(), m_channelConditionModel, m_channelMap, ns3::MatrixBasedChannelModel::ChannelMatrix::m_nodeIds, max, min, NS_LOG_DEBUG, NS_LOG_FUNCTION, and sample-rng-plot::x.

Referenced by ThreeGppChannelMatrixComputationTest::DoComputeNorm(), and ThreeGppChannelMatrixUpdateTest::DoGetChannel().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetChannelConditionModel()

Ptr< ChannelConditionModel > ns3::ThreeGppChannelModel::GetChannelConditionModel ( void  ) const

Get the associated channel condition model.

Returns
a pointer to the ChannelConditionModel object

Definition at line 251 of file three-gpp-channel-model.cc.

References m_channelConditionModel, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetFrequency()

double ns3::ThreeGppChannelModel::GetFrequency ( void  ) const

Returns the center frequency.

Returns
the center frequency in Hz

Definition at line 266 of file three-gpp-channel-model.cc.

References m_frequency, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetNewChannel()

Ptr< ThreeGppChannelModel::ThreeGppChannelMatrix > ns3::ThreeGppChannelModel::GetNewChannel ( Vector  locUT,
Ptr< const ChannelCondition channelCondition,
Ptr< const PhasedArrayModel sAntenna,
Ptr< const PhasedArrayModel uAntenna,
Angles uAngle,
Angles sAngle,
double  dis2D,
double  hBS,
double  hUT 
) const
private

Compute the channel matrix between two devices using the procedure described in 3GPP TR 38.901.

Parameters
locUTthe location of the UT
channelConditionthe channel condition
sAntennathe s node antenna array
uAntennathe u node antenna array
uAnglethe u node angle
sAnglethe s node angle
dis2Dthe 2D distance between tx and rx
hBSthe height of the BS
hUTthe height of the UT
Returns
the channel realization

Definition at line 1040 of file three-gpp-channel-model.cc.

References CalcAttenuationOfBlockage(), ns3::DegreesToRadians(), ns3::Angles::GetAzimuth(), ns3::Angles::GetInclination(), GetThreeGppTable(), ns3::UniformRandomVariable::GetValue(), ns3::MatrixBasedChannelModel::ChannelMatrix::m_angle, m_blockage, ns3::ThreeGppChannelModel::ParamsTable::m_cASA, ns3::ThreeGppChannelModel::ParamsTable::m_cASD, ns3::ThreeGppChannelModel::ParamsTable::m_cDS, ns3::MatrixBasedChannelModel::ChannelMatrix::m_channel, ns3::ThreeGppChannelModel::ThreeGppChannelMatrix::m_channelCondition, ns3::ThreeGppChannelModel::ThreeGppChannelMatrix::m_clusterPhase, ns3::ThreeGppChannelModel::ParamsTable::m_cZSA, ns3::MatrixBasedChannelModel::ChannelMatrix::m_delay, ns3::ThreeGppChannelModel::ThreeGppChannelMatrix::m_DS, m_frequency, ns3::MatrixBasedChannelModel::ChannelMatrix::m_generatedTime, ns3::ThreeGppChannelModel::ThreeGppChannelMatrix::m_K, m_normalRv, ns3::ThreeGppChannelModel::ThreeGppChannelMatrix::m_numCluster, ns3::ThreeGppChannelModel::ParamsTable::m_numOfCluster, ns3::ThreeGppChannelModel::ParamsTable::m_offsetZOD, ns3::ThreeGppChannelModel::ParamsTable::m_perClusterShadowingStd, ns3::ThreeGppChannelModel::ParamsTable::m_raysPerCluster, ns3::ThreeGppChannelModel::ParamsTable::m_rTau, ns3::ThreeGppChannelModel::ParamsTable::m_sigK, ns3::ThreeGppChannelModel::ParamsTable::m_sigLgASA, ns3::ThreeGppChannelModel::ParamsTable::m_sigLgASD, ns3::ThreeGppChannelModel::ParamsTable::m_sigLgDS, ns3::ThreeGppChannelModel::ParamsTable::m_sigLgZSA, ns3::ThreeGppChannelModel::ParamsTable::m_sigLgZSD, ns3::ThreeGppChannelModel::ParamsTable::m_sigXpr, ns3::ThreeGppChannelModel::ParamsTable::m_sqrtC, ns3::ThreeGppChannelModel::ParamsTable::m_uK, ns3::ThreeGppChannelModel::ParamsTable::m_uLgASA, ns3::ThreeGppChannelModel::ParamsTable::m_uLgASD, ns3::ThreeGppChannelModel::ParamsTable::m_uLgDS, ns3::ThreeGppChannelModel::ParamsTable::m_uLgZSA, ns3::ThreeGppChannelModel::ParamsTable::m_uLgZSD, m_uniformRv, ns3::ThreeGppChannelModel::ParamsTable::m_uXpr, ns3::max(), min, ns3::min(), ns3::Simulator::Now(), NS_ASSERT, NS_ASSERT_MSG, NS_FATAL_ERROR, NS_LOG_FUNCTION, NS_LOG_INFO, ns3::offSetAlpha, ns3::RadiansToDegrees(), Shuffle(), and WrapAngles().

Referenced by GetChannel().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetScenario()

std::string ns3::ThreeGppChannelModel::GetScenario ( void  ) const

Returns the propagation scenario.

Returns
the propagation scenario

Definition at line 285 of file three-gpp-channel-model.cc.

References m_scenario, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetThreeGppTable()

Ptr< const ThreeGppChannelModel::ParamsTable > ns3::ThreeGppChannelModel::GetThreeGppTable ( Ptr< const ChannelCondition channelCondition,
double  hBS,
double  hUT,
double  distance2D 
) const
privatevirtual

Get the parameters needed to apply the channel generation procedure.

Parameters
channelConditionthe channel condition
hBSthe height of the BS
hUTthe height of the UT
distance2Dthe 2D distance between tx and rx
Returns
the parameters table

Definition at line 292 of file three-gpp-channel-model.cc.

References ns3::ThreeGppChannelModel::ParamsTable::m_cASA, ns3::ThreeGppChannelModel::ParamsTable::m_cASD, ns3::ThreeGppChannelModel::ParamsTable::m_cDS, ns3::ThreeGppChannelModel::ParamsTable::m_cZSA, m_frequency, ns3::ThreeGppChannelModel::ParamsTable::m_numOfCluster, ns3::ThreeGppChannelModel::ParamsTable::m_offsetZOD, ns3::ThreeGppChannelModel::ParamsTable::m_perClusterShadowingStd, ns3::ThreeGppChannelModel::ParamsTable::m_raysPerCluster, ns3::ThreeGppChannelModel::ParamsTable::m_rTau, m_scenario, ns3::ThreeGppChannelModel::ParamsTable::m_sigK, ns3::ThreeGppChannelModel::ParamsTable::m_sigLgASA, ns3::ThreeGppChannelModel::ParamsTable::m_sigLgASD, ns3::ThreeGppChannelModel::ParamsTable::m_sigLgDS, ns3::ThreeGppChannelModel::ParamsTable::m_sigLgZSA, ns3::ThreeGppChannelModel::ParamsTable::m_sigLgZSD, ns3::ThreeGppChannelModel::ParamsTable::m_sigXpr, ns3::ThreeGppChannelModel::ParamsTable::m_sqrtC, ns3::ThreeGppChannelModel::ParamsTable::m_uK, ns3::ThreeGppChannelModel::ParamsTable::m_uLgASA, ns3::ThreeGppChannelModel::ParamsTable::m_uLgASD, ns3::ThreeGppChannelModel::ParamsTable::m_uLgDS, ns3::ThreeGppChannelModel::ParamsTable::m_uLgZSA, ns3::ThreeGppChannelModel::ParamsTable::m_uLgZSD, ns3::ThreeGppChannelModel::ParamsTable::m_uXpr, max, NS_ASSERT_MSG, NS_FATAL_ERROR, NS_LOG_FUNCTION, NS_LOG_WARN, ns3::sqrtC_office_LOS, ns3::sqrtC_office_NLOS, ns3::sqrtC_RMa_LOS, ns3::sqrtC_RMa_NLOS, ns3::sqrtC_RMa_O2I, ns3::sqrtC_UMa_LOS, ns3::sqrtC_UMa_NLOS, ns3::sqrtC_UMa_O2I, ns3::sqrtC_UMi_LOS, ns3::sqrtC_UMi_NLOS, and ns3::sqrtC_UMi_O2I.

Referenced by GetNewChannel().

+ Here is the caller graph for this function:

◆ GetTypeId()

◆ SetChannelConditionModel()

void ns3::ThreeGppChannelModel::SetChannelConditionModel ( Ptr< ChannelConditionModel model)

Set the channel condition model.

Parameters
apointer to the ChannelConditionModel object

Definition at line 244 of file three-gpp-channel-model.cc.

References m_channelConditionModel, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ SetFrequency()

void ns3::ThreeGppChannelModel::SetFrequency ( double  f)

Sets the center frequency of the model.

Parameters
fthe center frequency in Hz

Definition at line 258 of file three-gpp-channel-model.cc.

References f(), m_frequency, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ SetScenario()

void ns3::ThreeGppChannelModel::SetScenario ( const std::string &  scenario)

Sets the propagation scenario.

Parameters
scenariothe propagation scenario

Definition at line 273 of file three-gpp-channel-model.cc.

References m_scenario, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ Shuffle()

void ns3::ThreeGppChannelModel::Shuffle ( double *  first,
double *  last 
) const
private

Shuffle the elements of a simple sequence container of type double.

Parameters
firstPointer to the first element among the elements to be shuffled
lastPointer to the last element among the elements to be shuffled

Definition at line 2005 of file three-gpp-channel-model.cc.

References ns3::UniformRandomVariable::GetInteger(), and m_uniformRvShuffle.

Referenced by GetNewChannel().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ WrapAngles()

std::pair< double, double > ns3::ThreeGppChannelModel::WrapAngles ( double  azimuthRad,
double  inclinationRad 
)
staticprivate

Wrap an (azimuth, inclination) angle pair in a valid range.

Specifically, inclination must be in [0, M_PI] and azimuth in [0, 2*M_PI). If the inclination angle is outside of its range, the azimuth angle is rotated by M_PI. This methods aims specifically at solving the problem of generating angles at the boundaries of the angle domain, specifically, generating angle distributions close to inclinationRad=0 and inclinationRad=M_PI.

Parameters
azimuthRadthe azimuth angle in radians
inclinationRadthe inclination angle in radians
Returns
the wrapped (azimuth, inclination) angle pair in radians

Definition at line 1763 of file three-gpp-channel-model.cc.

References NS_ASSERT_MSG, and ns3::WrapTo2Pi().

Referenced by GetNewChannel().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ m_blockage

bool ns3::ThreeGppChannelModel::m_blockage
private

enables the blockage model A

Definition at line 268 of file three-gpp-channel-model.h.

Referenced by GetNewChannel(), and GetTypeId().

◆ m_blockerSpeed

double ns3::ThreeGppChannelModel::m_blockerSpeed
private

the blocker speed

Definition at line 271 of file three-gpp-channel-model.h.

Referenced by CalcAttenuationOfBlockage(), and GetTypeId().

◆ m_channelConditionModel

Ptr<ChannelConditionModel> ns3::ThreeGppChannelModel::m_channelConditionModel
private

the channel condition model

Definition at line 262 of file three-gpp-channel-model.h.

Referenced by DoDispose(), GetChannel(), GetChannelConditionModel(), and SetChannelConditionModel().

◆ m_channelMap

std::unordered_map<uint32_t, Ptr<ThreeGppChannelMatrix> > ns3::ThreeGppChannelModel::m_channelMap
private

map containing the channel realizations

Definition at line 258 of file three-gpp-channel-model.h.

Referenced by DoDispose(), and GetChannel().

◆ m_frequency

double ns3::ThreeGppChannelModel::m_frequency
private

the operating frequency

Definition at line 260 of file three-gpp-channel-model.h.

Referenced by CalcAttenuationOfBlockage(), GetFrequency(), GetNewChannel(), GetThreeGppTable(), and SetFrequency().

◆ m_normalRv

Ptr<NormalRandomVariable> ns3::ThreeGppChannelModel::m_normalRv
private

normal random variable

Definition at line 264 of file three-gpp-channel-model.h.

Referenced by AssignStreams(), CalcAttenuationOfBlockage(), GetNewChannel(), and ThreeGppChannelModel().

◆ m_numNonSelfBlocking

uint16_t ns3::ThreeGppChannelModel::m_numNonSelfBlocking
private

number of non-self-blocking regions

Definition at line 269 of file three-gpp-channel-model.h.

Referenced by CalcAttenuationOfBlockage(), and GetTypeId().

◆ m_portraitMode

bool ns3::ThreeGppChannelModel::m_portraitMode
private

true if potrait mode, false if landscape

Definition at line 270 of file three-gpp-channel-model.h.

Referenced by CalcAttenuationOfBlockage(), and GetTypeId().

◆ m_scenario

std::string ns3::ThreeGppChannelModel::m_scenario
private

the 3GPP scenario

Definition at line 261 of file three-gpp-channel-model.h.

Referenced by CalcAttenuationOfBlockage(), GetScenario(), GetThreeGppTable(), and SetScenario().

◆ m_uniformRv

Ptr<UniformRandomVariable> ns3::ThreeGppChannelModel::m_uniformRv
private

uniform random variable

Definition at line 263 of file three-gpp-channel-model.h.

Referenced by AssignStreams(), CalcAttenuationOfBlockage(), GetNewChannel(), and ThreeGppChannelModel().

◆ m_uniformRvShuffle

Ptr<UniformRandomVariable> ns3::ThreeGppChannelModel::m_uniformRvShuffle
private

uniform random variable used to shuffle array in GetNewChannel

Definition at line 265 of file three-gpp-channel-model.h.

Referenced by AssignStreams(), Shuffle(), and ThreeGppChannelModel().

◆ m_updatePeriod

Time ns3::ThreeGppChannelModel::m_updatePeriod
private

the channel update period

Definition at line 259 of file three-gpp-channel-model.h.

Referenced by ChannelMatrixNeedsUpdate(), and GetTypeId().

◆ PHI_INDEX

const uint8_t ns3::ThreeGppChannelModel::PHI_INDEX = 0
staticprivate

index of the PHI value in the m_nonSelfBlocking array

Definition at line 273 of file three-gpp-channel-model.h.

Referenced by CalcAttenuationOfBlockage().

◆ R_INDEX

const uint8_t ns3::ThreeGppChannelModel::R_INDEX = 4
staticprivate

index of the R value in the m_nonSelfBlocking array

Definition at line 277 of file three-gpp-channel-model.h.

Referenced by CalcAttenuationOfBlockage().

◆ THETA_INDEX

const uint8_t ns3::ThreeGppChannelModel::THETA_INDEX = 2
staticprivate

index of the THETA value in the m_nonSelfBlocking array

Definition at line 275 of file three-gpp-channel-model.h.

Referenced by CalcAttenuationOfBlockage().

◆ X_INDEX

const uint8_t ns3::ThreeGppChannelModel::X_INDEX = 1
staticprivate

index of the X value in the m_nonSelfBlocking array

Definition at line 274 of file three-gpp-channel-model.h.

Referenced by CalcAttenuationOfBlockage().

◆ Y_INDEX

const uint8_t ns3::ThreeGppChannelModel::Y_INDEX = 3
staticprivate

index of the Y value in the m_nonSelfBlocking array

Definition at line 276 of file three-gpp-channel-model.h.

Referenced by CalcAttenuationOfBlockage().


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