This is an interface for a channel model that can be described by a channel matrix, e.g., the 3GPP Spatial Channel Models, which is generally used in combination with antenna arrays. More...

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

Inheritance diagram for ns3::MatrixBasedChannelModel:

Collaboration diagram for ns3::MatrixBasedChannelModel:

Classes
struct	ChannelMatrix
	Data structure that stores a channel realization. More...

struct	ChannelParams
	Data structure that stores channel parameters. More...

Public Types
using	Complex2DVector = ComplexMatrixArray
	Create an alias for 2D complex vectors.

using	Complex3DVector = ComplexMatrixArray
	Create an alias for 3D complex vectors.

using	Double2DVector = std::vector< DoubleVector >
	Type definition for matrices of doubles.

using	Double3DVector = std::vector< Double2DVector >
	Type definition for 3D matrices of doubles.

using	DoubleVector = std::vector< double >
	Type definition for vectors of doubles.

Public Member Functions
	~MatrixBasedChannelModel () override
	Destructor for MatrixBasedChannelModel.

virtual Ptr< const ChannelMatrix >	GetChannel (Ptr< const MobilityModel > aMob, Ptr< const MobilityModel > bMob, Ptr< const PhasedArrayModel > aAntenna, Ptr< const PhasedArrayModel > bAntenna)=0
	Returns a matrix with a realization of the channel between the nodes with mobility objects passed as input parameters.

virtual Ptr< const ChannelParams >	GetParams (Ptr< const MobilityModel > aMob, Ptr< const MobilityModel > bMob) const =0
	Returns a channel parameters structure used to obtain the channel between the nodes with mobility objects passed as input parameters.

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor.

	~Object () override
	Destructor.

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together.

void	Dispose ()
	Dispose of this Object.

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one.

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

template<typename T >
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object.

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object.

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId.

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object.

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one.

bool	IsInitialized () const
	Check if the object has been initialized.

void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor.

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

uint32_t	GetReferenceCount () const
	Get the reference count of the object.

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

virtual TypeId	GetInstanceTypeId () const =0
	Get the most derived TypeId for this Object.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static uint64_t	GetKey (uint32_t a, uint32_t b)
	Generate a unique value for the pair of unsigned integer of 32 bits, where the order does not matter, i.e., the same value will be returned for (a,b) and (b,a).

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId ()
	Register this type.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Attributes
static const uint8_t	AOA_INDEX = 0
	index of the AOA value in the m_angle array

static const uint8_t	AOD_INDEX = 2
	index of the AOD value in the m_angle array

static const uint8_t	ZOA_INDEX = 1
	index of the ZOA value in the m_angle array

static const uint8_t	ZOD_INDEX = 3
	index of the ZOD value in the m_angle array

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.

virtual void	DoDispose ()
	Destructor implementation.

virtual void	DoInitialize ()
	Initialize() implementation.

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated.

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

This is an interface for a channel model that can be described by a channel matrix, e.g., the 3GPP Spatial Channel Models, which is generally used in combination with antenna arrays.

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

Member Typedef Documentation

◆ Complex2DVector

using ns3::MatrixBasedChannelModel::Complex2DVector = ComplexMatrixArray

Create an alias for 2D complex vectors.

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

◆ Complex3DVector

using ns3::MatrixBasedChannelModel::Complex3DVector = ComplexMatrixArray

Create an alias for 3D complex vectors.

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

◆ Double2DVector

using ns3::MatrixBasedChannelModel::Double2DVector = std::vector<DoubleVector>

Type definition for matrices of doubles.

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

◆ Double3DVector

using ns3::MatrixBasedChannelModel::Double3DVector = std::vector<Double2DVector>

Type definition for 3D matrices of doubles.

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

◆ DoubleVector

using ns3::MatrixBasedChannelModel::DoubleVector = std::vector<double>

Type definition for vectors of doubles.

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

Constructor & Destructor Documentation

◆ ~MatrixBasedChannelModel()

ns3::MatrixBasedChannelModel::~MatrixBasedChannelModel ( )

override

Destructor for MatrixBasedChannelModel.

Definition at line 26 of file matrix-based-channel-model.cc.

Member Function Documentation

◆ GetChannel()

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

pure virtual

Returns a matrix with a realization of the channel between the nodes with mobility objects passed as input parameters.

We assume channel reciprocity between each node pair (i.e., H_ab = H_ba^T), therefore GetChannel (a, b) and GetChannel (b, a) will return the same ChannelMatrix object. To understand if the channel matrix corresponds to H_ab or H_ba, we provide the method ChannelMatrix::IsReverse. For instance, if the channel matrix corresponds to H_ab, a call to IsReverse (idA, idB) will return false, conversely, IsReverse (idB, idA) will return true.

Parameters

aMob	mobility model of the a device
bMob	mobility model of the b device
aAntenna	antenna of the a device
bAntenna	antenna of the b device

Returns: the channel matrix

Implemented in ns3::ThreeGppChannelModel.

◆ GetKey()

static uint64_t ns3::MatrixBasedChannelModel::GetKey	(	uint32_t	a,
		uint32_t	b
	)

inlinestatic

Generate a unique value for the pair of unsigned integer of 32 bits, where the order does not matter, i.e., the same value will be returned for (a,b) and (b,a).

Parameters