A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
uan-noise-model-default.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2009 University of Washington
3 *
4 * SPDX-License-Identifier: GPL-2.0-only
5 *
6 * Author: Leonard Tracy <lentracy@gmail.com>
7 */
8
9#ifndef UAN_NOISE_MODEL_DEFAULT_H
10#define UAN_NOISE_MODEL_DEFAULT_H
11
12#include "uan-noise-model.h"
13
14#include "ns3/attribute.h"
15#include "ns3/object.h"
16
17namespace ns3
18{
19
20/**
21 * \ingroup uan
22 *
23 * Standard ambient acoustic noise model.
24 *
25 * See attributes for parameters
26 *
27 * This class returns ambient noise by following the algorithm given in
28 * Harris, A. F. and Zorzi, M. 2007. Modeling the underwater acoustic
29 * channel in ns2. In Proceedings of the 2nd international Conference
30 * on Performance Evaluation Methodologies and Tools (Nantes, France,
31 * October 22 - 27, 2007). ValueTools, vol. 321. ICST (Institute for
32 * Computer Sciences Social-Informatics and Telecommunications Engineering),
33 * ICST, Brussels, Belgium, 1-8.
34 *
35 * Which uses the noise model also given in the book
36 * "Principles of Underwater Sound" by Urick
37 */
39{
40 public:
41 UanNoiseModelDefault(); //!< Default constructor.
42 ~UanNoiseModelDefault() override; //!< Dummy destructor, DoDispose.
43
44 /**
45 * Register this type.
46 * \return The TypeId.
47 */
48 static TypeId GetTypeId();
49
50 // Inherited methods
51 double GetNoiseDbHz(double fKhz) const override;
52
53 private:
54 double m_wind; //!< Wind speed in m/s.
55 double m_shipping; //!< Shipping contribution to noise between 0 and 1.
56
57}; // class UanNoiseModelDefault
58
59} // namespace ns3
60
61#endif /* UAN_NOISE_MODEL_DEFAULT_H */
a unique identifier for an interface.
Definition type-id.h:48
Standard ambient acoustic noise model.
double m_wind
Wind speed in m/s.
double GetNoiseDbHz(double fKhz) const override
Compute the noise power at a given frequency.
static TypeId GetTypeId()
Register this type.
~UanNoiseModelDefault() override
Dummy destructor, DoDispose.
UanNoiseModelDefault()
Default constructor.
double m_shipping
Shipping contribution to noise between 0 and 1.
UAN Noise Model base class.
Every class exported by the ns3 library is enclosed in the ns3 namespace.