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

#include "multi-model-spectrum-channel.h"

Inheritance diagram for ns3::MultiModelSpectrumChannel:

Collaboration diagram for ns3::MultiModelSpectrumChannel:

Public Types
typedef void(*	SignalParametersTracedCallback) (Ptr< SpectrumSignalParameters > params)
	TracedCallback signature for Ptr<const SpectrumSignalParameters>. More...

Public Types inherited from ns3::SpectrumChannel
typedef void(*	LossTracedCallback) (Ptr< SpectrumPhy > txPhy, Ptr< SpectrumPhy > rxPhy, double lossDb)
	TracedCallback signature for path loss calculation events. More...

Public Member Functions
	MultiModelSpectrumChannel ()

virtual void	AddPropagationLossModel (Ptr< PropagationLossModel > loss)
	Add the single-frequency propagation loss model to be used. More...

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

virtual void	AddSpectrumPropagationLossModel (Ptr< SpectrumPropagationLossModel > loss)
	Add the frequency-dependent propagation loss model to be used. More...

virtual Ptr< NetDevice >	GetDevice (uint32_t i) const

virtual uint32_t	GetNDevices (void) const

virtual Ptr< SpectrumPropagationLossModel >	GetSpectrumPropagationLossModel (void)
	Get the frequency-dependent propagation loss model. More...

virtual void	SetPropagationDelayModel (Ptr< PropagationDelayModel > delay)
	Set the propagation delay model to be used. More...

virtual void	StartTx (Ptr< SpectrumSignalParameters > params)
	Used by attached PHY instances to transmit signals on the channel. More...

Public Member Functions inherited from ns3::SpectrumChannel
virtual	~SpectrumChannel ()

Public Member Functions inherited from ns3::Channel
	Channel ()

virtual	~Channel ()

uint32_t	GetId (void) const

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...

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...

SimpleRefCount &	operator= (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::SpectrumChannel
static TypeId	GetTypeId (void)
	Get the type ID. More...

Static Public Member Functions inherited from ns3::Channel
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...

Protected Member Functions
void	DoDispose ()
	Destructor implementation. More...

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

Private Member Functions
TxSpectrumModelInfoMap_t::const_iterator	FindAndEventuallyAddTxSpectrumModel (Ptr< const SpectrumModel > txSpectrumModel)
	This method checks if m_rxSpectrumModelInfoMap contains an entry for the given TX SpectrumModel. More...

virtual void	StartRx (Ptr< SpectrumSignalParameters > params, Ptr< SpectrumPhy > receiver)
	Used internally to reschedule transmission after the propagation delay. More...

Private Attributes
double	m_maxLossDb
	Maximum loss [dB]. More...

uint32_t	m_numDevices
	Number of devices connected to the channel. More...

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

Ptr< PropagationDelayModel >	m_propagationDelay
	Propagation delay model to be used with this channel. More...

Ptr< PropagationLossModel >	m_propagationLoss
	Single-frequency propagation loss model to be used with this channel. More...

RxSpectrumModelInfoMap_t	m_rxSpectrumModelInfoMap
	Data structure holding, for each RX spectrum model, all the corresponding SpectrumPhy instances. More...

Ptr< SpectrumPropagationLossModel >	m_spectrumPropagationLoss
	Frequency-dependent propagation loss model to be used with this channel. More...

TracedCallback< Ptr< SpectrumSignalParameters > >	m_txSigParamsTrace
	Traced callback for SpectrumSignalParameters in StartTx requests. More...

TxSpectrumModelInfoMap_t	m_txSpectrumModelInfoMap
	Data structure holding, for each TX SpectrumModel, all the converters to any RX SpectrumModel, and all the corresponding SpectrumPhy instances. More...

Additional Inherited Members
Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

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:

"/NodeList/[i]/DeviceList/[i]/$ns3::LrWpanNetDevice/Channel/$ns3::MultiModelSpectrumChannel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::SpectrumChannel/$ns3::MultiModelSpectrumChannel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::MultiModelSpectrumChannel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/Channel/$ns3::SpectrumChannel/$ns3::MultiModelSpectrumChannel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/Channel/$ns3::MultiModelSpectrumChannel"
"/ChannelList/[i]/$ns3::SpectrumChannel/$ns3::MultiModelSpectrumChannel"
"/ChannelList/[i]/$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.
Callback signature: ns3::SpectrumChannel::LossTracedCallback
TxSigParams: This trace is fired whenever a signal is transmitted. The sole parameter is a pointer to a copy of the SpectrumSignalParameters provided by the transmitter.
Callback signature: ns3::MultiModelSpectrumChannel::SignalParametersTracedCallback

Size of this type is 200 bytes (on a 64-bit architecture).

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

Member Typedef Documentation

typedef void(* ns3::MultiModelSpectrumChannel::SignalParametersTracedCallback) (Ptr< SpectrumSignalParameters > params)

TracedCallback signature for Ptr<const SpectrumSignalParameters>.

Parameters

[in] params SpectrumSignalParameters instance.

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

Constructor & Destructor Documentation

ns3::MultiModelSpectrumChannel::MultiModelSpectrumChannel ( )

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

References NS_LOG_FUNCTION.

Member Function Documentation

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

virtual

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

References m_propagationLoss, NS_LOG_FUNCTION, and ns3::PropagationLossModel::SetNext().

Referenced by Bug2483TestCase::DoRun().

Here is the call graph for this function:

Here is the caller graph for this 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 150 of file multi-model-spectrum-channel.cc.

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

Here is the call graph for this function:

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

virtual

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

References m_spectrumPropagationLoss, and NS_LOG_FUNCTION.

void ns3::MultiModelSpectrumChannel::DoDispose ( void )

protectedvirtual

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 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 90 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.

Here is the call graph for this 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