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

A Constant (fixed) propagation loss. More...

#include "constant-spectrum-propagation-loss.h"

+ Inheritance diagram for ns3::ConstantSpectrumPropagationLossModel:
+ Collaboration diagram for ns3::ConstantSpectrumPropagationLossModel:

Public Member Functions

 ConstantSpectrumPropagationLossModel ()
 
 ~ConstantSpectrumPropagationLossModel () override
 
Ptr< SpectrumValueDoCalcRxPowerSpectralDensity (Ptr< const SpectrumSignalParameters > params, Ptr< const MobilityModel > a, Ptr< const MobilityModel > b) const override
 
double GetLossDb () const
 Get the propagation loss.
 
void SetLossDb (double lossDb)
 Set the propagation loss.
 
- Public Member Functions inherited from ns3::SpectrumPropagationLossModel
 SpectrumPropagationLossModel ()
 
 ~SpectrumPropagationLossModel () 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'.
 
Ptr< SpectrumValueCalcRxPowerSpectralDensity (Ptr< const SpectrumSignalParameters > params, Ptr< const MobilityModel > a, Ptr< const MobilityModel > b) const
 This method is to be called to calculate.
 
Ptr< SpectrumPropagationLossModelGetNext () const
 Return the pointer to the next SpectrumPropagationLossModel, if any.
 
void SetNext (Ptr< SpectrumPropagationLossModel > next)
 Used to chain various instances of SpectrumPropagationLossModel.
 
- 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, 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::SpectrumPropagationLossModel
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

int64_t DoAssignStreams (int64_t stream) override
 Assign a fixed random variable stream number to the random variables used by this model.
 
- Protected Member Functions inherited from ns3::SpectrumPropagationLossModel
void DoDispose () override
 Destructor implementation.
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object.
 
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.
 

Protected Attributes

double m_lossDb
 Propagation loss [dB].
 
double m_lossLinear
 Propagation loss (linear)
 

Additional Inherited Members

Detailed Description

A Constant (fixed) propagation loss.

The loss is not dependent on the distance.

Definition at line 22 of file constant-spectrum-propagation-loss.h.

Constructor & Destructor Documentation

◆ ConstantSpectrumPropagationLossModel()

ns3::ConstantSpectrumPropagationLossModel::ConstantSpectrumPropagationLossModel ( )

Definition at line 25 of file constant-spectrum-propagation-loss.cc.

References NS_LOG_FUNCTION.

◆ ~ConstantSpectrumPropagationLossModel()

ns3::ConstantSpectrumPropagationLossModel::~ConstantSpectrumPropagationLossModel ( )
override

Definition at line 30 of file constant-spectrum-propagation-loss.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoAssignStreams()

int64_t ns3::ConstantSpectrumPropagationLossModel::DoAssignStreams ( int64_t stream)
overrideprotectedvirtual

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::SpectrumPropagationLossModel.

Definition at line 92 of file constant-spectrum-propagation-loss.cc.

◆ DoCalcRxPowerSpectralDensity()

Ptr< SpectrumValue > ns3::ConstantSpectrumPropagationLossModel::DoCalcRxPowerSpectralDensity ( Ptr< const SpectrumSignalParameters > params,
Ptr< const MobilityModel > a,
Ptr< const MobilityModel > b ) const
overridevirtual
Parameters
paramsthe spectrum signal parameters.
asender mobility
breceiver mobility
Returns
set of values Vs frequency representing the received power in the same units used for the txPower parameter.

Implements ns3::SpectrumPropagationLossModel.

Definition at line 68 of file constant-spectrum-propagation-loss.cc.

References ns3::Copy(), m_lossLinear, NS_ASSERT, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

+ Here is the call graph for this function:

◆ GetLossDb()

double ns3::ConstantSpectrumPropagationLossModel::GetLossDb ( ) const

Get the propagation loss.

Returns
the propagation loss [dB]

Definition at line 61 of file constant-spectrum-propagation-loss.cc.

References m_lossDb, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::ConstantSpectrumPropagationLossModel::GetTypeId ( )
static

Get the type ID.

Returns
the object TypeId

Definition at line 36 of file constant-spectrum-propagation-loss.cc.

References GetLossDb(), ns3::MakeDoubleAccessor(), ns3::MakeDoubleChecker(), SetLossDb(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ SetLossDb()

void ns3::ConstantSpectrumPropagationLossModel::SetLossDb ( double lossDb)

Set the propagation loss.

Parameters
lossDbthe propagation loss [dB]

Definition at line 53 of file constant-spectrum-propagation-loss.cc.

References m_lossDb, m_lossLinear, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_lossDb

double ns3::ConstantSpectrumPropagationLossModel::m_lossDb
protected

Propagation loss [dB].

Definition at line 50 of file constant-spectrum-propagation-loss.h.

Referenced by GetLossDb(), and SetLossDb().

◆ m_lossLinear

double ns3::ConstantSpectrumPropagationLossModel::m_lossLinear
protected

Propagation loss (linear)

Definition at line 51 of file constant-spectrum-propagation-loss.h.

Referenced by DoCalcRxPowerSpectralDensity(), and SetLossDb().


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