A Discrete-Event Network Simulator
API
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 FRAME_CAPTURE_MODEL_H
22 #define FRAME_CAPTURE_MODEL_H
23 
24 #include "ns3/object.h"
25 
26 namespace ns3 {
27 
28 class Event;
29 class Time;
30 
36 class FrameCaptureModel : public Object
37 {
38 public:
43  static TypeId GetTypeId (void);
44 
56  virtual bool CaptureNewFrame (Ptr<Event> currentEvent, Ptr<Event> newEvent) const = 0;
57 
67  virtual bool IsInCaptureWindow (Time timePreambleDetected) const;
68 
69 
70 private:
71  Time m_captureWindow;
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:37
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
ns3::FrameCaptureModel::m_captureWindow
Time m_captureWindow
Capture window duration.
Definition: frame-capture-model.h:71
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::FrameCaptureModel::GetTypeId
static TypeId GetTypeId(void)
Get the type ID.
Definition: frame-capture-model.cc:29
ns3::Object
A base class which provides memory management and object aggregation.
Definition: object.h:88
ns3::Ptr
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:74
ns3::Time
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:103
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:793
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.