A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
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:

Public Member Functions

void SetDefaultLoss (double)
 Set default 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). More...
 
- Public Member Functions inherited from ns3::PropagationLossModel
int64_t AssignStreams (int64_t stream)
 
double CalcRxPower (double txPowerDbm, Ptr< MobilityModel > a, Ptr< MobilityModel > b) const
 
Ptr< PropagationLossModelGetNext ()
 Gets the next PropagationLossModel in the chain of loss models that act on the signal. More...
 
void SetNext (Ptr< PropagationLossModel > next)
 Enables a chain of loss models to act on the signal. More...
 
- 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
 
SimpleRefCountoperator= (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::PropagationLossModel
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)
 

Private Types

typedef std::pair< Ptr
< MobilityModel >, Ptr
< MobilityModel > > 
MobilityPair
 

Private Member Functions

virtual int64_t DoAssignStreams (int64_t stream)
 
virtual double DoCalcRxPower (double txPowerDbm, Ptr< MobilityModel > a, Ptr< MobilityModel > b) const
 

Private Attributes

double m_default
 default loss
 
std::map< MobilityPair, double > m_loss
 Fixed loss between pair of nodes.
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoDispose (void)
 
virtual void DoInitialize (void)
 
virtual void NotifyNewAggregate (void)
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 

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:

  • /ChannelList/[i]/$ns3::WifiChannel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::MatrixPropagationLossModel
  • /ChannelList/[i]/$ns3::YansWifiChannel/PropagationLossModel/$ns3::MatrixPropagationLossModel
  • /NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$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: construct write read

No TraceSources are defined for this type.

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

Member Function Documentation

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

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

Implements ns3::PropagationLossModel.

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

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 833 of file propagation-loss-model.cc.

References m_loss, and NS_ASSERT.

Referenced by MatrixPropagationLossModelTestCase::DoRun().


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