A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::MatrixPropagationLossModel Class Reference

The propagation loss is fixed for each pair of nodes and doesn't depend on their actual positions. More...

#include "propagation-loss-model.h"

+ Inheritance diagram for ns3::MatrixPropagationLossModel:
+ Collaboration diagram for ns3::MatrixPropagationLossModel:

Classes

class  MobilityPairHasher
 Hasher for a pair of mobility models. More...
 

Public Member Functions

 MatrixPropagationLossModel ()
 
 MatrixPropagationLossModel (const MatrixPropagationLossModel &)=delete
 
 ~MatrixPropagationLossModel () override
 
MatrixPropagationLossModeloperator= (const MatrixPropagationLossModel &)=delete
 
void SetDefaultLoss (double defaultLoss)
 Set the default propagation loss (in dB, positive) to be used, infinity if not set.
 
void SetLoss (Ptr< MobilityModel > a, Ptr< MobilityModel > b, double loss, bool symmetric=true)
 Set loss (in dB, positive) between pair of ns-3 objects (typically, nodes).
 
- Public Member Functions inherited from ns3::PropagationLossModel
 PropagationLossModel ()
 
 PropagationLossModel (const PropagationLossModel &)=delete
 
 ~PropagationLossModel () override
 
int64_t AssignStreams (int64_t stream)
 If this loss model uses objects of type RandomVariableStream, set the stream numbers to the integers starting with the offset 'stream'.
 
double CalcRxPower (double txPowerDbm, Ptr< MobilityModel > a, Ptr< MobilityModel > b) const
 Returns the Rx Power taking into account all the PropagationLossModel(s) chained to the current one.
 
Ptr< PropagationLossModelGetNext ()
 Gets the next PropagationLossModel in the chain of loss models that act on the signal.
 
PropagationLossModeloperator= (const PropagationLossModel &)=delete
 
void SetNext (Ptr< PropagationLossModel > next)
 Enables a chain of loss models to act on the signal.
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor.
 
 ~Object () override
 Destructor.
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together.
 
void Dispose ()
 Dispose of this Object.
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one.
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object.
 
template<typename T >
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object.
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object.
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId.
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object.
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one.
 
bool IsInitialized () const
 Check if the object has been initialized.
 
void UnidirectionalAggregateObject (Ptr< Object > other)
 Aggregate an Object to another Object.
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor.
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor.
 
uint32_t GetReferenceCount () const
 Get the reference count of the object.
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator.
 
void Ref () const
 Increment the reference count.
 
void Unref () const
 Decrement the reference count.
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor.
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful.
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising errors.
 
virtual TypeId GetInstanceTypeId () const =0
 Get the most derived TypeId for this Object.
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful.
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors.
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context.
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context.
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context.
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context.
 

Static Public Member Functions

static TypeId GetTypeId ()
 Get the type ID.
 
- Static Public Member Functions inherited from ns3::PropagationLossModel
static TypeId GetTypeId ()
 Get the type ID.
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId ()
 Register this type.
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID.
 

Private Types

typedef std::pair< const Ptr< MobilityModel >, const Ptr< MobilityModel > > MobilityPair
 Typedef: Mobility models pair.
 

Private Member Functions

int64_t DoAssignStreams (int64_t stream) override
 Assign a fixed random variable stream number to the random variables used by this model.
 
double DoCalcRxPower (double txPowerDbm, Ptr< MobilityModel > a, Ptr< MobilityModel > b) const override
 PropagationLossModel.
 

Private Attributes

double m_default
 default loss
 
std::unordered_map< MobilityPair, double, MobilityPairHasherm_loss
 Propagation loss between pair of nodes.
 

Additional Inherited Members

virtual int64_t DoAssignStreams (int64_t stream)=0
 Assign a fixed random variable stream number to the random variables used by this model.
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object.
 
virtual void DoDispose ()
 Destructor implementation.
 
virtual void DoInitialize ()
 Initialize() implementation.
 
virtual void NotifyNewAggregate ()
 Notify all Objects aggregated to this one of a new Object being aggregated.
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes.
 
virtual void NotifyConstructionCompleted ()
 Notifier called once the ObjectBase is fully constructed.
 

Detailed Description

The propagation loss is fixed for each pair of nodes and doesn't depend on their actual positions.

This is supposed to be used by synthetic tests. Note that by default propagation loss is assumed to be symmetric.

