A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::SingleModelSpectrumChannel Class Reference

SpectrumChannel implementation which handles a single spectrum model. More...

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

+ Inheritance diagram for ns3::SingleModelSpectrumChannel:
+ Collaboration diagram for ns3::SingleModelSpectrumChannel:

Public Types

typedef std::vector< Ptr
< SpectrumPhy > > 
PhyList
 

Public Member Functions

 SingleModelSpectrumChannel ()
 
virtual void AddPropagationLossModel (Ptr< PropagationLossModel > loss)
 set 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)
 set the frequency-dependent propagation loss model to be used More...
 
virtual Ptr< NetDeviceGetDevice (uint32_t i) const
 
virtual uint32_t GetNDevices (void) const
 
virtual Ptr
< SpectrumPropagationLossModel
GetSpectrumPropagationLossModel (void)
 
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 ()
 
virtual ~Object ()
 
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 Run the DoDispose methods of this object and all the objects aggregated to it. More...
 
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)
 This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment. 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
 
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)
 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::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 Noop. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Member Functions

virtual void DoDispose ()
 This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...
 
void StartRx (Ptr< SpectrumSignalParameters > params, Ptr< SpectrumPhy > receiver)
 used internally to reschedule transmission after the propagation delay More...
 

Private Attributes

double m_maxLossDb
 
TracedCallback< Ptr
< SpectrumPhy >, Ptr
< SpectrumPhy >, double > 
m_pathLossTrace
 
PhyList m_phyList
 list of SpectrumPhy instances attached to the channel More...
 
Ptr< PropagationDelayModelm_propagationDelay
 propagation delay model to be used with this channel More...
 
Ptr< PropagationLossModelm_propagationLoss
 single-frequency propagation loss model to be used with this channel More...
 
Ptr< const SpectrumModelm_spectrumModel
 SpectrumModel that this channel instance is supporting. More...
 
Ptr< SpectrumPropagationLossModelm_spectrumPropagationLoss
 frequency-dependent propagation loss model to be used with this channel More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoInitialize (void)
 This method is called only once by Object::Initialize. More...
 
virtual void NotifyNewAggregate (void)
 This method is invoked whenever two sets of objects are aggregated together. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 This method is invoked once all member attributes have been initialized. More...
 

Detailed Description

SpectrumChannel implementation which handles a single spectrum model.

All SpectrumPhy layers attached to this SpectrumChannel

Config Paths

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

  • /ChannelList/[i]/$ns3::SingleModelSpectrumChannel
  • /ChannelList/[i]/$ns3::SpectrumChannel/$ns3::SingleModelSpectrumChannel
  • /NodeList/[i]/DeviceList/[i]/$ns3::LrWpanNetDevice/Channel/$ns3::SingleModelSpectrumChannel

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

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 40 of file single-model-spectrum-channel.h.

Member Typedef Documentation

Constructor & Destructor Documentation

ns3::SingleModelSpectrumChannel::SingleModelSpectrumChannel ( )

Definition at line 49 of file single-model-spectrum-channel.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::SingleModelSpectrumChannel::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.

Definition at line 234 of file single-model-spectrum-channel.cc.

References m_propagationLoss, NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by LrWpanCollisionTestCase::DoRun(), LrWpanEdTestCase::DoRun(), LrWpanAckTestCase::DoRun(), LrWpanErrorDistanceTestCase::DoRun(), LrWpanCcaTestCase::DoRun(), and main().

+ Here is the caller graph for this function:

void ns3::SingleModelSpectrumChannel::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.

Definition at line 101 of file single-model-spectrum-channel.cc.

References m_phyList, and NS_LOG_FUNCTION.

void ns3::SingleModelSpectrumChannel::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.

Definition at line 243 of file single-model-spectrum-channel.cc.

References m_spectrumPropagationLoss, NS_ASSERT, and NS_LOG_FUNCTION.

void ns3::SingleModelSpectrumChannel::DoDispose ( void  )
privatevirtual

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 55 of file single-model-spectrum-channel.cc.

References ns3::Object::DoDispose(), m_phyList, m_propagationDelay, m_propagationLoss, m_spectrumModel, m_spectrumPropagationLoss, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

Ptr< NetDevice > ns3::SingleModelSpectrumChannel::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.

Definition at line 226 of file single-model-spectrum-channel.cc.

