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

The LteSimpleSpectrumPhy models the physical layer of LTE This class is used to test Frequency Reuse Algorithms, it allow to get SpectrumValue from channel and pass it to test script by trace mechanism. More...

#include "lte-simple-spectrum-phy.h"

+ Inheritance diagram for ns3::LteSimpleSpectrumPhy:
+ Collaboration diagram for ns3::LteSimpleSpectrumPhy:

Public Member Functions

 LteSimpleSpectrumPhy ()
 
virtual ~LteSimpleSpectrumPhy ()
 
virtual 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
 
void SetCellId (uint16_t cellId)
 Set cell ID. 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 > model)
 Set receive spectrum model. 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

Ptr< AntennaModelm_antenna
 the antenna model More...
 
uint16_t m_cellId
 the cell ID More...
 
Ptr< SpectrumChannelm_channel
 the channel More...
 
Ptr< NetDevicem_device
 the device More...
 
Ptr< MobilityModelm_mobility
 the mobility model More...
 
Ptr< const SpectrumModelm_rxSpectrumModel
 the spectrum model More...
 
TracedCallback< Ptr< const SpectrumValue > > m_rxStart
 receive start trace callback function 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

The LteSimpleSpectrumPhy models the physical layer of LTE This class is used to test Frequency Reuse Algorithms, it allow to get SpectrumValue from channel and pass it to test script by trace mechanism.

When m_cellId is 0, all received signals will be traced, if m_cellId > 0, only signals from specified Cell will be traced.

Definition at line 47 of file lte-simple-spectrum-phy.h.

Constructor & Destructor Documentation

◆ LteSimpleSpectrumPhy()

ns3::LteSimpleSpectrumPhy::LteSimpleSpectrumPhy ( )

Definition at line 39 of file lte-simple-spectrum-phy.cc.

◆ ~LteSimpleSpectrumPhy()

ns3::LteSimpleSpectrumPhy::~LteSimpleSpectrumPhy ( )
virtual

Definition at line 45 of file lte-simple-spectrum-phy.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoDispose()

void ns3::LteSimpleSpectrumPhy::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 50 of file lte-simple-spectrum-phy.cc.

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

+ Here is the call graph for this function:

◆ GetDevice()

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

Get the associated NetDevice instance.

Returns
a Ptr to the associated NetDevice instance

Implements ns3::SpectrumPhy.

Definition at line 76 of file lte-simple-spectrum-phy.cc.

References m_device, and NS_LOG_FUNCTION.

◆ GetMobility()

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

Get the associated MobilityModel instance.

Returns
a Ptr to the associated MobilityModel instance

Implements ns3::SpectrumPhy.

Definition at line 84 of file lte-simple-spectrum-phy.cc.

References m_mobility, and NS_LOG_FUNCTION.

◆ GetRxAntenna()

Ptr< AntennaModel > ns3::LteSimpleSpectrumPhy::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 122 of file lte-simple-spectrum-phy.cc.

References m_antenna.

◆ GetRxSpectrumModel()

Ptr< const SpectrumModel > ns3::LteSimpleSpectrumPhy::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 115 of file lte-simple-spectrum-phy.cc.

References m_rxSpectrumModel.

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 61 of file lte-simple-spectrum-phy.cc.

References m_rxStart, ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ SetCellId()

void ns3::LteSimpleSpectrumPhy::SetCellId ( uint16_t  cellId)

Set cell ID.

Parameters
cellIdthe cell ID

Definition at line 163 of file lte-simple-spectrum-phy.cc.

References m_cellId, and NS_LOG_FUNCTION.

Referenced by LteStrictFrAreaTestCase::DoRun(), LteSoftFrAreaTestCase::DoRun(), LteSoftFfrAreaTestCase::DoRun(), LteEnhancedFfrAreaTestCase::DoRun(), and LteDistributedFfrAreaTestCase::DoRun().

+ Here is the caller graph for this function:

◆ SetChannel()

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

Set the channel attached to this device.

Parameters
cthe channel

Implements ns3::SpectrumPhy.

Definition at line 108 of file lte-simple-spectrum-phy.cc.

References m_channel, and NS_LOG_FUNCTION.

◆ SetDevice()

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

Set the associated NetDevice instance.

Parameters
dthe NetDevice instance

Implements ns3::SpectrumPhy.

Definition at line 92 of file lte-simple-spectrum-phy.cc.

References m_device, and NS_LOG_FUNCTION.

◆ SetMobility()

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

Set the mobility model associated with this device.

Parameters
mthe mobility model

Implements ns3::SpectrumPhy.

Definition at line 100 of file lte-simple-spectrum-phy.cc.

References m_mobility, and NS_LOG_FUNCTION.

◆ SetRxSpectrumModel()

void ns3::LteSimpleSpectrumPhy::SetRxSpectrumModel ( Ptr< const SpectrumModel model)

Set receive spectrum model.

Parameters
modelthe spectrum model

Definition at line 156 of file lte-simple-spectrum-phy.cc.

References m_rxSpectrumModel, and NS_LOG_FUNCTION.

Referenced by LteHardFrTestCase::DoRun(), LteStrictFrTestCase::DoRun(), LteStrictFrAreaTestCase::DoRun(), LteSoftFrAreaTestCase::DoRun(), LteSoftFfrAreaTestCase::DoRun(), LteEnhancedFfrAreaTestCase::DoRun(), and LteDistributedFfrAreaTestCase::DoRun().

+ Here is the caller graph for this function:

◆ StartRx()

void ns3::LteSimpleSpectrumPhy::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 128 of file lte-simple-spectrum-phy.cc.

References m_cellId, m_rxStart, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Member Data Documentation

◆ m_antenna

Ptr<AntennaModel> ns3::LteSimpleSpectrumPhy::m_antenna
private

the antenna model

Definition at line 86 of file lte-simple-spectrum-phy.h.

Referenced by GetRxAntenna().

◆ m_cellId

uint16_t ns3::LteSimpleSpectrumPhy::m_cellId
private

the cell ID

Definition at line 91 of file lte-simple-spectrum-phy.h.

Referenced by SetCellId(), and StartRx().

◆ m_channel

Ptr<SpectrumChannel> ns3::LteSimpleSpectrumPhy::m_channel
private

the channel

Definition at line 88 of file lte-simple-spectrum-phy.h.

Referenced by DoDispose(), and SetChannel().

◆ m_device

Ptr<NetDevice> ns3::LteSimpleSpectrumPhy::m_device
private

the device

Definition at line 87 of file lte-simple-spectrum-phy.h.

Referenced by DoDispose(), GetDevice(), and SetDevice().

◆ m_mobility

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

the mobility model

Definition at line 85 of file lte-simple-spectrum-phy.h.

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

◆ m_rxSpectrumModel

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

the spectrum model

Definition at line 89 of file lte-simple-spectrum-phy.h.

Referenced by GetRxSpectrumModel(), and SetRxSpectrumModel().

◆ m_rxStart

TracedCallback< Ptr<const SpectrumValue> > ns3::LteSimpleSpectrumPhy::m_rxStart
private

receive start trace callback function

Definition at line 93 of file lte-simple-spectrum-phy.h.

Referenced by GetTypeId(), and StartRx().


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