A Discrete-Event Network Simulator
API
wave-bsm-stats.h
Go to the documentation of this file.
1 /* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2014 North Carolina State University
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: Scott E. Carpenter <scarpen@ncsu.edu>
19  *
20  */
21 
22 #ifndef WAVE_BSM_STATS_H
23 #define WAVE_BSM_STATS_H
24 
25 #include "ns3/object.h"
26 #include <vector>
27 
28 namespace ns3 {
49 class WaveBsmStats : public Object
50 {
51 public:
56  WaveBsmStats ();
57 
62  static TypeId GetTypeId (void);
63 
68  void IncTxPktCount ();
69 
74  int GetTxPktCount ();
75 
76  /*
77  * Note:
78  * The WAVE Basic Safety Message (BSM) is broadcast and
79  * unacknowledged. In order to calculate packet delivery
80  * ratio (PDR), we must count i) the packets that are
81  * actually received and ii) the transmitted packets that
82  * are expected to be received. Both are relative to a
83  * specified (circular) coverage area.
84  *
85  * For example: Say we have three nodes, A, B, and C, each
86  * separated by 40m, as follows:
87  *
88  * A --<40m>-- B --<40m>-- C
89  *
90  * Let's assume that the transmission range is 50m, and only
91  * A is transmitting (i.e. broadcasting). B can receive A's
92  * broadcasts, while C cannot. Let's assume no dropped packets.
93  * If we set the coverage area to 100m, then the PDR is 50%,
94  * because B receives every transmission from A, while C receives
95  * none of them. However, if we change the effective
96  * coverage area to 75m then the PDR improves to 100%, because
97  * B receives 100% of A's transmissions, and C is outside of the
98  * coverage area, and so does not factor in to the PDR.
99  */
100 
112  void IncExpectedRxPktCount (int index);
113 
119  void IncRxPktCount ();
120 
130  void IncRxPktInRangeCount (int index);
131 
136  int GetRxPktCount ();
137 
143  int GetExpectedRxPktCount (int index);
144 
150  int GetRxPktInRangeCount (int index);
151 
158  void SetExpectedRxPktCount (int index, int count);
159 
166  void SetRxPktInRangeCount (int index, int count);
167 
174  void ResetTotalRxPktCounts (int index);
175 
181  void SetTxPktCount (int count);
182 
188  void SetRxPktCount (int count);
189 
196  void IncTxByteCount (int bytes);
197 
203  int GetTxByteCount ();
204 
212  double GetBsmPdr (int index);
213 
221  double GetCumulativeBsmPdr (int index);
222 
228  void SetLogging (int log);
229 
234  int GetLogging ();
235 
236 private:
241  std::vector <int> m_wavePktExpectedReceiveCounts;
244  int m_log;
245 };
246 
247 } // namespace ns3
248 
249 #endif /* WAVE_BSM_STATS_H*/
void SetLogging(int log)
Enables/disables logging.
void SetExpectedRxPktCount(int index, int count)
Sets the count of packets expected to received.
double GetBsmPdr(int index)
Returns the BSM Packet Delivery Ratio (PDR) which is the percent of expected packets within range(ind...
int GetRxPktInRangeCount(int index)
Increments the count of actual packets received within range(index)
int GetTxByteCount()
Returns the count of (application data) bytes transmitted not include MAC/PHY overhead.
void SetRxPktInRangeCount(int index, int count)
Sets the count of packets within range that are received.
int m_wavePktReceiveCount
packet receive count
void IncTxByteCount(int bytes)
Increments the count of (application data) bytes transmitted not including MAC/PHY overhead...
void ResetTotalRxPktCounts(int index)
Resets the count of total packets expected and/or within range(index) that are received.
void IncTxPktCount()
Increments the count of transmitted packets.
int GetRxPktCount()
Returns the count of packets received.
int GetTxPktCount()
Returns the count of transmitted packets.
void IncExpectedRxPktCount(int index)
Increments the count of (broadcast) packets expected to be received within the coverage area1...
int m_waveByteSendCount
byte sent count
The WaveBsmStats class implements a stats collector for IEEE 1609 WAVE (Wireless Access in Vehicular ...
void SetRxPktCount(int count)
Sets the count of packets received.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
int GetExpectedRxPktCount(int index)
Returns the count of expected packets received within range(index)
std::vector< int > m_waveTotalPktInCoverageReceiveCounts
total packet in coverage receive counts
std::vector< int > m_wavePktInCoverageReceiveCounts
packet in ceoverage receive counts
WaveBsmStats()
Constructor.
void IncRxPktCount()
Increments the count of actual packets received (regardless of coverage area).
void SetTxPktCount(int count)
Sets the count of packets transmitted.
int m_wavePktSendCount
packet sent count
std::vector< int > m_wavePktExpectedReceiveCounts
packet expected receive counts
std::vector< int > m_waveTotalPktExpectedReceiveCounts
total packet expected receive counts
void IncRxPktInRangeCount(int index)
Increments the count of actual packets received within the coverage area(index).
int GetLogging()
Gets logging state.
double GetCumulativeBsmPdr(int index)
Returns the cumulative BSM Packet Delivery Ratio (PDR) which is the percent of cumulative expected pa...
A base class which provides memory management and object aggregation.
Definition: object.h:87
static TypeId GetTypeId(void)
Register this type.
a unique identifier for an interface.
Definition: type-id.h:58