This minimal SpectrumPhy implementation calculates the SINR with respect to the strongest signal for a given point. More...

#include "rem-spectrum-phy.h"

Inheritance diagram for ns3::RemSpectrumPhy:

Collaboration diagram for ns3::RemSpectrumPhy:

Public Member Functions
	RemSpectrumPhy ()

	~RemSpectrumPhy () override

void	Deactivate ()
	make StartRx a no-op from now on, and mark instance as inactive

void	DoDispose () override
	Destructor implementation.

Ptr< Object >	GetAntenna () const override
	Get the AntennaModel used by this SpectrumPhy instance for transmission and/or reception.

Ptr< NetDevice >	GetDevice () const override
	Get the associated NetDevice instance.

Ptr< MobilityModel >	GetMobility () const override
	Get the associated MobilityModel instance.

Ptr< const SpectrumModel >	GetRxSpectrumModel () const override

double	GetSinr (double noisePower) const

bool	IsActive () const

void	Reset ()
	Reset the SINR calculator.

void	SetChannel (Ptr< SpectrumChannel > c) override
	Set the channel attached to this device.

void	SetDevice (Ptr< NetDevice > d) override
	Set the associated NetDevice instance.

void	SetMobility (Ptr< MobilityModel > m) override
	Set the mobility model associated with this device.

void	SetRbId (int32_t rbId)
	set RB Id

void	SetRxSpectrumModel (Ptr< const SpectrumModel > m)
	set the RX spectrum model to be used

void	SetUseDataChannel (bool value)
	set usage of DataChannel

void	StartRx (Ptr< SpectrumSignalParameters > params) override
	Notify the SpectrumPhy instance of an incoming signal.

Public Member Functions inherited from ns3::SpectrumPhy
	SpectrumPhy ()

	SpectrumPhy (const SpectrumPhy &)=delete

	~SpectrumPhy () override

virtual Ptr< Object >	GetAntenna () const =0
	Get the AntennaModel used by this SpectrumPhy instance for transmission and/or reception.

virtual Ptr< NetDevice >	GetDevice () const =0
	Get the associated NetDevice instance.

virtual Ptr< MobilityModel >	GetMobility () const =0
	Get the associated MobilityModel instance.

virtual Ptr< const SpectrumModel >	GetRxSpectrumModel () const =0

SpectrumPhy &	operator= (const SpectrumPhy &)=delete

virtual void	SetChannel (Ptr< SpectrumChannel > c)=0
	Set the channel attached to this device.

virtual void	SetDevice (Ptr< NetDevice > d)=0
	Set the associated NetDevice instance.

virtual void	SetMobility (Ptr< MobilityModel > m)=0
	Set the mobility model associated with this device.

virtual void	StartRx (Ptr< SpectrumSignalParameters > params)=0
	Notify the SpectrumPhy instance of an incoming signal.

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 TypeId	GetTypeId ()
	Get the type ID.

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

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.

Private Attributes
bool	m_active
	is active?

Ptr< MobilityModel >	m_mobility
	the mobility model

int32_t	m_rbId
	RBID.

double	m_referenceSignalPower
	reference signal power

Ptr< const SpectrumModel >	m_rxSpectrumModel
	receive spectrum model

double	m_sumPower
	sum power

bool	m_useDataChannel
	use data channel

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 minimal SpectrumPhy implementation calculates the SINR with respect to the strongest signal for a given point.

Introspection did not find any typical Config paths.

The original purpose of this class is to be used to generate a Radio Environment Map (REM) by locating several instances in a grid fashion, and connecting them to the channel only for a very short amount of time.

The assumption on which this class works is that the system being considered is an infrastructure radio access network using FDD, hence all signals will be transmitted simultaneously.

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

Definition at line 50 of file rem-spectrum-phy.h.

Constructor & Destructor Documentation

◆ RemSpectrumPhy()

ns3::RemSpectrumPhy::RemSpectrumPhy ( )

Definition at line 40 of file rem-spectrum-phy.cc.

References NS_LOG_FUNCTION.

◆ ~RemSpectrumPhy()

