A Discrete-Event Network Simulator
Home
Tutorials ▼
English
Documentation ▼
Installation
Manual
Models
Contributing
Wiki
Development ▼
API Docs
Issue Tracker
Merge Requests
API
Loading...
Searching...
No Matches
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
{
27
/**
28
* \ingroup wifi
29
*
30
* A simple threshold-based model for frame capture effect.
31
* If the new incoming frame arrives while the receiver is
32
* receiving the preamble of another frame and the SIR of
33
* the new incoming frame is above a fixed margin, then
34
* the current frame is dropped and the receiver locks
35
* onto the new incoming frame.
36
*/
37
class
SimpleFrameCaptureModel
:
public
FrameCaptureModel
38
{
39
public
:
40
/**
41
* \brief Get the type ID.
42
* \return the object TypeId
43
*/
44
static
TypeId
GetTypeId
();
45
46
SimpleFrameCaptureModel
();
47
~SimpleFrameCaptureModel
()
override
;
48
49
/**
50
* Sets the frame capture margin (dB).
51
*
52
* \param margin the frame capture margin in dB
53
*/
54
void
SetMargin
(
double
margin);
55
/**
56
* Return the frame capture margin (dB).
57
*
58
* \return the frame capture margin in dB
59
*/
60
double
GetMargin
()
const
;
61
62
/**
63
* This method returns whether the reception should be switched to a
64
* new incoming frame.
65
*
66
* \param currentEvent the event of the current frame
67
* \param newEvent the event of the new incoming frame
68
*
69
* \return true if the reception should be switched to a new incoming frame,
70
* false otherwise
71
*/
72
bool
CaptureNewFrame
(
Ptr<Event>
currentEvent,
Ptr<Event>
newEvent)
const override
;
73
74
private
:
75
double
m_margin
;
///< margin for determining if a new frame (dB)
76
};
77
78
}
// namespace ns3
79
80
#endif
/* SIMPLE_FRAME_CAPTURE_MODEL_H */
ns3::FrameCaptureModel
the interface for Wifi's frame capture models
Definition:
frame-capture-model.h:38
ns3::Ptr
Smart pointer class similar to boost::intrusive_ptr.
Definition:
ptr.h:77
ns3::SimpleFrameCaptureModel
A simple threshold-based model for frame capture effect.
Definition:
simple-frame-capture-model.h:38
ns3::SimpleFrameCaptureModel::GetTypeId
static TypeId GetTypeId()
Get the type ID.
Definition:
simple-frame-capture-model.cc:37
ns3::SimpleFrameCaptureModel::~SimpleFrameCaptureModel
~SimpleFrameCaptureModel() override
Definition:
simple-frame-capture-model.cc:60
ns3::SimpleFrameCaptureModel::SimpleFrameCaptureModel
SimpleFrameCaptureModel()
Definition:
simple-frame-capture-model.cc:55
ns3::SimpleFrameCaptureModel::CaptureNewFrame
bool CaptureNewFrame(Ptr< Event > currentEvent, Ptr< Event > newEvent) const override
This method returns whether the reception should be switched to a new incoming frame.
Definition:
simple-frame-capture-model.cc:79
ns3::SimpleFrameCaptureModel::m_margin
double m_margin
margin for determining if a new frame (dB)
Definition:
simple-frame-capture-model.h:75
ns3::SimpleFrameCaptureModel::SetMargin
void SetMargin(double margin)
Sets the frame capture margin (dB).
Definition:
simple-frame-capture-model.cc:66
ns3::SimpleFrameCaptureModel::GetMargin
double GetMargin() const
Return the frame capture margin (dB).
Definition:
simple-frame-capture-model.cc:73
ns3::TypeId
a unique identifier for an interface.
Definition:
type-id.h:59
frame-capture-model.h
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
src
wifi
model
simple-frame-capture-model.h
Generated on Tue May 28 2024 23:40:29 for ns-3 by
1.9.6