A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::RemSpectrumPhy Class Reference

This minimal SpectrumPhy implemetation 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 ()
 This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...
 
Ptr< NetDeviceGetDevice ()
 get the associated NetDevice instance More...
 
Ptr< MobilityModelGetMobility ()
 get the associated MobilityModel instance More...
 
Ptr< AntennaModelGetRxAntenna ()
 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 SetRxSpectrumModel (Ptr< const SpectrumModel > m)
 set the RX spectrum model to be used 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 ()
 
virtual ~Object ()
 
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 Run the DoDispose methods of this object and all the objects aggregated to it. More...
 
AggregateIterator GetAggregateIterator (void) const
 
virtual TypeId GetInstanceTypeId (void) const
 
template<typename T >
Ptr< T > GetObject (void) const
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 
void Initialize (void)
 This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 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. 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
 
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
 
void SetAttribute (std::string name, const AttributeValue &value)
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 

Static Public Member Functions

static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::SpectrumPhy
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 Noop. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Attributes

bool m_active
 
Ptr< MobilityModelm_mobility
 
double m_referenceSignalPower
 
Ptr< const SpectrumModelm_rxSpectrumModel
 
double m_sumPower
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoInitialize (void)
 This method is called only once by Object::Initialize. More...
 
virtual void NotifyNewAggregate (void)
 This method is invoked whenever two sets of objects are aggregated together. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 This method is invoked once all member attributes have been initialized. More...
 

Detailed Description

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

Doxygen 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 infrastructured 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.

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

Constructor & Destructor Documentation

ns3::RemSpectrumPhy::RemSpectrumPhy ( )

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

References NS_LOG_FUNCTION.

ns3::RemSpectrumPhy::~RemSpectrumPhy ( )
virtual

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

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::RemSpectrumPhy::Deactivate ( )

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

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

References m_active.

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

This method is called by Object::Dispose or by the object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overriden 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:

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

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.

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

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.

Ptr< AntennaModel > ns3::RemSpectrumPhy::GetRxAntenna ( )
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 115 of file rem-spectrum-phy.cc.

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

References m_rxSpectrumModel.

double ns3::RemSpectrumPhy::GetSinr ( double  noisePower)
Returns
the Signal to Noise Ratio calculated

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

References m_referenceSignalPower, and m_sumPower.

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

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

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

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

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

References m_active.

void ns3::RemSpectrumPhy::Reset ( void  )

Reset the SINR calculator.

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

References m_referenceSignalPower, and m_sumPower.

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

Set the channel attached to this device.

Parameters
cthe channel

Implements ns3::SpectrumPhy.

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

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

set the associated NetDevice instance

Parameters
dthe NetDevice instance

Implements ns3::SpectrumPhy.

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

References NS_LOG_FUNCTION.

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

References m_mobility, and NS_LOG_FUNCTION.

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

set the RX spectrum model to be used

Parameters
m

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

References m_rxSpectrumModel, and NS_LOG_FUNCTION.

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

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

+ Here is the call graph for this function:

Member Data Documentation

bool ns3::RemSpectrumPhy::m_active
private

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

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

Ptr<MobilityModel> ns3::RemSpectrumPhy::m_mobility
private

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

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

double ns3::RemSpectrumPhy::m_referenceSignalPower
private

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

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

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

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

Referenced by GetRxSpectrumModel(), and SetRxSpectrumModel().

double ns3::RemSpectrumPhy::m_sumPower
private

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

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


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