ns-3
ns3::UanNoiseModelDefault Class Reference

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

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

List of all members.

Public Member Functions

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
virtual TypeId GetInstanceTypeId (void) const
template<typename T >
Ptr< T > GetObject (void) const
template<typename T >
Ptr< T > GetObject (TypeId tid) const
void Dispose (void)
void AggregateObject (Ptr< Object > other)
AggregateIterator GetAggregateIterator (void) const
void Start (void)
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount (const SimpleRefCount &o)
SimpleRefCountoperator= (const SimpleRefCount &o)
void Ref (void) const
void Unref (void) const
uint32_t GetReferenceCount (void) const
- Public Member Functions inherited from ns3::ObjectBase
void SetAttribute (std::string name, const AttributeValue &value)
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
void GetAttribute (std::string name, AttributeValue &value) const
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
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)
 This method returns the TypeId associated to ns3::UanNoiseModelDefault.

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


Member Function Documentation

double ns3::UanNoiseModelDefault::GetNoiseDbHz ( double  fKhz) const
virtual
Returns:
Noise power in dB re 1uPa/Hz
Parameters:
fKhzFrequency in kHz

Implements ns3::UanNoiseModel.

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

This method returns the TypeId associated to ns3::UanNoiseModelDefault.

Attributes defined for this type:

  • 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

No TraceSources defined for this type.

Reimplemented from ns3::UanNoiseModel.

References ns3::TypeId::SetParent().


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