This minimal SpectrumPhy implementation calculates the SINR with respect to the strongest signal for a given point. More...
#include "rem-spectrum-phy.h"
Public Member Functions | |
RemSpectrumPhy () | |
~RemSpectrumPhy () override | |
void | Deactivate () |
make StartRx a no-op from now on, and mark instance as inactive More... | |
void | DoDispose () override |
Destructor implementation. More... | |
Ptr< Object > | GetAntenna () const override |
Get the AntennaModel used by this SpectrumPhy instance for transmission and/or reception. More... | |
Ptr< NetDevice > | GetDevice () const override |
Get the associated NetDevice instance. More... | |
Ptr< MobilityModel > | GetMobility () const override |
Get the associated MobilityModel instance. More... | |
Ptr< const SpectrumModel > | GetRxSpectrumModel () const override |
double | GetSinr (double noisePower) const |
bool | IsActive () const |
void | Reset () |
Reset the SINR calculator. More... | |
void | SetChannel (Ptr< SpectrumChannel > c) override |
Set the channel attached to this device. More... | |
void | SetDevice (Ptr< NetDevice > d) override |
Set the associated NetDevice instance. More... | |
void | SetMobility (Ptr< MobilityModel > m) override |
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) override |
Notify the SpectrumPhy instance of an incoming signal. More... | |
Public Member Functions inherited from ns3::SpectrumPhy | |
SpectrumPhy () | |
SpectrumPhy (const SpectrumPhy &)=delete | |
~SpectrumPhy () override | |
SpectrumPhy & | operator= (const SpectrumPhy &)=delete |
Public Member Functions inherited from ns3::Object | |
Object () | |
Constructor. More... | |
~Object () override | |
Destructor. More... | |
void | AggregateObject (Ptr< Object > other) |
Aggregate two Objects together. More... | |
void | Dispose () |
Dispose of this Object. More... | |
AggregateIterator | GetAggregateIterator () const |
Get an iterator to the Objects aggregated to this one. More... | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. More... | |
template<typename T > | |
Ptr< T > | GetObject () const |
Get a pointer to the requested aggregated Object. More... | |
template<> | |
Ptr< Object > | GetObject () const |
Specialization of () for objects of type ns3::Object. More... | |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
Get a pointer to the requested aggregated Object by TypeId. More... | |
template<> | |
Ptr< Object > | GetObject (TypeId tid) const |
Specialization of (TypeId tid) for objects of type ns3::Object. More... | |
void | Initialize () |
Invoke DoInitialize on all Objects aggregated to this one. More... | |
bool | IsInitialized () 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[[maybe_unused]]) | |
Copy constructor. More... | |
uint32_t | GetReferenceCount () const |
Get the reference count of the object. More... | |
SimpleRefCount & | operator= (const SimpleRefCount &o[[maybe_unused]]) |
Assignment operator. More... | |
void | Ref () const |
Increment the reference count. More... | |
void | Unref () 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 errors. 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::SpectrumPhy | |
static TypeId | GetTypeId () |
Get the type ID. More... | |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId () |
Register this type. More... | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. More... | |
Private Attributes | |
bool | m_active |
is active? More... | |
Ptr< MobilityModel > | m_mobility |
the mobility model More... | |
int32_t | m_rbId |
RBID. More... | |
double | m_referenceSignalPower |
reference signal power More... | |
Ptr< const SpectrumModel > | m_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 () |
Initialize() implementation. More... | |
virtual void | NotifyNewAggregate () |
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 () |
Notifier called once the ObjectBase is fully constructed. More... | |
Related Functions inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More... | |
This minimal SpectrumPhy implementation calculates the SINR with respect to the strongest signal for a given point.
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.
Definition at line 50 of file rem-spectrum-phy.h.
ns3::RemSpectrumPhy::RemSpectrumPhy | ( | ) |
Definition at line 40 of file rem-spectrum-phy.cc.
References NS_LOG_FUNCTION.
|
override |
Definition at line 51 of file rem-spectrum-phy.cc.
References NS_LOG_FUNCTION.
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.
|
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.
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.
Implements ns3::SpectrumPhy.
Definition at line 115 of file rem-spectrum-phy.cc.
Get the associated NetDevice instance.
Implements ns3::SpectrumPhy.
Definition at line 103 of file rem-spectrum-phy.cc.
|
overridevirtual |
Get the associated MobilityModel instance.
Implements ns3::SpectrumPhy.
Definition at line 97 of file rem-spectrum-phy.cc.
References m_mobility.
|
overridevirtual |
Implements ns3::SpectrumPhy.
Definition at line 109 of file rem-spectrum-phy.cc.
References m_rxSpectrumModel.
double ns3::RemSpectrumPhy::GetSinr | ( | double | noisePower | ) | const |
noisePower | the noise power |
Definition at line 186 of file rem-spectrum-phy.cc.
References m_referenceSignalPower, and m_sumPower.
|
static |
Get the type ID.
Definition at line 65 of file rem-spectrum-phy.cc.
References ns3::TypeId::SetParent().
bool ns3::RemSpectrumPhy::IsActive | ( | ) | const |
void ns3::RemSpectrumPhy::Reset | ( | ) |
Reset the SINR calculator.
Definition at line 204 of file rem-spectrum-phy.cc.
References m_referenceSignalPower, and m_sumPower.
|
overridevirtual |
Set the channel attached to this device.
c | the channel |
Implements ns3::SpectrumPhy.
Definition at line 75 of file rem-spectrum-phy.cc.
Set the associated NetDevice instance.
d | the NetDevice instance |
Implements ns3::SpectrumPhy.
Definition at line 89 of file rem-spectrum-phy.cc.
References NS_LOG_FUNCTION.
|
overridevirtual |
Set the mobility model associated with this device.
m | the mobility model |
Implements ns3::SpectrumPhy.
Definition at line 82 of file rem-spectrum-phy.cc.
References two-ray-to-three-gpp-ch-calibration::m, m_mobility, and NS_LOG_FUNCTION.
void ns3::RemSpectrumPhy::SetRbId | ( | int32_t | rbId | ) |
set RB Id
rbId | Resource Block Id which will be processed |
Definition at line 217 of file rem-spectrum-phy.cc.
References m_rbId.
void ns3::RemSpectrumPhy::SetRxSpectrumModel | ( | Ptr< const SpectrumModel > | m | ) |
set the RX spectrum model to be used
m |
Definition at line 179 of file rem-spectrum-phy.cc.
References two-ray-to-three-gpp-ch-calibration::m, m_rxSpectrumModel, and NS_LOG_FUNCTION.
void ns3::RemSpectrumPhy::SetUseDataChannel | ( | bool | value | ) |
set usage of DataChannel
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.
|
overridevirtual |
Notify the SpectrumPhy instance of an incoming signal.
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, NS_LOG_FUNCTION, and two-ray-to-three-gpp-ch-calibration::params.
|
private |
is active?
Definition at line 127 of file rem-spectrum-phy.h.
Referenced by Deactivate(), IsActive(), and StartRx().
|
private |
the mobility model
Definition at line 121 of file rem-spectrum-phy.h.
Referenced by DoDispose(), GetMobility(), and SetMobility().
|
private |
|
private |
reference signal power
Definition at line 124 of file rem-spectrum-phy.h.
|
private |
receive spectrum model
Definition at line 122 of file rem-spectrum-phy.h.
Referenced by GetRxSpectrumModel(), and SetRxSpectrumModel().
|
private |
sum power
Definition at line 125 of file rem-spectrum-phy.h.
|
private |
use data channel
Definition at line 129 of file rem-spectrum-phy.h.
Referenced by SetUseDataChannel(), and StartRx().