A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Static Public Member Functions | List of all members
ns3::SpectrumChannel Class Referenceabstract
Spectrum Models

#include <spectrum-channel.h>

+ Inheritance diagram for ns3::SpectrumChannel:

Public Member Functions

virtual void AddPropagationLossModel (Ptr< PropagationLossModel > loss)=0
 
virtual void AddRx (Ptr< SpectrumPhy > phy)=0
 add a SpectrumPhy to a channel, so it can receive packets More...
 
virtual void AddSpectrumPropagationLossModel (Ptr< SpectrumPropagationLossModel > loss)=0
 
virtual void SetPropagationDelayModel (Ptr< PropagationDelayModel > delay)=0
 
virtual void StartTx (Ptr< SpectrumSignalParameters > params)=0
 
- Public Member Functions inherited from ns3::Channel
virtual Ptr< NetDevice > GetDevice (uint32_t i) const =0
 
uint32_t GetId (void) const
 
virtual uint32_t GetNDevices (void) const =0
 
- Public Member Functions inherited from ns3::Object
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 
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)
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount (const SimpleRefCount &o)
 
uint32_t GetReferenceCount (void) const
 
SimpleRefCount & operator= (const SimpleRefCount &o)
 
void Ref (void) const
 
void Unref (void) const
 
- Public Member Functions inherited from ns3::ObjectBase
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::Channel
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoDispose (void)
 
virtual void DoInitialize (void)
 
virtual void NotifyNewAggregate (void)
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 

Detailed Description

Defines the interface for spectrum-aware channel implementations

Config Paths

ns3::SpectrumChannel is accessible through the following paths with Config::Set and Config::Connect:

  • /ChannelList/[i]/$ns3::SpectrumChannel

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

Definition at line 46 of file spectrum-channel.h.

Member Function Documentation

virtual void ns3::SpectrumChannel::AddPropagationLossModel ( Ptr< PropagationLossModel >  loss)
pure virtual

set the single-frequency propagation loss model to be used

Warning
only models that do not depend on the TX power should be used.
Parameters
lossa pointer to the propagation loss model to be used.

Implemented in ns3::MultiModelSpectrumChannel, and ns3::SingleModelSpectrumChannel.

Referenced by ns3::LteHelper::DoInitialize().

virtual void ns3::SpectrumChannel::AddRx ( Ptr< SpectrumPhy >  phy)
pure virtual

add a SpectrumPhy to a channel, so it can receive packets

This method is used to attach a SpectrumPhy instance to a SpectrumChannel instance, so that the SpectrumPhy can receive packets sent on that channel. Note that a SpectrumPhy that only transmits (without receiveing ever) does not need to be added to the channel.

This method is to be implemented by all classes inheriting from SpectrumChannel.

Parameters
phythe SpectrumPhy instance to be added to the channel as a receiver.

Implemented in ns3::MultiModelSpectrumChannel, and ns3::SingleModelSpectrumChannel.

virtual void ns3::SpectrumChannel::AddSpectrumPropagationLossModel ( Ptr< SpectrumPropagationLossModel >  loss)
pure virtual

set the frequency-dependent propagation loss model to be used

Parameters
lossa pointer to the propagation loss model to be used.

Implemented in ns3::MultiModelSpectrumChannel, and ns3::SingleModelSpectrumChannel.

Referenced by ns3::LteHelper::DoInitialize().

virtual void ns3::SpectrumChannel::SetPropagationDelayModel ( Ptr< PropagationDelayModel >  delay)
pure virtual

set the propagation delay model to be used

Parameters
delayPtr to the propagation delay model to be used.

Implemented in ns3::MultiModelSpectrumChannel, and ns3::SingleModelSpectrumChannel.

virtual void ns3::SpectrumChannel::StartTx ( Ptr< SpectrumSignalParameters >  params)
pure virtual

Used by attached PHY instances to transmit signals on the channel

Parameters
paramsthe parameters of the signals being transmitted

Implemented in ns3::MultiModelSpectrumChannel, and ns3::SingleModelSpectrumChannel.

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