A Discrete-Event Network Simulator
API
preamble-detection-model.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2018 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: Sébastien Deronne <sebastien.deronne@gmail.com>
19  */
20 
21 #ifndef PREAMBLE_DETECTION_MODEL_H
22 #define PREAMBLE_DETECTION_MODEL_H
23 
24 #include "ns3/object.h"
25 
26 namespace ns3 {
27 
33 class PreambleDetectionModel : public Object
34 {
35 public:
40  static TypeId GetTypeId (void);
41 
53  virtual bool IsPreambleDetected (double rssi, double snr, double channelWidth) const = 0;
54 };
55 
56 } //namespace ns3
57 
58 #endif /* PREAMBLE_DETECTION_MODEL_H */
59 
ns3::Object
A base class which provides memory management and object aggregation.
Definition: object.h:88
ns3::PreambleDetectionModel
the interface for Wifi's preamble detection models
Definition: preamble-detection-model.h:34
ns3::PreambleDetectionModel::GetTypeId
static TypeId GetTypeId(void)
Get the type ID.
Definition: preamble-detection-model.cc:27
ns3::PreambleDetectionModel::IsPreambleDetected
virtual bool IsPreambleDetected(double rssi, double snr, double channelWidth) const =0
A pure virtual method that must be implemented in the subclass.
ns3::TypeId
a unique identifier for an interface.
Definition: type-id.h:59
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.