wave-bsm-stats.h

Go to the documentation of this file.

/*
 * Copyright (c) 2014 North Carolina State University
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Author: Scott E. Carpenter <scarpen@ncsu.edu>
 *
 */
 
#ifndef WAVE_BSM_STATS_H
#define WAVE_BSM_STATS_H
 
#include "ns3/object.h"
 
#include <vector>
 
namespace ns3
{
class WaveBsmStats : public Object
{
  public:
    WaveBsmStats();
 
    static TypeId GetTypeId();
 
    void IncTxPktCount();
 
    int GetTxPktCount() const;
 
    /*
     * Note:
     * The WAVE Basic Safety Message (BSM) is broadcast and
     * unacknowledged. In order to calculate packet delivery
     * ratio (PDR), we must count i) the packets that are
     * actually received and ii) the transmitted packets that
     * are expected to be received.  Both are relative to a
     * specified (circular) coverage area.
     *
     * For example:  Say we have three nodes, A, B, and C, each
     * separated by 40m, as follows:
     *
     *    A --<40m>-- B --<40m>-- C
     *
     * Let's assume that the transmission range is 50m, and only
     * A is transmitting (i.e. broadcasting).  B can receive A's
     * broadcasts, while C cannot.  Let's assume no dropped packets.
     * If we set the coverage area to  100m, then the PDR is 50%,
     * because B receives every transmission from A, while C receives
     * none of them.  However, if we change the effective
     * coverage area to 75m then the PDR improves to 100%, because
     * B receives 100% of A's transmissions, and C is outside of the
     * coverage area, and so does not factor in to the PDR.
     */
 
    void IncExpectedRxPktCount(int index);
 
    void IncRxPktCount();
 
    void IncRxPktInRangeCount(int index);
 
    int GetRxPktCount() const;
 
    int GetExpectedRxPktCount(int index);
 
    int GetRxPktInRangeCount(int index);
 
    void SetExpectedRxPktCount(int index, int count);
 
    void SetRxPktInRangeCount(int index, int count);
 
    void ResetTotalRxPktCounts(int index);
 
    void SetTxPktCount(int count);
 
    void SetRxPktCount(int count);
 
    void IncTxByteCount(int bytes);
 
    int GetTxByteCount() const;
 
    double GetBsmPdr(int index);
 
    double GetCumulativeBsmPdr(int index);
 
    void SetLogging(bool log);
 
    bool GetLogging() const;
 
  private:
    int m_wavePktSendCount;                            
    int m_waveByteSendCount;                           
    int m_wavePktReceiveCount;                         
    std::vector<int> m_wavePktInCoverageReceiveCounts; 
    std::vector<int> m_wavePktExpectedReceiveCounts;   
    std::vector<int>
        m_waveTotalPktInCoverageReceiveCounts; 
    std::vector<int> m_waveTotalPktExpectedReceiveCounts; 
    bool m_log;                                           
};
 
} // namespace ns3
 
#endif /* WAVE_BSM_STATS_H*/