ns-3
ns3::RemSpectrumPhy Class Reference

#include <rem-spectrum-phy.h>

Inheritance diagram for ns3::RemSpectrumPhy:
Collaboration diagram for ns3::RemSpectrumPhy:

List of all members.

Public Member Functions

void DoDispose ()
void SetChannel (Ptr< SpectrumChannel > c)
void SetMobility (Ptr< MobilityModel > m)
void SetDevice (Ptr< NetDevice > d)
Ptr< MobilityModelGetMobility ()
Ptr< NetDeviceGetDevice ()
Ptr< const SpectrumModelGetRxSpectrumModel () const
Ptr< AntennaModelGetRxAntenna ()
void StartRx (Ptr< SpectrumSignalParameters > params)
void SetRxSpectrumModel (Ptr< const SpectrumModel > m)
double GetSinr (double noisePower)
void Deactivate ()
bool IsActive ()
void Reset ()

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::RemSpectrumPhy.

Detailed Description

This minimal SpectrumPhy implemetation 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 infrastructured radio access network using FDD, hence all signals will be transmitted simultaneously.


Member Function Documentation

void ns3::RemSpectrumPhy::Deactivate ( )

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

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.

References NS_LOG_FUNCTION.

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

get the associated NetDevice instance

Returns:
a Ptr to the associated NetDevice instance

Implements ns3::SpectrumPhy.

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

get the associated MobilityModel instance

Returns:
a Ptr to the associated MobilityModel instance

Implements ns3::SpectrumPhy.

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.

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.

double ns3::RemSpectrumPhy::GetSinr ( double  noisePower)
Returns:
the Signal to Noise Ratio calculated
TypeId ns3::RemSpectrumPhy::GetTypeId ( void  )
static

This method returns the TypeId associated to ns3::RemSpectrumPhy.

No Attributes defined for this type.
No TraceSources defined for this type.

Reimplemented from ns3::SpectrumPhy.

References ns3::TypeId::SetParent().

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

Reset the SINR calculator

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

Set the channel attached to this device.

Parameters:
cthe channel

Implements ns3::SpectrumPhy.

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

set the associated NetDevice instance

Parameters:
dthe NetDevice instance

Implements ns3::SpectrumPhy.

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.

References NS_LOG_FUNCTION.

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

set the RX spectrum model to be used

Parameters:
m

References 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.

References ns3::Integral(), NS_ASSERT_MSG, and NS_LOG_FUNCTION.


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