A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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 ()
 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
 
void SetCellId (uint16_t cellId)
 
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)
 
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

Ptr< AntennaModelm_antenna
 
uint16_t m_cellId
 
Ptr< SpectrumChannelm_channel
 
Ptr< NetDevicem_device
 
Ptr< MobilityModelm_mobility
 
Ptr< const SpectrumModelm_rxSpectrumModel
 
TracedCallback< Ptr< const
SpectrumValue > > 
m_rxStart
 

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

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

ns3::LteSimpleSpectrumPhy::LteSimpleSpectrumPhy ( )

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

ns3::LteSimpleSpectrumPhy::~LteSimpleSpectrumPhy ( )
virtual

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

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::LteSimpleSpectrumPhy::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 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:

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

get the associated NetDevice instance

Returns
a Ptr to the associated NetDevice instance

Implements ns3::SpectrumPhy.

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

References m_device, and NS_LOG_FUNCTION.

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

get the associated MobilityModel instance

Returns
a Ptr to the associated MobilityModel instance

Implements ns3::SpectrumPhy.

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

References m_mobility, and NS_LOG_FUNCTION.

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

References m_antenna.

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 114 of file lte-simple-spectrum-phy.cc.

References m_rxSpectrumModel.

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

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:

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

Set the channel attached to this device.

Parameters
cthe channel

Implements ns3::SpectrumPhy.

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

References m_channel, and NS_LOG_FUNCTION.

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

set the associated NetDevice instance

Parameters
dthe NetDevice instance

Implements ns3::SpectrumPhy.

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

References m_device, and NS_LOG_FUNCTION.

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 99 of file lte-simple-spectrum-phy.cc.

References m_mobility, and NS_LOG_FUNCTION.

void ns3::LteSimpleSpectrumPhy::SetRxSpectrumModel ( Ptr< const SpectrumModel model)
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 127 of file lte-simple-spectrum-phy.cc.

References m_cellId, m_rxStart, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Member Data Documentation

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

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

Referenced by GetRxAntenna().

uint16_t ns3::LteSimpleSpectrumPhy::m_cellId
private

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

Referenced by SetCellId(), and StartRx().

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

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

Referenced by DoDispose(), and SetChannel().

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

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

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

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

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

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

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

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

Referenced by GetRxSpectrumModel(), and SetRxSpectrumModel().

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

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

Referenced by GetTypeId(), and StartRx().


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