A Discrete-Event Network Simulator
API
ns3::MatrixBasedChannelModel::ChannelMatrix Struct Reference

Data structure that stores a channel realization. More...

#include "matrix-based-channel-model.h"

+ Inheritance diagram for ns3::MatrixBasedChannelModel::ChannelMatrix:
+ Collaboration diagram for ns3::MatrixBasedChannelModel::ChannelMatrix:

Public Member Functions

virtual ~ChannelMatrix ()=default
 Destructor for ChannelMatrix. More...
 
bool IsReverse (uint32_t aAntennaId, uint32_t bAntennaId) const
 Returns true if the ChannelMatrix object was generated considering node b as transmitter and node a as receiver. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< ChannelMatrix >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= ([[maybe_unused]] 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 Attributes

std::pair< uint32_t, uint32_t > m_antennaPair
 the first element is the ID of the antenna of the s-node (the antenna of the transmitter when the channel was generated), the second element is ID of the antenna of the u-node antenna (the antenna of the receiver when the channel was generated) More...
 
Complex3DVector m_channel
 channel matrix H[u][s][n]. More...
 
Time m_generatedTime
 generation time More...
 
std::pair< uint32_t, uint32_t > m_nodeIds
 the first element is the s-node ID (the transmitter when the channel was generated), the second element is the u-node ID (the receiver when the channel was generated) More...
 

Detailed Description

Data structure that stores a channel realization.

Definition at line 60 of file matrix-based-channel-model.h.

Constructor & Destructor Documentation

◆ ~ChannelMatrix()

virtual ns3::MatrixBasedChannelModel::ChannelMatrix::~ChannelMatrix ( )
virtualdefault

Destructor for ChannelMatrix.

Member Function Documentation

◆ IsReverse()

bool ns3::MatrixBasedChannelModel::ChannelMatrix::IsReverse ( uint32_t  aAntennaId,
uint32_t  bAntennaId 
) const
inline

Returns true if the ChannelMatrix object was generated considering node b as transmitter and node a as receiver.

Parameters
aAntennaIdthe ID of the antenna array of the a node
bAntennaIdthe ID of the antenna array of the b node
Returns
true if b is the rx and a is the tx, false otherwise

Definition at line 79 of file matrix-based-channel-model.h.

References m_antennaPair, and NS_ASSERT_MSG.

Member Data Documentation

◆ m_antennaPair

std::pair<uint32_t, uint32_t> ns3::MatrixBasedChannelModel::ChannelMatrix::m_antennaPair

the first element is the ID of the antenna of the s-node (the antenna of the transmitter when the channel was generated), the second element is ID of the antenna of the u-node antenna (the antenna of the receiver when the channel was generated)

Definition at line 64 of file matrix-based-channel-model.h.

Referenced by ns3::ThreeGppChannelModel::GetChannel(), and IsReverse().

◆ m_channel

Complex3DVector ns3::MatrixBasedChannelModel::ChannelMatrix::m_channel

◆ m_generatedTime

Time ns3::MatrixBasedChannelModel::ChannelMatrix::m_generatedTime

generation time

Definition at line 63 of file matrix-based-channel-model.h.

Referenced by ns3::ThreeGppChannelModel::GetNewChannel().

◆ m_nodeIds

std::pair<uint32_t, uint32_t> ns3::MatrixBasedChannelModel::ChannelMatrix::m_nodeIds

the first element is the s-node ID (the transmitter when the channel was generated), the second element is the u-node ID (the receiver when the channel was generated)

Definition at line 65 of file matrix-based-channel-model.h.

Referenced by ns3::ThreeGppChannelModel::GetNewChannel().


The documentation for this struct was generated from the following file: