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

#include <introspected-doxygen.h>

+ Inheritance diagram for ns3::UanPropModel:

Public Member Functions

virtual void Clear (void)
 
virtual void DoDispose (void)
 
virtual Time GetDelay (Ptr< MobilityModel > a, Ptr< MobilityModel > b, UanTxMode mode)=0
 
virtual double GetPathLossDb (Ptr< MobilityModel > a, Ptr< MobilityModel > b, UanTxMode txMode)=0
 
virtual UanPdp GetPdp (Ptr< MobilityModel > a, Ptr< MobilityModel > b, UanTxMode mode)=0
 
- 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 (void)
 
- 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)
 

Additional Inherited Members

- 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)
 

Detailed Description

Config Paths

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

  • /ChannelList/[i]/$ns3::UanChannel/PropagationModel
  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/PropagationModel

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

Base class for implemented underwater propagation models

Definition at line 216 of file uan-prop-model.h.

Member Function Documentation

void ns3::UanPropModel::Clear ( void  )
virtual

Clears all pointer references

Definition at line 349 of file uan-prop-model.cc.

Referenced by DoDispose().

void ns3::UanPropModel::DoDispose ( void  )
virtual

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 354 of file uan-prop-model.cc.

References Clear(), and ns3::Object::DoDispose().

virtual Time ns3::UanPropModel::GetDelay ( Ptr< MobilityModel a,
Ptr< MobilityModel b,
UanTxMode  mode 
)
pure virtual

Finds propagation delay between nodes a and b

Parameters
aPtr to mobility model of node a
bPtr to mobility model of node b
modeTX mode of transmission
Returns
Propagation delay

Implemented in ns3::UanPropModelIdeal, and ns3::UanPropModelThorp.

virtual double ns3::UanPropModel::GetPathLossDb ( Ptr< MobilityModel a,
Ptr< MobilityModel b,
UanTxMode  txMode 
)
pure virtual

Computes pathloss between nodes a and b.

Returns
Pathloss in dB re 1 uPa
Parameters
aPtr to mobility model of node a
bPtr to mobility model of node b
txModeTX mode of transmission between a and b

Implemented in ns3::UanPropModelIdeal, and ns3::UanPropModelThorp.

virtual UanPdp ns3::UanPropModel::GetPdp ( Ptr< MobilityModel a,
Ptr< MobilityModel b,
UanTxMode  mode 
)
pure virtual
Returns
PDP for link between nodes a and b
Parameters
aPtr to mobility model of node a
bPtr to mobility model of node b
modeTX mode of transmission from a to b

Implemented in ns3::UanPropModelIdeal, and ns3::UanPropModelThorp.


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