A Discrete-Event Network Simulator
API
frame-capture-model.cc
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 #include "ns3/nstime.h"
22 #include "ns3/simulator.h"
23 #include "frame-capture-model.h"
24 
25 namespace ns3 {
26 
27 NS_OBJECT_ENSURE_REGISTERED (FrameCaptureModel);
28 
30 {
31  static TypeId tid = TypeId ("ns3::FrameCaptureModel")
32  .SetParent<Object> ()
33  .SetGroupName ("Wifi")
34  .AddAttribute ("CaptureWindow",
35  "The duration of the capture window.",
36  TimeValue (MicroSeconds (16)),
38  MakeTimeChecker ())
39  ;
40  return tid;
41 }
42 
43 bool
44 FrameCaptureModel::IsInCaptureWindow (Time timePreambleDetected) const
45 {
46  return (timePreambleDetected + m_captureWindow >= Simulator::Now ());
47 }
48 
49 } //namespace ns3
ns3::TypeId
a unique identifier for an interface.
Definition: type-id.h:59
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:44
NS_OBJECT_ENSURE_REGISTERED
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:45
ns3::MakeTimeChecker
Ptr< const AttributeChecker > MakeTimeChecker(const Time min, const Time max)
Helper to make a Time checker with bounded range.
Definition: time.cc:533
ns3::Simulator::Now
static Time Now(void)
Return the current simulation virtual time.
Definition: simulator.cc:195
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::MicroSeconds
Time MicroSeconds(uint64_t value)
Construct a Time in the indicated unit.
Definition: nstime.h:1305
frame-capture-model.h
ns3::FrameCaptureModel::m_captureWindow
Time m_captureWindow
Capture window duration.
Definition: frame-capture-model.h:71
ns3::TypeId::SetParent
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:923
ns3::Object
A base class which provides memory management and object aggregation.
Definition: object.h:88
ns3::Time
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:104
ns3::TimeValue
AttributeValue implementation for Time.
Definition: nstime.h:1353
ns3::FrameCaptureModel::GetTypeId
static TypeId GetTypeId(void)
Get the type ID.
Definition: frame-capture-model.cc:29
ns3::MakeTimeAccessor
Ptr< const AttributeAccessor > MakeTimeAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method.
Definition: nstime.h:1354