ns-3
ns3::MultiModelSpectrumChannel Class Reference

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

Inheritance diagram for ns3::MultiModelSpectrumChannel:
Collaboration diagram for ns3::MultiModelSpectrumChannel:

List of all members.

Public Member Functions

virtual void AddPropagationLossModel (Ptr< PropagationLossModel > loss)
virtual void AddSpectrumPropagationLossModel (Ptr< SpectrumPropagationLossModel > loss)
virtual void SetPropagationDelayModel (Ptr< PropagationDelayModel > delay)
virtual void AddRx (Ptr< SpectrumPhy > phy)
 add a SpectrumPhy to a channel, so it can receive packets
virtual void StartTx (Ptr< SpectrumSignalParameters > params)
virtual uint32_t GetNDevices (void) const
virtual Ptr< NetDeviceGetDevice (uint32_t i) const
virtual Ptr
< SpectrumPropagationLossModel
GetSpectrumPropagationLossModel (void)

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::MultiModelSpectrumChannel.

Protected Member Functions

void DoDispose ()

Detailed Description

This SpectrumChannel implementation can handle the presence of SpectrumPhy instances which can use different spectrum models, i.e., different SpectrumModel. The only requirement is that every SpectrumPhy instance uses the same SpectrumModel for the whole simulation.


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:
lossa pointer to the propagation loss model to be used.

Implements ns3::SpectrumChannel.

References 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:
phythe SpectrumPhy instance to be added to the channel as a receiver.

Implements ns3::SpectrumChannel.

References ns3::SpectrumPhy::GetRxSpectrumModel(), ns3::SpectrumModel::GetUid(), 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:
lossa pointer to the propagation loss model to be used.

Implements ns3::SpectrumChannel.

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

References NS_LOG_FUNCTION.

Ptr< NetDevice > ns3::MultiModelSpectrumChannel::GetDevice ( uint32_t  i) const
virtual
Parameters:
iindex of NetDevice to retrieve
Returns:
one of the NetDevices connected to this channel.

This method must be implemented by subclasses.

Implements ns3::Channel.

uint32_t ns3::MultiModelSpectrumChannel::GetNDevices ( void  ) const
virtual
Returns:
the number of NetDevices connected to this Channel.

This method must be implemented by subclasses.

Implements ns3::Channel.

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

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

Attributes defined for this type:

  • 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:

TraceSources defined for this type:

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

Reimplemented from ns3::SpectrumChannel.

References ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().

void ns3::MultiModelSpectrumChannel::SetPropagationDelayModel ( Ptr< PropagationDelayModel delay)
virtual

set the propagation delay model to be used

Parameters:
delayPtr to the propagation delay model to be used.

Implements ns3::SpectrumChannel.

References NS_ASSERT.


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