A Discrete-Event Network Simulator
API
simple-frame-capture-model.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2017
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 SIMPLE_FRAME_CAPTURE_MODEL_H
22 #define SIMPLE_FRAME_CAPTURE_MODEL_H
23 
24 #include "frame-capture-model.h"
25 
26 namespace ns3 {
38 {
39 public:
44  static TypeId GetTypeId (void);
45 
48 
54  void SetMargin (double margin);
60  double GetMargin (void) const;
61 
72  bool CaptureNewFrame (Ptr<Event> currentEvent, Ptr<Event> newEvent) const;
73 
74 
75 private:
76  double m_margin;
77 };
78 
79 } //namespace ns3
80 
81 #endif /* SIMPLE_FRAME_CAPTURE_MODEL_H */
82 
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
A simple threshold-based model for frame capture effect.
static TypeId GetTypeId(void)
Get the type ID.
the interface for Wifi&#39;s frame capture models
double GetMargin(void) const
Return the frame capture margin (dB).
Every class exported by the ns3 library is enclosed in the ns3 namespace.
bool CaptureNewFrame(Ptr< Event > currentEvent, Ptr< Event > newEvent) const
This method returns whether the reception should be switched to a new incoming frame.
void SetMargin(double margin)
Sets the frame capture margin (dB).
a unique identifier for an interface.
Definition: type-id.h:58
double m_margin
margin for determining if a new frame (dB)