A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::JakesPropagationLossModel Class Reference

a jakes narrowband propagation model. More...

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

+ Inheritance diagram for ns3::JakesPropagationLossModel:
+ Collaboration diagram for ns3::JakesPropagationLossModel:

Public Member Functions

 JakesPropagationLossModel ()
 
virtual ~JakesPropagationLossModel ()
 
- 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
 
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 ()
 
virtual ~Object ()
 
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 Run the DoDispose methods of this object and all the objects aggregated to it. More...
 
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)
 This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 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. 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
 
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::PropagationLossModel
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 Noop. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Static Public Attributes

static const double PI = 3.14159265358979323846
 

Private Member Functions

virtual int64_t DoAssignStreams (int64_t stream)
 Subclasses must implement this; those not using random variables can return zero. More...
 
double DoCalcRxPower (double txPowerDbm, Ptr< MobilityModel > a, Ptr< MobilityModel > b) const
 
Ptr< UniformRandomVariableGetUniformRandomVariable () const
 

Private Attributes

PropagationCache< JakesProcessm_propagationCache
 
Ptr< UniformRandomVariablem_uniformVariable
 

Friends

class JakesProcess
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoDispose (void)
 This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...
 
virtual void DoInitialize (void)
 This method is called only once by Object::Initialize. More...
 
virtual void NotifyNewAggregate (void)
 This method is invoked whenever two sets of objects are aggregated together. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 This method is invoked once all member attributes have been initialized. More...
 

Detailed Description

a jakes narrowband propagation model.

Symmetrical cache for JakesProcess

Config Paths

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

  • /ChannelList/[i]/$ns3::WifiChannel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::JakesPropagationLossModel
  • /ChannelList/[i]/$ns3::YansWifiChannel/PropagationLossModel/$ns3::JakesPropagationLossModel
  • /NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::JakesPropagationLossModel

No Attributes are defined for this type.
No TraceSources are defined for this type.

Definition at line 36 of file jakes-propagation-loss-model.h.

Constructor & Destructor Documentation

ns3::JakesPropagationLossModel::JakesPropagationLossModel ( )

Definition at line 34 of file jakes-propagation-loss-model.cc.

References m_uniformVariable, PI, and ns3::ObjectBase::SetAttribute().

+ Here is the call graph for this function:

ns3::JakesPropagationLossModel::~JakesPropagationLossModel ( )
virtual

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

Member Function Documentation

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

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

Implements ns3::PropagationLossModel.

Definition at line 76 of file jakes-propagation-loss-model.cc.

References m_uniformVariable, and ns3::RandomVariableStream::SetStream().

+ Here is the call graph for this function:

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

Spectrum model uid is not used in PropagationLossModel

Spectrum model uid is not used in PropagationLossModel

Implements ns3::PropagationLossModel.

Definition at line 55 of file jakes-propagation-loss-model.cc.

References m_propagationCache.

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

Definition at line 45 of file jakes-propagation-loss-model.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

Ptr< UniformRandomVariable > ns3::JakesPropagationLossModel::GetUniformRandomVariable ( ) const
private

Definition at line 70 of file jakes-propagation-loss-model.cc.

References m_uniformVariable.

Friends And Related Function Documentation

friend class JakesProcess
friend

Definition at line 46 of file jakes-propagation-loss-model.h.

Member Data Documentation

PropagationCache<JakesProcess> ns3::JakesPropagationLossModel::m_propagationCache
mutableprivate

Definition at line 55 of file jakes-propagation-loss-model.h.

Referenced by DoCalcRxPower().

Ptr<UniformRandomVariable> ns3::JakesPropagationLossModel::m_uniformVariable
private
const double ns3::JakesPropagationLossModel::PI = 3.14159265358979323846
static

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