ns3::UanNoiseModelDefault Class Reference

#include <uan-noise-model-default.h>

Inheritance diagram for ns3::UanNoiseModelDefault:

Collaboration diagram for ns3::UanNoiseModelDefault:

Public Member Functions
	UanNoiseModelDefault ()
virtual	~UanNoiseModelDefault ()
virtual double	GetNoiseDbHz (double fKhz) const
Public Member Functions inherited from ns3::UanNoiseModel
virtual void	Clear (void)
virtual void	DoDispose (void)
Public Member Functions inherited from ns3::Object
	Object ()
virtual	~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 ()
	SimpleRefCount (const SimpleRefCount &o)
uint32_t	GetReferenceCount (void) const
SimpleRefCount &	operator= (const SimpleRefCount &o)
void	Ref (void) const
void	Unref (void) const
Public Member Functions inherited from ns3::ObjectBase
virtual	~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::UanNoiseModel
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)

Private Attributes
double	m_shipping
double	m_wind

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

Doxygen introspection did not find any typical Config paths.

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.

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 45 of file uan-noise-model-default.h.

Constructor & Destructor Documentation

ns3::UanNoiseModelDefault::UanNoiseModelDefault

(

)

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

ns3::UanNoiseModelDefault::~UanNoiseModelDefault ( )

virtual

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

Member Function Documentation

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

virtual

Returns

Noise power in dB re 1uPa/Hz

Parameters

fKhz	Frequency in kHz

Implements ns3::UanNoiseModel.

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

References m_shipping, and m_wind.

TypeId ns3::UanNoiseModelDefault::GetTypeId ( void  )

static

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

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

Here is the call graph for this function:

Member Data Documentation

double ns3::UanNoiseModelDefault::m_shipping

private

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

Referenced by GetNoiseDbHz(), and GetTypeId().

double ns3::UanNoiseModelDefault::m_wind

private

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

Referenced by GetNoiseDbHz(), and GetTypeId().

---

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

• src/uan/model/uan-noise-model-default.h
• src/uan/model/uan-noise-model-default.cc