A Discrete-Event Network Simulator
API
ns3::SpectrumPhy Class Referenceabstract

Abstract base class for Spectrum-aware PHY layers. More...

#include "spectrum-phy.h"

+ Inheritance diagram for ns3::SpectrumPhy:
+ Collaboration diagram for ns3::SpectrumPhy:

Public Member Functions

 SpectrumPhy ()
 
virtual ~SpectrumPhy ()
 
virtual Ptr< NetDeviceGetDevice () const =0
 Get the associated NetDevice instance. More...
 
virtual Ptr< MobilityModelGetMobility () const =0
 Get the associated MobilityModel instance. More...
 
virtual Ptr< AntennaModelGetRxAntenna () const =0
 Get the AntennaModel used by the NetDevice for reception. More...
 
virtual Ptr< const SpectrumModelGetRxSpectrumModel () const =0
 
virtual void SetChannel (Ptr< SpectrumChannel > c)=0
 Set the channel attached to this device. More...
 
virtual void SetDevice (Ptr< NetDevice > d)=0
 Set the associated NetDevice instance. More...
 
virtual void SetMobility (Ptr< MobilityModel > m)=0
 Set the mobility model associated with this device. More...
 
virtual void StartRx (Ptr< SpectrumSignalParameters > params)=0
 Notify the SpectrumPhy instance of an incoming signal. More...
 
- 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::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 Member Functions

 SpectrumPhy (SpectrumPhy const &)
 Copy constructor. More...
 
SpectrumPhyoperator= (SpectrumPhy const &)
 Copy constructor. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose (void)
 Destructor implementation. 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

Abstract base class for Spectrum-aware PHY layers.


Introspection did not find any typical Config paths.


No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 32 bytes (on a 64-bit architecture).

Definition at line 45 of file spectrum-phy.h.

Constructor & Destructor Documentation

◆ SpectrumPhy() [1/2]

ns3::SpectrumPhy::SpectrumPhy ( )

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

References NS_LOG_FUNCTION.

◆ ~SpectrumPhy()

ns3::SpectrumPhy::~SpectrumPhy ( )
virtual

Definition at line 50 of file spectrum-phy.cc.

References NS_LOG_FUNCTION.

◆ SpectrumPhy() [2/2]

ns3::SpectrumPhy::SpectrumPhy ( SpectrumPhy const &  )
private

Copy constructor.

Defined and unimplemented to avoid misuse

Member Function Documentation

◆ GetDevice()

virtual Ptr<NetDevice> ns3::SpectrumPhy::GetDevice ( ) const
pure virtual

◆ GetMobility()

virtual Ptr<MobilityModel> ns3::SpectrumPhy::GetMobility ( ) const
pure virtual

◆ GetRxAntenna()

virtual Ptr<AntennaModel> ns3::SpectrumPhy::GetRxAntenna ( ) const
pure virtual

◆ GetRxSpectrumModel()

virtual Ptr<const SpectrumModel> ns3::SpectrumPhy::GetRxSpectrumModel ( ) const
pure 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.

Implemented in ns3::LrWpanPhy, ns3::LteSpectrumPhy, ns3::HalfDuplexIdealPhy, ns3::TvSpectrumTransmitter, ns3::RemSpectrumPhy, ns3::WaveformGenerator, ns3::LteSimpleSpectrumPhy, ns3::SpectrumAnalyzer, and ns3::WifiSpectrumPhyInterface.

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 36 of file spectrum-phy.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ operator=()

SpectrumPhy& ns3::SpectrumPhy::operator= ( SpectrumPhy const &  )
private

Copy constructor.

Defined and unimplemented to avoid misuse

Returns

◆ SetChannel()

virtual void ns3::SpectrumPhy::SetChannel ( Ptr< SpectrumChannel c)
pure virtual

◆ SetDevice()

virtual void ns3::SpectrumPhy::SetDevice ( Ptr< NetDevice d)
pure virtual

◆ SetMobility()

virtual void ns3::SpectrumPhy::SetMobility ( Ptr< MobilityModel m)
pure virtual

◆ StartRx()

virtual void ns3::SpectrumPhy::StartRx ( Ptr< SpectrumSignalParameters params)
pure virtual

Notify the SpectrumPhy instance of an incoming signal.

Parameters
paramsthe parameters of the signals being received

Implemented in ns3::LrWpanPhy, ns3::LteSpectrumPhy, ns3::HalfDuplexIdealPhy, ns3::TvSpectrumTransmitter, ns3::RemSpectrumPhy, ns3::WaveformGenerator, ns3::LteSimpleSpectrumPhy, ns3::SpectrumAnalyzer, and ns3::WifiSpectrumPhyInterface.

Referenced by ns3::SingleModelSpectrumChannel::StartRx(), and ns3::MultiModelSpectrumChannel::StartRx().

+ Here is the caller graph for this function:

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