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
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 FRAME_CAPTURE_MODEL_H
21
#define FRAME_CAPTURE_MODEL_H
22
23
#include "ns3/nstime.h"
24
#include "ns3/object.h"
25
26
namespace
ns3
27
{
28
29
class
Event;
30
class
Time
;
31
32
/**
33
* \ingroup wifi
34
* \brief the interface for Wifi's frame capture models
35
*
36
*/
37
class
FrameCaptureModel
:
public
Object
38
{
39
public
:
40
/**
41
* \brief Get the type ID.
42
* \return the object TypeId
43
*/
44
static
TypeId
GetTypeId
();
45
46
/**
47
* A pure virtual method that must be implemented in the subclass.
48
* This method returns whether the reception should be switched to a
49
* new incoming frame.
50
*
51
* \param currentEvent the event of the current frame
52
* \param newEvent the event of the new incoming frame
53
*
54
* \return true if the reception should be switched to a new incoming frame,
55
* false otherwise
56
*/
57
virtual
bool
CaptureNewFrame
(
Ptr<Event>
currentEvent,
Ptr<Event>
newEvent)
const
= 0;
58
59
/**
60
* This method returns true if the capture window duration has not elapsed yet,
61
* false otherwise.
62
*
63
* \param timePreambleDetected the time the preamble was detected
64
*
65
* \return true if the capture window duration has not elapsed yet,
66
* false otherwise
67
*/
68
virtual
bool
IsInCaptureWindow
(
Time
timePreambleDetected)
const
;
69
70
private
:
71
Time
m_captureWindow
;
//!< Capture window duration
72
};
73
74
}
// namespace ns3
75
76
#endif
/* FRAME_CAPTURE_MODEL_H */
ns3::FrameCaptureModel
the interface for Wifi's frame capture models
Definition:
frame-capture-model.h:38
ns3::FrameCaptureModel::IsInCaptureWindow
virtual bool IsInCaptureWindow(Time timePreambleDetected) const
This method returns true if the capture window duration has not elapsed yet, false otherwise.
Definition:
frame-capture-model.cc:45
ns3::FrameCaptureModel::m_captureWindow
Time m_captureWindow
Capture window duration.
Definition:
frame-capture-model.h:71
ns3::FrameCaptureModel::GetTypeId
static TypeId GetTypeId()
Get the type ID.
Definition:
frame-capture-model.cc:31
ns3::FrameCaptureModel::CaptureNewFrame
virtual bool CaptureNewFrame(Ptr< Event > currentEvent, Ptr< Event > newEvent) const =0
A pure virtual method that must be implemented in the subclass.
ns3::Object
A base class which provides memory management and object aggregation.
Definition:
object.h:89
ns3::Ptr
Smart pointer class similar to boost::intrusive_ptr.
Definition:
ptr.h:77
ns3::Time
Simulation virtual time values and global simulation resolution.
Definition:
nstime.h:105
ns3::TypeId
a unique identifier for an interface.
Definition:
type-id.h:59
ns3::TracedValueCallback::Time
void(* Time)(Time oldValue, Time newValue)
TracedValue callback signature for Time.
Definition:
nstime.h:839
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
src
wifi
model
frame-capture-model.h
Generated on Tue May 28 2024 23:40:12 for ns-3 by
1.9.6