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

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 ()
 
virtual ~RemSpectrumPhy ()
 
void Deactivate ()
 make StartRx a no-op from now on, and mark instance as inactive More...
 
void DoDispose ()
 Destructor implementation. More...
 
Ptr< NetDeviceGetDevice () const
 Get the associated NetDevice instance. More...
 
Ptr< MobilityModelGetMobility () const
 Get the associated MobilityModel instance. More...
 
Ptr< AntennaModelGetRxAntenna () const
 Get the AntennaModel used by the NetDevice for reception. More...
 
Ptr< const SpectrumModelGetRxSpectrumModel () const
 
double GetSinr (double noisePower)
 
bool IsActive ()
 
void Reset ()
 Reset the SINR calculator. More...
 
void SetChannel (Ptr< SpectrumChannel > c)
 Set the channel attached to this device. More...
 
void SetDevice (Ptr< NetDevice > d)
 Set the associated NetDevice instance. More...
 
void SetMobility (Ptr< MobilityModel > m)
 Set the mobility model associated with this device. More...
 
void SetRbId (int32_t rbId)
 set RB Id More...
 
void SetRxSpectrumModel (Ptr< const SpectrumModel > m)
 set the RX spectrum model to be used More...
 
void SetUseDataChannel (bool value)
 set usage of DataChannel More...
 
void StartRx (Ptr< SpectrumSignalParameters > params)
 Notify the SpectrumPhy instance of an incoming signal. More...
 
- Public Member Functions inherited from ns3::SpectrumPhy
 SpectrumPhy ()
 
virtual ~SpectrumPhy ()
 
- 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 (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::SpectrumPhy
static TypeId GetTypeId (void)
 Get the type ID. 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 Attributes

bool m_active
 is active? More...
 
Ptr< MobilityModelm_mobility
 the mobility model More...
 
int32_t m_rbId
 RBID. More...
 
double m_referenceSignalPower
 reference signal power More...
 
Ptr< const SpectrumModelm_rxSpectrumModel
 receive spectrum model More...
 
double m_sumPower
 sum power More...
 
bool m_useDataChannel
 use data channel More...
 

Additional Inherited Members

- 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

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 72 bytes (on a 64-bit architecture).

Definition at line 51 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 ( )
virtual

Definition at line 53 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 194 of file rem-spectrum-phy.cc.

References m_active.

◆ DoDispose()

void ns3::RemSpectrumPhy::DoDispose ( void  )
virtual

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

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

+ Here is the call graph for this function:

◆ GetDevice()

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

Get the associated NetDevice instance.

Returns
a Ptr to the associated NetDevice instance

Implements ns3::SpectrumPhy.

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

◆ GetMobility()

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

Get the associated MobilityModel instance.

Returns
a Ptr to the associated MobilityModel instance

Implements ns3::SpectrumPhy.

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

References m_mobility.

◆ GetRxAntenna()

Ptr< AntennaModel > ns3::RemSpectrumPhy::GetRxAntenna ( ) const
virtual

Get the AntennaModel used by the NetDevice for reception.

Returns
a Ptr to the AntennaModel used by the NetDevice for reception

Implements ns3::SpectrumPhy.

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

◆ GetRxSpectrumModel()

Ptr< const SpectrumModel > ns3::RemSpectrumPhy::GetRxSpectrumModel ( ) const
virtual
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 112 of file rem-spectrum-phy.cc.

References m_rxSpectrumModel.

◆ GetSinr()

double ns3::RemSpectrumPhy::GetSinr ( double  noisePower)
Parameters
noisePowerthe noise power
Returns
the Signal to Noise Ratio calculated

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

References m_referenceSignalPower, and m_sumPower.

◆ GetTypeId()

TypeId ns3::RemSpectrumPhy::GetTypeId ( void  )
static

Get the type ID.

Returns
the object TypeId

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

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ IsActive()

bool ns3::RemSpectrumPhy::IsActive ( )
Returns
true if active

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

References m_active.

◆ Reset()

void ns3::RemSpectrumPhy::Reset ( void  )

Reset the SINR calculator.

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

References m_referenceSignalPower, and m_sumPower.

◆ SetChannel()

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

Set the channel attached to this device.

Parameters
cthe channel

Implements ns3::SpectrumPhy.

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

◆ SetDevice()

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

Set the associated NetDevice instance.

Parameters
dthe NetDevice instance

Implements ns3::SpectrumPhy.

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

References NS_LOG_FUNCTION.

◆ SetMobility()

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

Set the mobility model associated with this device.

Parameters
mthe mobility model

Implements ns3::SpectrumPhy.

Definition at line 86 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
rbIdResource Block Id which will be processed

Definition at line 219 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 181 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
valueif true, data channel signal will be processed, control signal otherwise

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

References m_useDataChannel.

◆ StartRx()

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

Notify the SpectrumPhy instance of an incoming signal.

Parameters
paramsthe parameters of the signals being received

Implements ns3::SpectrumPhy.

Definition at line 125 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 129 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 123 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 132 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 126 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 124 of file rem-spectrum-phy.h.

Referenced by GetRxSpectrumModel(), and SetRxSpectrumModel().

◆ m_sumPower

double ns3::RemSpectrumPhy::m_sumPower
private

sum power

Definition at line 127 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 131 of file rem-spectrum-phy.h.

Referenced by SetUseDataChannel(), and StartRx().


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