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

virtual	~UanNoiseModelDefault ()
	Dummy destructor, DoDispose. More...

virtual double	GetNoiseDbHz (double fKhz) const
	Compute the noise power at a given frequency. More...

Public Member Functions inherited from ns3::UanNoiseModel
virtual void	Clear (void)
	Clear all pointer references. More...

virtual void	DoDispose (void)
	Destructor implementation. 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< Object >	GetObject () 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< Object >	GetObject (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[[maybe_unused]])
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= ([[maybe_unused]] 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...

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 (void)
	Register this type. More...

Static Public Member Functions inherited from ns3::UanNoiseModel
static TypeId	GetTypeId (void)
	Register this type. 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...

Private Attributes
double	m_shipping
	Shipping contribution to noise between 0 and 1. More...

double	m_wind
	Wind speed in m/s. More...

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object. 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...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

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

Config Paths

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

"/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::UanChannel/NoiseModel/$ns3::UanNoiseModelDefault"
"/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/Channel/$ns3::UanChannel/NoiseModel/$ns3::UanNoiseModelDefault"
"/NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/NoiseModel/$ns3::UanNoiseModelDefault"
"/ChannelList/[i]/$ns3::UanChannel/NoiseModel/$ns3::UanNoiseModelDefault"

Attributes

Wind: Wind speed in m/s.
- Set with class: ns3::DoubleValue
- Underlying type: double 0:1.79769e+308
- Initial value: 1
- Flags: construct write read
Shipping: Shipping contribution to noise between 0 and 1.
- Set with class: ns3::DoubleValue
- Underlying type: double 0:1
- Initial value: 0
- Flags: construct write read

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

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

Constructor & Destructor Documentation

◆ UanNoiseModelDefault()

ns3::UanNoiseModelDefault::UanNoiseModelDefault ( )

Default constructor.

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

◆ ~UanNoiseModelDefault()

ns3::UanNoiseModelDefault::~UanNoiseModelDefault ( )

virtual

Dummy destructor, DoDispose.

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

Member Function Documentation

◆ GetNoiseDbHz()

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

virtual

Compute the noise power at a given frequency.

Parameters

fKhz	Frequency in kHz.

Returns: Noise power in dB re 1uPa/Hz.

Implements ns3::UanNoiseModel.

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

References m_shipping, and m_wind.

◆ GetTypeId()

TypeId ns3::UanNoiseModelDefault::GetTypeId ( void )

static

Register this type.

Returns: The TypeId.

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

References m_shipping, m_wind, ns3::MakeDoubleAccessor(), 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 65 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 64 of file uan-noise-model-default.h.