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

Standard ambient acoustic noise model. More...

#include "uan-noise-model-default.h"

+ Inheritance diagram for ns3::UanNoiseModelDefault:
+ Collaboration diagram for ns3::UanNoiseModelDefault:

Public Member Functions

 UanNoiseModelDefault ()
 Default constructor.
 
 ~UanNoiseModelDefault () override
 Dummy destructor, DoDispose.
 
double GetNoiseDbHz (double fKhz) const override
 Compute the noise power at a given frequency.
 
- Public Member Functions inherited from ns3::UanNoiseModel
virtual void Clear ()
 Clear all pointer references.
 
void DoDispose () override
 Destructor implementation.
 
- 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 ()
 Register this type.
 
- Static Public Member Functions inherited from ns3::UanNoiseModel
static TypeId GetTypeId ()
 Register this type.
 
- 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.
 

Private Attributes

double m_shipping
 Shipping contribution to noise between 0 and 1.
 
double m_wind
 Wind speed in m/s.
 

Additional Inherited Members

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

Detailed Description

Standard ambient acoustic noise model.

See attributes for parameters

This class returns ambient noise by following the algorithm given in Harris, A. F. and Zorzi, M. 2007. Modeling the underwater acoustic channel in ns2. In Proceedings of the 2nd international Conference on Performance Evaluation Methodologies and Tools (Nantes, France, October 22 - 27, 2007). ValueTools, vol. 321. ICST (Institute for Computer Sciences Social-Informatics and Telecommunications Engineering), ICST, Brussels, Belgium, 1-8.

Which uses the noise model also given in the book "Principles of Underwater Sound" by Urick

Definition at line 38 of file uan-noise-model-default.h.

Constructor & Destructor Documentation

◆ UanNoiseModelDefault()

ns3::UanNoiseModelDefault::UanNoiseModelDefault ( )

Default constructor.

Definition at line 20 of file uan-noise-model-default.cc.

◆ ~UanNoiseModelDefault()

ns3::UanNoiseModelDefault::~UanNoiseModelDefault ( )
override

Dummy destructor, DoDispose.

Definition at line 24 of file uan-noise-model-default.cc.

Member Function Documentation

◆ GetNoiseDbHz()

double ns3::UanNoiseModelDefault::GetNoiseDbHz ( double fKhz) const
overridevirtual

Compute the noise power at a given frequency.

Parameters
fKhzFrequency in kHz.
Returns
Noise power in dB re 1uPa/Hz.

Implements ns3::UanNoiseModel.

Definition at line 51 of file uan-noise-model-default.cc.

References m_shipping, and m_wind.

◆ GetTypeId()

TypeId ns3::UanNoiseModelDefault::GetTypeId ( )
static

Register this type.

Returns
The TypeId.

Definition at line 29 of file uan-noise-model-default.cc.

References m_shipping, m_wind, ns3::MakeDoubleAccessor(), ns3::MakeDoubleChecker(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

Member Data Documentation

◆ m_shipping

double ns3::UanNoiseModelDefault::m_shipping
private

Shipping contribution to noise between 0 and 1.

Definition at line 55 of file uan-noise-model-default.h.

Referenced by GetNoiseDbHz(), and GetTypeId().

◆ m_wind

double ns3::UanNoiseModelDefault::m_wind
private

Wind speed in m/s.

Definition at line 54 of file uan-noise-model-default.h.

Referenced by GetNoiseDbHz(), and GetTypeId().


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