A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ns3::SpectrumPropagationLossModel Class Referenceabstract

spectrum-aware propagation loss model More...

#include <spectrum-propagation-loss-model.h>

+ Inheritance diagram for ns3::SpectrumPropagationLossModel:

Public Member Functions

Ptr< SpectrumValueCalcRxPowerSpectralDensity (Ptr< const SpectrumValue > txPsd, Ptr< const MobilityModel > a, Ptr< const MobilityModel > b) const
 
void SetNext (Ptr< SpectrumPropagationLossModel > next)
 
- 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 ()
 
- 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)
 

Protected Member Functions

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

Private Member Functions

virtual Ptr< SpectrumValueDoCalcRxPowerSpectralDensity (Ptr< const SpectrumValue > txPsd, Ptr< const MobilityModel > a, Ptr< const MobilityModel > b) const =0
 

Private Attributes

Ptr< SpectrumPropagationLossModelm_next
 

Detailed Description

spectrum-aware propagation loss model

Interface for propagation loss models to be adopted when transmissions are modeled with a power spectral density by means of the SpectrumValue class.

Doxygen introspection did not find any typical Config paths.
No Attributes are defined for this type.
No TraceSources are defined for this type.

Definition at line 44 of file spectrum-propagation-loss-model.h.

Member Function Documentation

Ptr< SpectrumValue > ns3::SpectrumPropagationLossModel::CalcRxPowerSpectralDensity ( Ptr< const SpectrumValue txPsd,
Ptr< const MobilityModel a,
Ptr< const MobilityModel b 
) const

This method is to be called to calculate

Parameters
txPsdthe SpectrumValue representing the power spectral density of the transmission. Watt units are to be used for radio communications, and Pascal units for acoustic communications (e.g. underwater).
asender mobility
breceiver mobility
Returns
set of values vs frequency representing the received power in the same units used for the txPower parameter.

Definition at line 63 of file spectrum-propagation-loss-model.cc.

References DoCalcRxPowerSpectralDensity().

virtual Ptr<SpectrumValue> ns3::SpectrumPropagationLossModel::DoCalcRxPowerSpectralDensity ( Ptr< const SpectrumValue txPsd,
Ptr< const MobilityModel a,
Ptr< const MobilityModel b 
) const
privatepure virtual
Parameters
txPsdset of values vs frequency representing the transmission power. See SpectrumChannel for details.
asender mobility
breceiver mobility
Returns
set of values vs frequency representing the received power in the same units used for the txPower parameter.

Implemented in ns3::TraceFadingLossModel, ns3::FriisSpectrumPropagationLossModel, and ns3::ConstantSpectrumPropagationLossModel.

Referenced by CalcRxPowerSpectralDensity().

void ns3::SpectrumPropagationLossModel::DoDispose ( void  )
protectedvirtual

This method is called by Object::Dispose or by the object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overriden version of this method and chain up to their parent's implementation once they are done. i.e., for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose method.

It is safe to call GetObject from within this method.

Reimplemented from ns3::Object.

Definition at line 41 of file spectrum-propagation-loss-model.cc.

void ns3::SpectrumPropagationLossModel::SetNext ( Ptr< SpectrumPropagationLossModel next)

used to chain various instances of SpectrumPropagationLossModel

Parameters
next

Definition at line 56 of file spectrum-propagation-loss-model.cc.


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