A Discrete-Event Network Simulator
API
ns3::PhasedArraySpectrumPropagationLossModel Class Referenceabstract

spectrum-aware propagation loss model that is compatible with PhasedArrayModel type of ns-3 antenna More...

#include "phased-array-spectrum-propagation-loss-model.h"

+ Inheritance diagram for ns3::PhasedArraySpectrumPropagationLossModel:
+ Collaboration diagram for ns3::PhasedArraySpectrumPropagationLossModel:

Public Member Functions

 PhasedArraySpectrumPropagationLossModel ()
 
virtual ~PhasedArraySpectrumPropagationLossModel ()
 
Ptr< SpectrumValueCalcRxPowerSpectralDensity (Ptr< const SpectrumSignalParameters > txPsd, Ptr< const MobilityModel > a, Ptr< const MobilityModel > b, Ptr< const PhasedArrayModel > aPhasedArrayModel, Ptr< const PhasedArrayModel > bPhasedArrayModel) const
 This method is to be called to calculate. More...
 
void SetNext (Ptr< PhasedArraySpectrumPropagationLossModel > next)
 Used to chain various instances of PhasedArraySpectrumPropagationLossModel. 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...
 
virtual TypeId GetInstanceTypeId (void) const =0
 Get the most derived TypeId for this Object. 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 ()
 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...
 

Protected Member Functions

virtual void DoDispose ()
 Destructor implementation. More...
 
- 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...
 

Private Member Functions

virtual Ptr< SpectrumValueDoCalcRxPowerSpectralDensity (Ptr< const SpectrumSignalParameters > params, Ptr< const MobilityModel > a, Ptr< const MobilityModel > b, Ptr< const PhasedArrayModel > aPhasedArrayModel, Ptr< const PhasedArrayModel > bPhasedArrayModel) const =0
 

Private Attributes

Ptr< PhasedArraySpectrumPropagationLossModelm_next
 PhasedArraySpectrumPropagationLossModel chained to this one. More...
 

Additional Inherited Members

Detailed Description

spectrum-aware propagation loss model that is compatible with PhasedArrayModel type of ns-3 antenna

Introspection did not find any typical Config paths.

Interface for propagation loss models to be adopted when transmissions are modeled with a power spectral density by means of the SpectrumValue class, and when PhasedArrayModel type of atenna is being used for TX and RX.


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

Definition at line 45 of file phased-array-spectrum-propagation-loss-model.h.

Constructor & Destructor Documentation

◆ PhasedArraySpectrumPropagationLossModel()

ns3::PhasedArraySpectrumPropagationLossModel::PhasedArraySpectrumPropagationLossModel ( )

◆ ~PhasedArraySpectrumPropagationLossModel()

ns3::PhasedArraySpectrumPropagationLossModel::~PhasedArraySpectrumPropagationLossModel ( )
virtual

Member Function Documentation

◆ CalcRxPowerSpectralDensity()

Ptr< SpectrumValue > ns3::PhasedArraySpectrumPropagationLossModel::CalcRxPowerSpectralDensity ( Ptr< const SpectrumSignalParameters txPsd,
Ptr< const MobilityModel a,
Ptr< const MobilityModel b,
Ptr< const PhasedArrayModel aPhasedArrayModel,
Ptr< const PhasedArrayModel bPhasedArrayModel 
) const

This method is to be called to calculate.

Parameters
txPsdthe spectrum signal parameters.
asender mobility
breceiver mobility
aPhasedArrayModelthe instance of the phased antenna array of the sender
bPhasedArrayModelthe instance of the phased antenna array of the receiver
Returns
set of values Vs frequency representing the received power in the same units used for the txPower parameter.

Definition at line 64 of file phased-array-spectrum-propagation-loss-model.cc.

References DoCalcRxPowerSpectralDensity(), and m_next.

Referenced by ComputeSnr().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ DoCalcRxPowerSpectralDensity()

virtual Ptr< SpectrumValue > ns3::PhasedArraySpectrumPropagationLossModel::DoCalcRxPowerSpectralDensity ( Ptr< const SpectrumSignalParameters params,
Ptr< const MobilityModel a,
Ptr< const MobilityModel b,
Ptr< const PhasedArrayModel aPhasedArrayModel,
Ptr< const PhasedArrayModel bPhasedArrayModel 
) const
privatepure virtual
Parameters
paramsthe spectrum signal parameters.
asender mobility
breceiver mobility
aPhasedArrayModelthe instance of the phased antenna array of the sender
bPhasedArrayModelthe instance of the phased antenna array of the receiver
Returns
set of values Vs frequency representing the received power in the same units used for the txPower parameter.

Implemented in ns3::ThreeGppSpectrumPropagationLossModel.

Referenced by CalcRxPowerSpectralDensity().

+ Here is the caller graph for this function:

◆ DoDispose()

void ns3::PhasedArraySpectrumPropagationLossModel::DoDispose ( void  )
protectedvirtual

Destructor implementation.

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

Subclasses are expected to implement their real destruction code in an overridden 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.

Reimplemented in ns3::ThreeGppSpectrumPropagationLossModel.

Definition at line 42 of file phased-array-spectrum-propagation-loss-model.cc.

References m_next.

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 48 of file phased-array-spectrum-propagation-loss-model.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ SetNext()

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

Used to chain various instances of PhasedArraySpectrumPropagationLossModel.

Parameters
next

Definition at line 58 of file phased-array-spectrum-propagation-loss-model.cc.

References m_next.

Member Data Documentation

◆ m_next

Ptr<PhasedArraySpectrumPropagationLossModel> ns3::PhasedArraySpectrumPropagationLossModel::m_next
private

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