A Discrete-Event Network Simulator
API
uan-noise-model.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2009 University of Washington
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License version 2 as
6  * published by the Free Software Foundation;
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program; if not, write to the Free Software
15  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16  *
17  * Author: Leonard Tracy <lentracy@gmail.com>
18  */
19 
20 #ifndef UAN_NOISE_MODEL_H
21 #define UAN_NOISE_MODEL_H
22 
23 #include "ns3/object.h"
24 
25 namespace ns3
26 {
27 
33 class UanNoiseModel : public Object
34 {
35  public:
40  static TypeId GetTypeId();
41 
48  virtual double GetNoiseDbHz(double fKhz) const = 0;
49 
51  virtual void Clear();
52 
53  void DoDispose() override;
54 
55 }; // class UanNoiseModel
56 
57 } // namespace ns3
58 
59 #endif /* UAN_NOISE_MODEL_H */
A base class which provides memory management and object aggregation.
Definition: object.h:89
a unique identifier for an interface.
Definition: type-id.h:59
UAN Noise Model base class.
void DoDispose() override
Destructor implementation.
virtual double GetNoiseDbHz(double fKhz) const =0
Compute the noise power at a given frequency.
static TypeId GetTypeId()
Register this type.
virtual void Clear()
Clear all pointer references.
Every class exported by the ns3 library is enclosed in the ns3 namespace.