#include <multi-model-spectrum-channel.h>

Inheritance diagram for ns3::MultiModelSpectrumChannel:

Public Member Functions
virtual void	AddPropagationLossModel (Ptr< PropagationLossModel > loss)

virtual void	AddRx (Ptr< SpectrumPhy > phy)
	add a SpectrumPhy to a channel, so it can receive packets More...

virtual void	AddSpectrumPropagationLossModel (Ptr< SpectrumPropagationLossModel > loss)

virtual Ptr< NetDevice >	GetDevice (uint32_t i) const

virtual uint32_t	GetNDevices (void) const

virtual Ptr < SpectrumPropagationLossModel >	GetSpectrumPropagationLossModel (void)

virtual void	SetPropagationDelayModel (Ptr< PropagationDelayModel > delay)

virtual void	StartTx (Ptr< SpectrumSignalParameters > params)

Public Member Functions inherited from ns3::Channel
uint32_t	GetId (void) const

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::SpectrumChannel
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)

Protected Member Functions
void	DoDispose ()

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)

virtual void	DoInitialize (void)

virtual void	NotifyNewAggregate (void)

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)

Private Member Functions
TxSpectrumModelInfoMap_t::const_iterator	FindAndEventuallyAddTxSpectrumModel (Ptr< const SpectrumModel > txSpectrumModel)

virtual void	StartRx (Ptr< SpectrumSignalParameters > params, Ptr< SpectrumPhy > receiver)

Private Attributes
double	m_maxLossDb

uint32_t	m_numDevices

TracedCallback< Ptr < SpectrumPhy >, Ptr < SpectrumPhy >, double >	m_pathLossTrace

Ptr< PropagationDelayModel >	m_propagationDelay

Ptr< PropagationLossModel >	m_propagationLoss

RxSpectrumModelInfoMap_t	m_rxSpectrumModelInfoMap

Ptr< SpectrumPropagationLossModel >	m_spectrumPropagationLoss

TxSpectrumModelInfoMap_t	m_txSpectrumModelInfoMap

Detailed Description

This SpectrumChannel implementation can handle the presence of SpectrumPhy instances which can use different spectrum models, i.e., different SpectrumModel.

Note: It is allowed for a receiving SpectrumPhy to switch to a different SpectrumModel during the simulation. The requirement for this to work is that, after the SpectrumPhy switched its SpectrumModel, MultiModelSpectrumChannel::AddRx () is called again passing the pointer to that SpectrumPhy.

Config Paths

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

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

Attributes

MaxLossDb: If a single-frequency PropagationLossModel is used, this value represents the maximum loss in dB for which transmissions will be passed to the receiving PHY. Signals for which the PropagationLossModel returns a loss bigger than this value will not be propagated to the receiver. This parameter is to be used to reduce the computational load by not propagating signals that are far beyond the interference range. Note that the default value corresponds to considering all signals for reception. Tune this value with care.
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 1e+09
- Flags: construct write read

Attributes defined in parent class ns3::Channel

Id: The id (unique integer) of this Channel.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Flags: read

TraceSources

PathLoss: This trace is fired whenever a new path loss value is calculated. The first and second parameters to the trace are pointers respectively to the TX and RX SpectrumPhy instances, whereas the third parameters is the loss value in dB. Note that the loss value reported by this trace is the single-frequency loss value obtained by evaluating only the TX and RX AntennaModels and the PropagationLossModel. In particular, note that SpectrumPropagationLossModel (even if present) is never used to evaluate the loss value reported in this trace.

Definition at line 86 of file multi-model-spectrum-channel.h.

Member Function Documentation

void ns3::MultiModelSpectrumChannel::AddPropagationLossModel ( Ptr< PropagationLossModel > loss )

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

loss	a pointer to the propagation loss model to be used.

Implements ns3::SpectrumChannel.

Definition at line 418 of file multi-model-spectrum-channel.cc.

References m_propagationLoss, NS_ASSERT, and NS_LOG_FUNCTION.

void ns3::MultiModelSpectrumChannel::AddRx ( Ptr< SpectrumPhy > phy )

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

phy	the SpectrumPhy instance to be added to the channel as a receiver.

Implements ns3::SpectrumChannel.

Definition at line 132 of file multi-model-spectrum-channel.cc.

References ns3::SpectrumPhy::GetRxSpectrumModel(), m_rxSpectrumModelInfoMap, m_txSpectrumModelInfoMap, NS_ASSERT, NS_ASSERT_MSG, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

void ns3::MultiModelSpectrumChannel::AddSpectrumPropagationLossModel ( Ptr< SpectrumPropagationLossModel > loss )

virtual

set the frequency-dependent propagation loss model to be used

Parameters

loss	a pointer to the propagation loss model to be used.

Implements ns3::SpectrumChannel.

Definition at line 426 of file multi-model-spectrum-channel.cc.

References m_spectrumPropagationLoss, and NS_ASSERT.

void ns3::MultiModelSpectrumChannel::DoDispose ( void )

protectedvirtual

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 86 of file multi-model-spectrum-channel.cc.

References ns3::Object::DoDispose(), m_propagationDelay, m_propagationLoss, m_rxSpectrumModelInfoMap, m_spectrumPropagationLoss, m_txSpectrumModelInfoMap, and NS_LOG_FUNCTION.

TxSpectrumModelInfoMap_t::const_iterator ns3::MultiModelSpectrumChannel::FindAndEventuallyAddTxSpectrumModel ( Ptr< const SpectrumModel > txSpectrumModel )

private

this method checks if m_rxSpectrumModelInfoMap contains an entry for the given TX SpectrumModel. If such entry exists, it returns an interator pointing to it. If not, it creates a new entry in m_txSpectrumMpodelInfoMap, and returns an iterator to it.

Parameters

txSpectrumModel the TX SpectrumModel being considered