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"
Public Member Functions | |
LteSimpleSpectrumPhy () | |
~LteSimpleSpectrumPhy () override | |
void | DoDispose () override |
Destructor implementation. | |
Ptr< Object > | GetAntenna () const override |
Get the AntennaModel used by this SpectrumPhy instance for transmission and/or reception. | |
Ptr< NetDevice > | GetDevice () const override |
Get the associated NetDevice instance. | |
Ptr< MobilityModel > | GetMobility () const override |
Get the associated MobilityModel instance. | |
Ptr< const SpectrumModel > | GetRxSpectrumModel () const override |
void | SetCellId (uint16_t cellId) |
Set cell ID. | |
void | SetChannel (Ptr< SpectrumChannel > c) override |
Set the channel attached to this device. | |
void | SetDevice (Ptr< NetDevice > d) override |
Set the associated NetDevice instance. | |
void | SetMobility (Ptr< MobilityModel > m) override |
Set the mobility model associated with this device. | |
void | SetRxSpectrumModel (Ptr< const SpectrumModel > model) |
Set receive spectrum model. | |
void | StartRx (Ptr< SpectrumSignalParameters > params) override |
Notify the SpectrumPhy instance of an incoming signal. | |
Public Member Functions inherited from ns3::SpectrumPhy | |
SpectrumPhy () | |
SpectrumPhy (const SpectrumPhy &)=delete | |
~SpectrumPhy () override | |
virtual Ptr< Object > | GetAntenna () const =0 |
Get the AntennaModel used by this SpectrumPhy instance for transmission and/or reception. | |
virtual Ptr< NetDevice > | GetDevice () const =0 |
Get the associated NetDevice instance. | |
virtual Ptr< MobilityModel > | GetMobility () const =0 |
Get the associated MobilityModel instance. | |
virtual Ptr< const SpectrumModel > | GetRxSpectrumModel () const =0 |
SpectrumPhy & | operator= (const SpectrumPhy &)=delete |
virtual void | SetChannel (Ptr< SpectrumChannel > c)=0 |
Set the channel attached to this device. | |
virtual void | SetDevice (Ptr< NetDevice > d)=0 |
Set the associated NetDevice instance. | |
virtual void | SetMobility (Ptr< MobilityModel > m)=0 |
Set the mobility model associated with this device. | |
virtual void | StartRx (Ptr< SpectrumSignalParameters > params)=0 |
Notify the SpectrumPhy instance of an incoming signal. | |
Public Member Functions inherited from ns3::Object | |
Object () | |
Constructor. | |
~Object () override | |
Destructor. | |
void | AggregateObject (Ptr< Object > other) |
Aggregate two Objects together. | |
void | Dispose () |
Dispose of this Object. | |
AggregateIterator | GetAggregateIterator () const |
Get an iterator to the Objects aggregated to this one. | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. | |
template<typename T > | |
Ptr< T > | GetObject () const |
Get a pointer to the requested aggregated Object. | |
template<> | |
Ptr< Object > | GetObject () const |
Specialization of () for objects of type ns3::Object. | |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
Get a pointer to the requested aggregated Object by TypeId. | |
template<> | |
Ptr< Object > | GetObject (TypeId tid) const |
Specialization of (TypeId tid) for objects of type ns3::Object. | |
void | Initialize () |
Invoke DoInitialize on all Objects aggregated to this one. | |
bool | IsInitialized () const |
Check if the object has been initialized. | |
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
SimpleRefCount () | |
Default constructor. | |
SimpleRefCount (const SimpleRefCount &o) | |
Copy constructor. | |
uint32_t | GetReferenceCount () const |
Get the reference count of the object. | |
SimpleRefCount & | operator= (const SimpleRefCount &o) |
Assignment operator. | |
void | Ref () const |
Increment the reference count. | |
void | Unref () const |
Decrement the reference count. | |
Public Member Functions inherited from ns3::ObjectBase | |
virtual | ~ObjectBase () |
Virtual destructor. | |
void | GetAttribute (std::string name, AttributeValue &value) const |
Get the value of an attribute, raising fatal errors if unsuccessful. | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising errors. | |
virtual TypeId | GetInstanceTypeId () const =0 |
Get the most derived TypeId for this Object. | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. | |
Static Public Member Functions | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::SpectrumPhy | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId () |
Register this type. | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. | |
Private Attributes | |
Ptr< AntennaModel > | m_antenna |
the antenna model | |
uint16_t | m_cellId |
the cell ID | |
Ptr< SpectrumChannel > | m_channel |
the channel | |
Ptr< NetDevice > | m_device |
the device | |
Ptr< MobilityModel > | m_mobility |
the mobility model | |
Ptr< const SpectrumModel > | m_rxSpectrumModel |
the spectrum model | |
TracedCallback< Ptr< const SpectrumValue > > | m_rxStart |
receive start trace callback function | |
Additional Inherited Members | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
Copy an Object. | |
virtual void | DoDispose () |
Destructor implementation. | |
virtual void | DoInitialize () |
Initialize() implementation. | |
virtual void | NotifyNewAggregate () |
Notify all Objects aggregated to this one of a new Object being aggregated. | |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. | |
virtual void | NotifyConstructionCompleted () |
Notifier called once the ObjectBase is fully constructed. | |
Related Functions inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
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.
ns3::LteSimpleSpectrumPhy::LteSimpleSpectrumPhy | ( | ) |
Definition at line 41 of file lte-simple-spectrum-phy.cc.
|
override |
Definition at line 46 of file lte-simple-spectrum-phy.cc.
References NS_LOG_FUNCTION.
|
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 52 of file lte-simple-spectrum-phy.cc.
References ns3::Object::DoDispose(), m_channel, m_device, 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 116 of file lte-simple-spectrum-phy.cc.
References m_antenna.
Get 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.
|
overridevirtual |
Get the associated MobilityModel instance.
Implements ns3::SpectrumPhy.
Definition at line 82 of file lte-simple-spectrum-phy.cc.
References m_mobility, and NS_LOG_FUNCTION.
|
overridevirtual |
Implements ns3::SpectrumPhy.
Definition at line 110 of file lte-simple-spectrum-phy.cc.
References m_rxSpectrumModel.
|
static |
Get the type ID.
Definition at line 62 of file lte-simple-spectrum-phy.cc.
References m_rxStart, ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().
void ns3::LteSimpleSpectrumPhy::SetCellId | ( | uint16_t | cellId | ) |
Set cell ID.
cellId | the cell ID |
Definition at line 158 of file lte-simple-spectrum-phy.cc.
References m_cellId, and NS_LOG_FUNCTION.
|
overridevirtual |
Set the channel attached to this device.
c | the channel |
Implements ns3::SpectrumPhy.
Definition at line 103 of file lte-simple-spectrum-phy.cc.
References m_channel, and NS_LOG_FUNCTION.
Set the associated NetDevice instance.
d | the NetDevice instance |
Implements ns3::SpectrumPhy.
Definition at line 89 of file lte-simple-spectrum-phy.cc.
References m_device, and NS_LOG_FUNCTION.
|
overridevirtual |
Set the mobility model associated with this device.
m | the mobility model |
Implements ns3::SpectrumPhy.
Definition at line 96 of file lte-simple-spectrum-phy.cc.
References m_mobility, and NS_LOG_FUNCTION.
void ns3::LteSimpleSpectrumPhy::SetRxSpectrumModel | ( | Ptr< const SpectrumModel > | model | ) |
Set receive spectrum model.
model | the spectrum model |
Definition at line 151 of file lte-simple-spectrum-phy.cc.
References m_rxSpectrumModel, and NS_LOG_FUNCTION.
|
overridevirtual |
Notify the SpectrumPhy instance of an incoming signal.
params | the parameters of the signals being received |
Implements ns3::SpectrumPhy.
Definition at line 122 of file lte-simple-spectrum-phy.cc.
References m_cellId, m_rxStart, NS_LOG_DEBUG, and NS_LOG_FUNCTION.
|
private |
the antenna model
Definition at line 85 of file lte-simple-spectrum-phy.h.
Referenced by GetAntenna().
|
private |
the cell ID
Definition at line 90 of file lte-simple-spectrum-phy.h.
Referenced by SetCellId(), and StartRx().
|
private |
the channel
Definition at line 87 of file lte-simple-spectrum-phy.h.
Referenced by DoDispose(), and SetChannel().
the device
Definition at line 86 of file lte-simple-spectrum-phy.h.
Referenced by DoDispose(), GetDevice(), and SetDevice().
|
private |
the mobility model
Definition at line 84 of file lte-simple-spectrum-phy.h.
Referenced by DoDispose(), GetMobility(), and SetMobility().
|
private |
the spectrum model
Definition at line 88 of file lte-simple-spectrum-phy.h.
Referenced by GetRxSpectrumModel(), and SetRxSpectrumModel().
|
private |
receive start trace callback function
Definition at line 92 of file lte-simple-spectrum-phy.h.
Referenced by GetTypeId(), and StartRx().