ns3::RemSpectrumPhy::~RemSpectrumPhy ( )

override

Definition at line 51 of file rem-spectrum-phy.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ Deactivate()

void ns3::RemSpectrumPhy::Deactivate ( )

make StartRx a no-op from now on, and mark instance as inactive

Definition at line 192 of file rem-spectrum-phy.cc.

References m_active.

◆ DoDispose()

void ns3::RemSpectrumPhy::DoDispose ( )

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 57 of file rem-spectrum-phy.cc.

References ns3::Object::DoDispose(), m_mobility, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ GetAntenna()

Ptr< Object > ns3::RemSpectrumPhy::GetAntenna ( ) const

overridevirtual

Get the AntennaModel used by this SpectrumPhy instance for transmission and/or reception.

Note that in general and depending on each module design, there can be multiple SpectrumPhy instances per NetDevice.

Returns: a Ptr to the AntennaModel used by this SpectrumPhy instance for transmission and/or reception

Implements ns3::SpectrumPhy.

Definition at line 115 of file rem-spectrum-phy.cc.

◆ GetDevice()

Ptr< NetDevice > ns3::RemSpectrumPhy::GetDevice ( ) const

overridevirtual

Get the associated NetDevice instance.

Returns: a Ptr to the associated NetDevice instance

Implements ns3::SpectrumPhy.

Definition at line 103 of file rem-spectrum-phy.cc.

◆ GetMobility()

Ptr< MobilityModel > ns3::RemSpectrumPhy::GetMobility ( ) const

overridevirtual

Get the associated MobilityModel instance.

Returns: a Ptr to the associated MobilityModel instance

Implements ns3::SpectrumPhy.

Definition at line 97 of file rem-spectrum-phy.cc.

References m_mobility.

◆ GetRxSpectrumModel()

Ptr< const SpectrumModel > ns3::RemSpectrumPhy::GetRxSpectrumModel ( ) const

overridevirtual

Returns: returns the SpectrumModel that this SpectrumPhy expects to be used for all SpectrumValues that are passed to StartRx. If 0 is returned, it means that any model will be accepted.

Implements ns3::SpectrumPhy.

Definition at line 109 of file rem-spectrum-phy.cc.

References m_rxSpectrumModel.

◆ GetSinr()

double ns3::RemSpectrumPhy::GetSinr ( double noisePower ) const

Parameters

noisePower the noise power

Returns: the Signal to Noise Ratio calculated

Definition at line 186 of file rem-spectrum-phy.cc.

References m_referenceSignalPower, and m_sumPower.

◆ GetTypeId()

TypeId ns3::RemSpectrumPhy::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 65 of file rem-spectrum-phy.cc.

References ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ IsActive()

bool ns3::RemSpectrumPhy::IsActive ( ) const

Returns: true if active

Definition at line 198 of file rem-spectrum-phy.cc.

References m_active.

◆ Reset()

void ns3::RemSpectrumPhy::Reset ( )

Reset the SINR calculator.

Definition at line 204 of file rem-spectrum-phy.cc.

References m_referenceSignalPower, and m_sumPower.

◆ SetChannel()

void ns3::RemSpectrumPhy::SetChannel ( Ptr< SpectrumChannel > c )

overridevirtual

Set the channel attached to this device.

Parameters

c	the channel

Implements ns3::SpectrumPhy.

Definition at line 75 of file rem-spectrum-phy.cc.

◆ SetDevice()

void ns3::RemSpectrumPhy::SetDevice ( Ptr< NetDevice > d )

overridevirtual

Set the associated NetDevice instance.

Parameters

d	the NetDevice instance

Implements ns3::SpectrumPhy.

Definition at line 89 of file rem-spectrum-phy.cc.

References NS_LOG_FUNCTION.

◆ SetMobility()

void ns3::RemSpectrumPhy::SetMobility ( Ptr< MobilityModel > m )

overridevirtual

Set the mobility model associated with this device.

Parameters

m	the mobility model

Implements ns3::SpectrumPhy.

Definition at line 82 of file rem-spectrum-phy.cc.

