A Discrete-Event Network Simulator
API
ns3::FixedRssLossModel Class Reference

Return a constant received power level independent of the transmit power. More...

#include "propagation-loss-model.h"

+ Inheritance diagram for ns3::FixedRssLossModel:
+ Collaboration diagram for ns3::FixedRssLossModel:

Public Member Functions

 FixedRssLossModel ()
 
virtual ~FixedRssLossModel ()
 
void SetRss (double rss)
 
- Public Member Functions inherited from ns3::PropagationLossModel
 PropagationLossModel ()
 
virtual ~PropagationLossModel ()
 
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'. More...
 
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. More...
 
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
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default 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 operator. 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
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::PropagationLossModel
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::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Member Functions

 FixedRssLossModel (const FixedRssLossModel &)
 Copy constructor. More...
 
int64_t DoAssignStreams (int64_t stream) override
 Subclasses must implement this; those not using random variables can return zero. More...
 
double DoCalcRxPower (double txPowerDbm, Ptr< MobilityModel > a, Ptr< MobilityModel > b) const override
 Returns the Rx Power taking into account only the particular PropagationLossModel. More...
 
FixedRssLossModeloperator= (const FixedRssLossModel &)
 Copy constructor. More...
 

Private Attributes

double m_rss
 the received signal strength More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose (void)
 Destructor implementation. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

Return a constant received power level independent of the transmit power.

The received power is constant independent of the transmit power. The user must set received power level through the Rss attribute or public SetRss() method. Note that if this loss model is chained to other loss models via SetNext() method, it can only be the first loss model in such a chain, or else it will disregard the losses computed by loss models that precede it in the chain.

Config Paths

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

  • "/NodeList/[i]/DeviceList/[i]/$ns3::LrWpanNetDevice/Channel/PropagationLossModel/$ns3::FixedRssLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::FixedRssLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::FixedRssLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::FixedRssLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::FixedRssLossModel"
  • "/ChannelList/[i]/$ns3::SpectrumChannel/PropagationLossModel/$ns3::FixedRssLossModel"
  • "/ChannelList/[i]/$ns3::YansWifiChannel/PropagationLossModel/$ns3::FixedRssLossModel"

Attributes

  • Rss: The fixed receiver Rss.
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: -150
    • Flags: construct write read

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

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

Constructor & Destructor Documentation

◆ FixedRssLossModel() [1/2]

ns3::FixedRssLossModel::FixedRssLossModel ( )

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

◆ ~FixedRssLossModel()

ns3::FixedRssLossModel::~FixedRssLossModel ( )
virtual

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

◆ FixedRssLossModel() [2/2]

ns3::FixedRssLossModel::FixedRssLossModel ( const FixedRssLossModel )
private

Copy constructor.

Defined and unimplemented to avoid misuse

Member Function Documentation

◆ DoAssignStreams()

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

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

Parameters
streamthe stream index offset start
Returns
the number of stream indices assigned by this model

Implements ns3::PropagationLossModel.

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

◆ DoCalcRxPower()

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

Returns the Rx Power taking into account only the particular 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 794 of file propagation-loss-model.cc.

References m_rss.

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

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

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

+ Here is the call graph for this function:

◆ operator=()

FixedRssLossModel& ns3::FixedRssLossModel::operator= ( const FixedRssLossModel )
private

Copy constructor.

Defined and unimplemented to avoid misuse

Returns

◆ SetRss()

void ns3::FixedRssLossModel::SetRss ( double  rss)
Parameters
rss(dBm) the received signal strength

Set the received signal strength (RSS) in dBm.

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

References m_rss.

Referenced by ChangeSignalAndReportRate(), and LrWpanEdTestCase::DoRun().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_rss

double ns3::FixedRssLossModel::m_rss
private

the received signal strength

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

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


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