A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros 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:
+ Collaboration diagram for ns3::MatrixPropagationLossModel:

Public Member Functions

 MatrixPropagationLossModel ()
virtual ~MatrixPropagationLossModel ()
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).
- Public Member Functions inherited from ns3::PropagationLossModel
 PropagationLossModel ()
virtual ~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.
void SetNext (Ptr< PropagationLossModel > next)
 Enables a chain of loss models to act on the signal.
- Public Member Functions inherited from ns3::Object
 Object ()
virtual ~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 Start (void)
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 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
virtual ~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)
 This method returns the TypeId associated to ns3::MatrixPropagationLossModel.

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 DoStart (void)
virtual void NotifyNewAggregate (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.

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

Member Typedef Documentation

Constructor & Destructor Documentation

ns3::MatrixPropagationLossModel::MatrixPropagationLossModel ( )

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

ns3::MatrixPropagationLossModel::~MatrixPropagationLossModel ( )
virtual

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

Member Function Documentation

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

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

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

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

References m_default, and m_loss.

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

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

This object is accessible through the following paths with Config::Set and Config::Connect:

  • /NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::MatrixPropagationLossModel

Attributes defined for this type:

  • 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 defined for this type.

Reimplemented from ns3::PropagationLossModel.

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

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

+ Here is the call graph for this function:

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

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

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

References m_default.

Referenced by MatrixPropagationLossModelTestCase::DoRun().

+ Here is the caller graph for this function:

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(), and main().

+ Here is the caller graph for this function:

Member Data Documentation

double ns3::MatrixPropagationLossModel::m_default
private

default loss

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

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

std::map<MobilityPair, double> ns3::MatrixPropagationLossModel::m_loss
private

Fixed loss between pair of nodes.

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

Referenced by DoCalcRxPower(), and SetLoss().


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