Config Paths

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

  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::MatrixPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::MatrixPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phy/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::MatrixPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phy/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::MatrixPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phys/[i]/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::MatrixPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phys/[i]/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::MatrixPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::LrWpanNetDevice/Channel/PropagationLossModel/$ns3::MatrixPropagationLossModel"
  • "/ChannelList/[i]/$ns3::SpectrumChannel/PropagationLossModel/$ns3::MatrixPropagationLossModel"
  • "/ChannelList/[i]/$ns3::YansWifiChannel/PropagationLossModel/$ns3::MatrixPropagationLossModel"

Attributes

  • DefaultLoss: The default value for propagation loss, dB.
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 1.79769e+308
    • Flags: constructwriteread

No TraceSources are defined for this type.
Size of this type is 128 bytes (on a 64-bit architecture).

Definition at line 702 of file propagation-loss-model.h.

Member Typedef Documentation

◆ MobilityPair

Typedef: Mobility models pair.

Definition at line 745 of file propagation-loss-model.h.

Constructor & Destructor Documentation

◆ MatrixPropagationLossModel() [1/2]

ns3::MatrixPropagationLossModel::MatrixPropagationLossModel ( )

Definition at line 849 of file propagation-loss-model.cc.

◆ ~MatrixPropagationLossModel()

ns3::MatrixPropagationLossModel::~MatrixPropagationLossModel ( )
override

Definition at line 855 of file propagation-loss-model.cc.

◆ MatrixPropagationLossModel() [2/2]

ns3::MatrixPropagationLossModel::MatrixPropagationLossModel ( const MatrixPropagationLossModel )
delete

Member Function Documentation

◆ DoAssignStreams()

int64_t ns3::MatrixPropagationLossModel::DoAssignStreams ( int64_t  stream)
overrideprivatevirtual

Assign a fixed random variable stream number to the random variables used by this model.

Subclasses must implement this; those not using random variables can return zero.

Parameters
streamfirst stream index to use
Returns
the number of stream indices assigned by this model

Implements ns3::PropagationLossModel.

Definition at line 909 of file propagation-loss-model.cc.

◆ DoCalcRxPower()

double ns3::MatrixPropagationLossModel::DoCalcRxPower ( double  txPowerDbm,
Ptr< MobilityModel a,
Ptr< MobilityModel b 
) const
overrideprivatevirtual

PropagationLossModel.

Parameters
txPowerDbmcurrent transmission power (in dBm)
athe mobility model of the source
bthe mobility model of the destination
Returns
the reception power after adding/multiplying propagation loss (in dBm)

Implements ns3::PropagationLossModel.

Definition at line 892 of file propagation-loss-model.cc.

References m_default, and m_loss.

◆ GetTypeId()

TypeId ns3::MatrixPropagationLossModel::GetTypeId ( )
static

Get the type ID.

Returns
the object TypeId

Definition at line 834 of file propagation-loss-model.cc.

References m_default, ns3::MakeDoubleAccessor(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ operator=()

MatrixPropagationLossModel & ns3::MatrixPropagationLossModel::operator= ( const MatrixPropagationLossModel )
delete

◆ SetDefaultLoss()

void ns3::MatrixPropagationLossModel::SetDefaultLoss ( double  defaultLoss)

Set the default propagation loss (in dB, positive) to be used, infinity if not set.

Parameters
defaultLossthe default proagation loss

Definition at line 860 of file propagation-loss-model.cc.

References m_default.

Referenced by MatrixPropagationLossModelTestCase::DoRun().

+ Here is the caller graph for this function:

◆ SetLoss()

void ns3::MatrixPropagationLossModel::SetLoss ( Ptr< MobilityModel a,
Ptr< MobilityModel b,
double  loss,
bool  symmetric = true 
)

Set loss (in dB, positive) between pair of ns-3 objects (typically, nodes).

Parameters
ama Source mobility model
bmb Destination mobility model
lossa -> b path loss, positive in dB
symmetricIf true (default), both a->b and b->a paths will be affected

Definition at line 866 of file propagation-loss-model.cc.

References m_loss, NS_ASSERT, and SetLoss().

Referenced by MatrixPropagationLossModelTestCase::DoRun(), and SetLoss().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ m_default

double ns3::MatrixPropagationLossModel::m_default
private

default loss

Definition at line 742 of file propagation-loss-model.h.

Referenced by DoCalcRxPower(), GetTypeId(), and SetDefaultLoss().

◆ m_loss

std::unordered_map<MobilityPair, double, MobilityPairHasher> ns3::MatrixPropagationLossModel::m_loss
private

Propagation loss between pair of nodes.

Definition at line 767 of file propagation-loss-model.h.

Referenced by DoCalcRxPower(), and SetLoss().


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