References m_mobility, and NS_LOG_FUNCTION.

◆ SetRbId()

void ns3::RemSpectrumPhy::SetRbId ( int32_t rbId )

set RB Id

Parameters

rbId	Resource Block Id which will be processed

Definition at line 217 of file rem-spectrum-phy.cc.

References m_rbId.

◆ SetRxSpectrumModel()

void ns3::RemSpectrumPhy::SetRxSpectrumModel ( Ptr< const SpectrumModel > m )

set the RX spectrum model to be used

Parameters

m

Definition at line 179 of file rem-spectrum-phy.cc.

References m_rxSpectrumModel, and NS_LOG_FUNCTION.

◆ SetUseDataChannel()

void ns3::RemSpectrumPhy::SetUseDataChannel ( bool value )

set usage of DataChannel

Parameters

value if true, data channel signal will be processed, control signal otherwise

Definition at line 211 of file rem-spectrum-phy.cc.

References m_useDataChannel.

◆ StartRx()

void ns3::RemSpectrumPhy::StartRx ( Ptr< SpectrumSignalParameters > params )

overridevirtual

Notify the SpectrumPhy instance of an incoming signal.

Parameters

params the parameters of the signals being received

Implements ns3::SpectrumPhy.

Definition at line 121 of file rem-spectrum-phy.cc.

References ns3::Integral(), m_active, m_rbId, m_referenceSignalPower, m_sumPower, m_useDataChannel, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Here is the call graph for this function:

Member Data Documentation

◆ m_active

bool ns3::RemSpectrumPhy::m_active

private

is active?

Definition at line 127 of file rem-spectrum-phy.h.

Referenced by Deactivate(), IsActive(), and StartRx().

◆ m_mobility

Ptr<MobilityModel> ns3::RemSpectrumPhy::m_mobility

private

the mobility model

Definition at line 121 of file rem-spectrum-phy.h.

Referenced by DoDispose(), GetMobility(), and SetMobility().

◆ m_rbId

int32_t ns3::RemSpectrumPhy::m_rbId

private

RBID.

Definition at line 130 of file rem-spectrum-phy.h.

Referenced by SetRbId(), and StartRx().

◆ m_referenceSignalPower

double ns3::RemSpectrumPhy::m_referenceSignalPower

private

reference signal power

Definition at line 124 of file rem-spectrum-phy.h.

Referenced by GetSinr(), Reset(), and StartRx().

◆ m_rxSpectrumModel

Ptr<const SpectrumModel> ns3::RemSpectrumPhy::m_rxSpectrumModel

private

receive spectrum model

Definition at line 122 of file rem-spectrum-phy.h.

Referenced by GetRxSpectrumModel(), and SetRxSpectrumModel().

◆ m_sumPower

double ns3::RemSpectrumPhy::m_sumPower

private

sum power

Definition at line 125 of file rem-spectrum-phy.h.

Referenced by GetSinr(), Reset(), and StartRx().

◆ m_useDataChannel

bool ns3::RemSpectrumPhy::m_useDataChannel

private

use data channel

Definition at line 129 of file rem-spectrum-phy.h.

Referenced by SetUseDataChannel(), and StartRx().

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

src/lte/model/rem-spectrum-phy.h
src/lte/model/rem-spectrum-phy.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RemSpectrumPhy()

◆ ~RemSpectrumPhy()

Member Function Documentation

◆ Deactivate()

◆ DoDispose()

◆ GetAntenna()

◆ GetDevice()

◆ GetMobility()

◆ GetRxSpectrumModel()

◆ GetSinr()

◆ GetTypeId()

◆ IsActive()

◆ Reset()

◆ SetChannel()

◆ SetDevice()

◆ SetMobility()

◆ SetRbId()

◆ SetRxSpectrumModel()

◆ SetUseDataChannel()

◆ StartRx()

Member Data Documentation

◆ m_active

◆ m_mobility

◆ m_rbId

◆ m_referenceSignalPower

◆ m_rxSpectrumModel

◆ m_sumPower

◆ m_useDataChannel