A Discrete-Event Network Simulator
API
frame-capture-model.cc
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 #include "frame-capture-model.h"
21 
22 #include "ns3/nstime.h"
23 #include "ns3/simulator.h"
24 
25 namespace ns3
26 {
27 
28 NS_OBJECT_ENSURE_REGISTERED(FrameCaptureModel);
29 
30 TypeId
32 {
33  static TypeId tid = TypeId("ns3::FrameCaptureModel")
34  .SetParent<Object>()
35  .SetGroupName("Wifi")
36  .AddAttribute("CaptureWindow",
37  "The duration of the capture window.",
40  MakeTimeChecker());
41  return tid;
42 }
43 
44 bool
45 FrameCaptureModel::IsInCaptureWindow(Time timePreambleDetected) const
46 {
47  return (timePreambleDetected + m_captureWindow >= Simulator::Now());
48 }
49 
50 } // namespace ns3
virtual bool IsInCaptureWindow(Time timePreambleDetected) const
This method returns true if the capture window duration has not elapsed yet, false otherwise.
Time m_captureWindow
Capture window duration.
static TypeId GetTypeId()
Get the type ID.
A base class which provides memory management and object aggregation.
Definition: object.h:89
static Time Now()
Return the current simulation virtual time.
Definition: simulator.cc:208
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:105
a unique identifier for an interface.
Definition: type-id.h:59
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:931
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:46
Time MicroSeconds(uint64_t value)
Construct a Time in the indicated unit.
Definition: nstime.h:1350
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Ptr< const AttributeAccessor > MakeTimeAccessor(T1 a1)
Definition: nstime.h:1414
Ptr< const AttributeChecker > MakeTimeChecker(const Time min, const Time max)
Helper to make a Time checker with bounded range.
Definition: time.cc:533