Models the propagation loss through a transmission medium. More...
#include "propagation-loss-model.h"
Public Member Functions | |
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< PropagationLossModel > | GetNext () |
Gets the next PropagationLossModel in the chain of loss models that act on the signal. | |
PropagationLossModel & | operator= (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< Object > | GetObject () 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< Object > | GetObject (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. | |
SimpleRefCount & | operator= (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, bool permissive=false) 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. | |
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::Object | |
static TypeId | GetTypeId () |
Register this type. | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. | |
Protected Member Functions | |
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. | |
Private Member Functions | |
virtual double | DoCalcRxPower (double txPowerDbm, Ptr< MobilityModel > a, Ptr< MobilityModel > b) const =0 |
PropagationLossModel. | |
Private Attributes | |
Ptr< PropagationLossModel > | m_next |
Next propagation loss model in the list. | |
Additional Inherited Members | |
Related Symbols inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
Models the propagation loss through a transmission medium.
Calculate the receive power (dbm) from a transmit power (dbm) and a mobility model for the source and destination positions.
ns3::PropagationLossModel is accessible through the following paths with Config::Set and Config::Connect:
No Attributes are defined for this type.
No TraceSources are defined for this type.
Group: Propagation
Size of this type is 64 bytes (on a 64-bit architecture).
Definition at line 44 of file propagation-loss-model.h.
ns3::PropagationLossModel::PropagationLossModel | ( | ) |
Definition at line 40 of file propagation-loss-model.cc.
|
override |
Definition at line 45 of file propagation-loss-model.cc.
|
delete |
int64_t ns3::PropagationLossModel::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'.
Return the number of streams (possibly zero) that have been assigned. If there are PropagationLossModels chained together, this method will also assign streams to the downstream models.
stream | the stream index offset start |
Definition at line 75 of file propagation-loss-model.cc.
References DoAssignStreams(), and m_next.
double ns3::PropagationLossModel::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.
txPowerDbm | current transmission power (in dBm) |
a | the mobility model of the source |
b | the mobility model of the destination |
Definition at line 62 of file propagation-loss-model.cc.
References DoCalcRxPower(), and m_next.
Referenced by MatrixPropagationLossModelTestCase::DoRun().
|
protectedpure virtual |
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.
stream | first stream index to use |
Implemented in ns3::BuildingsPropagationLossModel, ns3::Cost231PropagationLossModel, ns3::FixedRssLossModel, ns3::FriisPropagationLossModel, ns3::ItuR1238PropagationLossModel, ns3::ItuR1411LosPropagationLossModel, ns3::ItuR1411NlosOverRooftopPropagationLossModel, ns3::JakesPropagationLossModel, ns3::Kun2600MhzPropagationLossModel, ns3::LogDistancePropagationLossModel, ns3::MatrixPropagationLossModel, ns3::NakagamiPropagationLossModel, ns3::OkumuraHataPropagationLossModel, ns3::RandomPropagationLossModel, ns3::RangePropagationLossModel, ns3::ThreeGppPropagationLossModel, ns3::ThreeGppUmaPropagationLossModel, ns3::ThreeGppV2vUrbanPropagationLossModel, ns3::ThreeLogDistancePropagationLossModel, and ns3::TwoRayGroundPropagationLossModel.
Referenced by AssignStreams().
|
privatepure virtual |
txPowerDbm | current transmission power (in dBm) |
a | the mobility model of the source |
b | the mobility model of the destination |
Implemented in ns3::BuildingsPropagationLossModel, ns3::Cost231PropagationLossModel, ns3::FixedRssLossModel, ns3::FriisPropagationLossModel, ns3::ItuR1238PropagationLossModel, ns3::ItuR1411LosPropagationLossModel, ns3::ItuR1411NlosOverRooftopPropagationLossModel, ns3::JakesPropagationLossModel, ns3::Kun2600MhzPropagationLossModel, ns3::LogDistancePropagationLossModel, ns3::MatrixPropagationLossModel, ns3::NakagamiPropagationLossModel, ns3::OkumuraHataPropagationLossModel, ns3::RandomPropagationLossModel, ns3::RangePropagationLossModel, ns3::ThreeGppPropagationLossModel, ns3::ThreeLogDistancePropagationLossModel, and ns3::TwoRayGroundPropagationLossModel.
Referenced by CalcRxPower().
Ptr< PropagationLossModel > ns3::PropagationLossModel::GetNext | ( | ) |
Gets the next PropagationLossModel in the chain of loss models that act on the signal.
This method of chaining propagation loss models only works commutatively if the propagation loss of all models in the chain are independent of transmit power.
Definition at line 56 of file propagation-loss-model.cc.
References m_next.
|
static |
Get the type ID.
Get the type ID.
Definition at line 33 of file propagation-loss-model.cc.
References ns3::TypeId::SetParent().
|
delete |
void ns3::PropagationLossModel::SetNext | ( | Ptr< PropagationLossModel > | next | ) |
Enables a chain of loss models to act on the signal.
next | The next PropagationLossModel to add to the chain |
This method of chaining propagation loss models only works commutatively if the propagation loss of all models in the chain are independent of transmit power.
Definition at line 50 of file propagation-loss-model.cc.
References m_next.
|
private |
Next propagation loss model in the list.
Definition at line 131 of file propagation-loss-model.h.
Referenced by AssignStreams(), CalcRxPower(), GetNext(), and SetNext().