|
A Discrete-Event Network Simulator
|
API |
|
|
A Discrete-Event Network Simulator
|
API |
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) |
| This method is called by Object::Dispose or by the object's destructor, whichever comes first. More... | |
| Public Member Functions inherited from ns3::Object | |
| Object () | |
| virtual | ~Object () |
| void | AggregateObject (Ptr< Object > other) |
| void | Dispose (void) |
| Run the DoDispose methods of this object and all the objects aggregated to it. More... | |
| 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) |
| This method calls the virtual DoInitialize method on all the objects aggregated to this object. More... | |
| Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
| SimpleRefCount () | |
| Constructor. More... | |
| SimpleRefCount (const SimpleRefCount &o) | |
| Copy constructor. More... | |
| uint32_t | GetReferenceCount (void) const |
| Get the reference count of the object. More... | |
| SimpleRefCount & | operator= (const SimpleRefCount &o) |
| Assignment. 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 |
| 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) |
| 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::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
| static void | Cleanup (void) |
| Noop. 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) | |
| virtual void | DoInitialize (void) |
| This method is called only once by Object::Initialize. More... | |
| virtual void | NotifyNewAggregate (void) |
| This method is invoked whenever two sets of objects are aggregated together. More... | |
| Protected Member Functions inherited from ns3::ObjectBase | |
| void | ConstructSelf (const AttributeConstructionList &attributes) |
| virtual void | NotifyConstructionCompleted (void) |
| This method is invoked once all member attributes have been initialized. More... | |
Standard ambient acoustic noise model.
Doxygen introspection did not find any typical Config paths.
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
No TraceSources are defined for this type.
Definition at line 48 of file uan-noise-model-default.h.
| ns3::UanNoiseModelDefault::UanNoiseModelDefault | ( | ) |
Default constructor.
Definition at line 31 of file uan-noise-model-default.cc.
|
virtual |
Dummy destructor, DoDispose.
Definition at line 36 of file uan-noise-model-default.cc.
|
virtual |
Compute the noise power at a given frequency.
| fKhz | Frequency in kHz. |
Implements ns3::UanNoiseModel.
Definition at line 61 of file uan-noise-model-default.cc.
References m_shipping, and m_wind.
|
static |
Register this type.
Definition at line 41 of file uan-noise-model-default.cc.
References m_shipping, m_wind, and ns3::TypeId::SetParent().
Here is the call graph for this function:
|
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().
|
private |
Wind speed in m/s.
Definition at line 64 of file uan-noise-model-default.h.
Referenced by GetNoiseDbHz(), and GetTypeId().
1.8.6 
