A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
uan-noise-model.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_H
10#define UAN_NOISE_MODEL_H
11
12#include "ns3/object.h"
13
14namespace ns3
15{
16
17/**
18 * \ingroup uan
19 *
20 * UAN Noise Model base class.
21 */
22class UanNoiseModel : public Object
23{
24 public:
25 /**
26 * Register this type.
27 * \return The TypeId.
28 */
29 static TypeId GetTypeId();
30
31 /**
32 * Compute the noise power at a given frequency.
33 *
34 * \param fKhz Frequency in kHz.
35 * \return Noise power in dB re 1uPa/Hz.
36 */
37 virtual double GetNoiseDbHz(double fKhz) const = 0;
38
39 /** Clear all pointer references. */
40 virtual void Clear();
41
42 void DoDispose() override;
43
44}; // class UanNoiseModel
45
46} // namespace ns3
47
48#endif /* UAN_NOISE_MODEL_H */
A base class which provides memory management and object aggregation.
Definition object.h:78
a unique identifier for an interface.
Definition type-id.h:48
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.