ns-3
ns3::SpectrumChannel Class Reference

#include <spectrum-channel.h>

Inheritance diagram for ns3::SpectrumChannel:
Collaboration diagram for ns3::SpectrumChannel:

List of all members.

Public Member Functions

virtual void AddPropagationLossModel (Ptr< PropagationLossModel > loss)=0
virtual void AddSpectrumPropagationLossModel (Ptr< SpectrumPropagationLossModel > loss)=0
virtual void SetPropagationDelayModel (Ptr< PropagationDelayModel > delay)=0
virtual void StartTx (Ptr< SpectrumSignalParameters > params)=0
virtual void AddRx (Ptr< SpectrumPhy > phy)=0
 add a SpectrumPhy to a channel, so it can receive packets
- Public Member Functions inherited from ns3::Channel
uint32_t GetId (void) const
virtual uint32_t GetNDevices (void) const =0
virtual Ptr< NetDeviceGetDevice (uint32_t i) const =0
- Public Member Functions inherited from ns3::Object
virtual TypeId GetInstanceTypeId (void) const
template<typename T >
Ptr< T > GetObject (void) const
template<typename T >
Ptr< T > GetObject (TypeId tid) const
void Dispose (void)
void AggregateObject (Ptr< Object > other)
AggregateIterator GetAggregateIterator (void) const
void Start (void)
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount (const SimpleRefCount &o)
SimpleRefCountoperator= (const SimpleRefCount &o)
void Ref (void) const
void Unref (void) const
uint32_t GetReferenceCount (void) const
- Public Member Functions inherited from ns3::ObjectBase
void SetAttribute (std::string name, const AttributeValue &value)
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
void GetAttribute (std::string name, AttributeValue &value) const
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
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)
 This method returns the TypeId associated to ns3::SpectrumChannel.

Detailed Description

Defines the interface for spectrum-aware channel implementations


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::SpectrumChannelHelper::Create(), and ns3::LteHelper::DoStart().

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.

Referenced by ns3::LteHelper::Attach(), ns3::AdhocAlohaNoackIdealPhyHelper::Install(), and ns3::SpectrumAnalyzerHelper::Install().

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::SpectrumChannelHelper::Create(), and ns3::LteHelper::DoStart().

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

This method returns the TypeId associated to ns3::SpectrumChannel.

No Attributes defined for this type.
Attributes defined in parent class ns3::Channel:

No TraceSources defined for this type.

Reimplemented from ns3::Channel.

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

References ns3::TypeId::SetParent().

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.

Referenced by ns3::SpectrumChannelHelper::Create().

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.

Referenced by ns3::HalfDuplexIdealPhy::StartTx(), and ns3::LteSpectrumPhy::StartTx().


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