A Discrete-Event Network Simulator
API
simple-frame-capture-model.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017
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: Sébastien Deronne <sebastien.deronne@gmail.com>
18  */
19 
20 #ifndef SIMPLE_FRAME_CAPTURE_MODEL_H
21 #define SIMPLE_FRAME_CAPTURE_MODEL_H
22 
23 #include "frame-capture-model.h"
24 
25 namespace ns3
26 {
38 {
39  public:
44  static TypeId GetTypeId();
45 
47  ~SimpleFrameCaptureModel() override;
48 
54  void SetMargin(double margin);
60  double GetMargin() const;
61 
72  bool CaptureNewFrame(Ptr<Event> currentEvent, Ptr<Event> newEvent) const override;
73 
74  private:
75  double m_margin;
76 };
77 
78 } // namespace ns3
79 
80 #endif /* SIMPLE_FRAME_CAPTURE_MODEL_H */
the interface for Wifi's frame capture models
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:77
A simple threshold-based model for frame capture effect.
static TypeId GetTypeId()
Get the type ID.
bool CaptureNewFrame(Ptr< Event > currentEvent, Ptr< Event > newEvent) const override
This method returns whether the reception should be switched to a new incoming frame.
double m_margin
margin for determining if a new frame (dB)
void SetMargin(double margin)
Sets the frame capture margin (dB).
double GetMargin() const
Return the frame capture margin (dB).
a unique identifier for an interface.
Definition: type-id.h:59
Every class exported by the ns3 library is enclosed in the ns3 namespace.