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