References m_phyList, and NS_LOG_FUNCTION.

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

This method must be implemented by subclasses.

Implements ns3::Channel.

Definition at line 218 of file single-model-spectrum-channel.cc.

References m_phyList, and NS_LOG_FUNCTION.

Ptr< SpectrumPropagationLossModel > ns3::SingleModelSpectrumChannel::GetSpectrumPropagationLossModel ( void  )
virtual

Definition at line 260 of file single-model-spectrum-channel.cc.

References m_spectrumPropagationLoss, and NS_LOG_FUNCTION.

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

Definition at line 67 of file single-model-spectrum-channel.cc.

References m_maxLossDb, m_pathLossTrace, ns3::MakeTraceSourceAccessor(), NS_LOG_FUNCTION_NOARGS, and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

void ns3::SingleModelSpectrumChannel::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.

Definition at line 251 of file single-model-spectrum-channel.cc.

References m_propagationDelay, NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by LrWpanCollisionTestCase::DoRun(), LrWpanEdTestCase::DoRun(), LrWpanAckTestCase::DoRun(), LrWpanCcaTestCase::DoRun(), and main().

+ Here is the caller graph for this function:

void ns3::SingleModelSpectrumChannel::StartRx ( Ptr< SpectrumSignalParameters params,
Ptr< SpectrumPhy receiver 
)
private

used internally to reschedule transmission after the propagation delay

Parameters
params
receiver

Definition at line 209 of file single-model-spectrum-channel.cc.

References NS_LOG_FUNCTION, and ns3::SpectrumPhy::StartRx().

Referenced by StartTx().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::SingleModelSpectrumChannel::StartTx ( Ptr< SpectrumSignalParameters params)
virtual

Used by attached PHY instances to transmit signals on the channel.

Parameters
paramsthe parameters of the signals being transmitted

Implements ns3::SpectrumChannel.

Definition at line 109 of file single-model-spectrum-channel.cc.

References ns3::PropagationLossModel::CalcRxPower(), ns3::MobilityModel::GetPosition(), m_maxLossDb, m_pathLossTrace, m_phyList, m_propagationDelay, m_propagationLoss, m_spectrumModel, m_spectrumPropagationLoss, NS_ASSERT, NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::Simulator::Schedule(), ns3::Simulator::ScheduleWithContext(), and StartRx().

+ Here is the call graph for this function:

Member Data Documentation

double ns3::SingleModelSpectrumChannel::m_maxLossDb
private

Definition at line 110 of file single-model-spectrum-channel.h.

Referenced by GetTypeId(), and StartTx().

TracedCallback<Ptr<SpectrumPhy>, Ptr<SpectrumPhy>, double > ns3::SingleModelSpectrumChannel::m_pathLossTrace
private

Definition at line 112 of file single-model-spectrum-channel.h.

Referenced by GetTypeId(), and StartTx().

PhyList ns3::SingleModelSpectrumChannel::m_phyList
private

list of SpectrumPhy instances attached to the channel

Definition at line 81 of file single-model-spectrum-channel.h.

Referenced by AddRx(), DoDispose(), GetDevice(), GetNDevices(), and StartTx().

Ptr<PropagationDelayModel> ns3::SingleModelSpectrumChannel::m_propagationDelay
private

propagation delay model to be used with this channel

Definition at line 94 of file single-model-spectrum-channel.h.

Referenced by DoDispose(), SetPropagationDelayModel(), and StartTx().

Ptr<PropagationLossModel> ns3::SingleModelSpectrumChannel::m_propagationLoss
private

single-frequency propagation loss model to be used with this channel

Definition at line 101 of file single-model-spectrum-channel.h.

Referenced by AddPropagationLossModel(), DoDispose(), and StartTx().

Ptr<const SpectrumModel> ns3::SingleModelSpectrumChannel::m_spectrumModel
private

SpectrumModel that this channel instance is supporting.

Definition at line 87 of file single-model-spectrum-channel.h.

Referenced by DoDispose(), and StartTx().

Ptr<SpectrumPropagationLossModel> ns3::SingleModelSpectrumChannel::m_spectrumPropagationLoss
private

frequency-dependent propagation loss model to be used with this channel

Definition at line 107 of file single-model-spectrum-channel.h.

Referenced by AddSpectrumPropagationLossModel(), DoDispose(), GetSpectrumPropagationLossModel(), and StartTx().


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