/usr/include/ns3/animation-interface-helper.h is in libns3-dev 3.13+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* 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: John Abraham <john.abraham@gatech.edu>
*/
// Animation Interface helpers
#ifndef _ANIMATION_INTERFACE_HELPER_H_
#define _ANIMATION_INTERFACE_HELPER_H_
#include "ns3/node.h"
#include "ns3/mobility-model.h"
#include "ns3/packet.h"
#include "ns3/simulator.h"
#include <vector>
#include <map>
namespace ns3 {
/**
* \ingroup netanim
*
* \brief AnimRxInfo helper class
*
* This helper class keeps of wireless packets received
* including info about the first bit received time,
* last bit received time and NetDevice received on
* It is intended only for use by the AnimationInterface
* class.
*
*/
class AnimRxInfo
{
public:
/**
* \brief Default constructor
*
*/
AnimRxInfo () {};
/**
* \brief Constructor
* \param fbRx First-bit Receive time
* \param nd NetDevice where packet was received
* \param rxRange Reception range
*
*/
AnimRxInfo (const Time& fbRx, Ptr <const NetDevice> nd ,double rxRange)
: m_fbRx (fbRx.GetSeconds ()), m_lbRx (0), m_rxnd (nd), rxRange (rxRange), m_PhyRxComplete (false){}
/**
* \brief First bit receive time
* \param m_fbRx First bit receive time
*
*/
double m_fbRx;
/**
* \brief Last bit receive time
* \param m_lbRx Last bit receive time
*
*/
double m_lbRx;
/**
* \brief Ptr to receiving NetDevice
* \param m_rxnd Ptr to receiving NetDevice
*
*/
Ptr <const NetDevice> m_rxnd;
/**
* \brief Reception range
* \param rxRange Reception range
*
*/
double rxRange;
/**
* \brief Check if Wifi Phy Rx is Complete
* \returns true if Wifi Phy Rx is complete
*
*/
bool IsPhyRxComplete ();
/**
* \brief Set Wifi Phy Rx Complete
*
*/
void SetPhyRxComplete ();
private:
bool m_PhyRxComplete;
};
/**
* \ingroup netanim
*
* \brief AnimPacketInfo helper class
*
* This helper class keeps of wireless packets transmitted and
* received
* including info about the last bit transmit time, first bit
* transmit time, location of the transmitter and
* NetDevice transmited on
* It is intended only for use by the AnimationInterface
* class.
*
*/
class AnimPacketInfo
{
public:
/**
* \brief Default constructor
*
*/
AnimPacketInfo ();
/**
* \brief Constructor
* \param tx_nd Ptr to NetDevice that is transmitting
* \param fbTx First bit transmit time
* \param lbTx Last bit transmit time
* \param txLoc Transmitter Location
*
*/
AnimPacketInfo(Ptr <const NetDevice> tx_nd, const Time& fbTx, const Time& lbTx,Vector txLoc);
/**
* \brief Ptr to NetDevice that is transmitting
* \param m_txnd NetDevice that is transmitting
*
*/
Ptr <const NetDevice> m_txnd;
/**
* \brief First bit transmission time
* \param m_fbTx First bit transmission time
*
*/
double m_fbTx;
/**
* \brief Last bit transmission time
* \param m_lbTx Last bit transmission time
*
*/
double m_lbTx;
/**
* \brief Transmitter's location
* \param m_txLoc Transmitter's Location
*
*/
Vector m_txLoc;
/**
* \brief Collection of receivers
* \param m_rx Collection of receivers
*
*/
std::map<uint32_t,AnimRxInfo> m_rx;
/**
* \brief Process RxBegin notifications
* \param nd Ptr to NetDevice where packet was received
* \param fbRx First bit receive time
*
*/
void ProcessRxBegin (Ptr <const NetDevice> nd, const Time& fbRx);
/**
* \brief Process RxEnd notifications
* \param nd Ptr to NetDevice where packet was received
* \param fbRx First bit receive time
* \param rxLoc Location of receiver
* \returns true if RxEnd notification was expected and processed
*
*/
bool ProcessRxEnd (Ptr <const NetDevice> nd, const Time& fbRx, Vector rxLoc);
/**
* \brief Process RxDrop notifications
* \param nd Ptr to NetDevice where packet was dropped on reception
*
*/
void ProcessRxDrop (Ptr <const NetDevice> nd);
/**
* \brief GetRxInfo
* \param nd Ptr to NetDevice where packet was received
* \returns AnimRxInfo object
*
*/
AnimRxInfo GetRxInfo (Ptr <const NetDevice> nd);
/**
* \brief RemoveRxInfo
* \param nd Ptr to NetDevice where packet was received
*
*/
void RemoveRxInfo (Ptr <const NetDevice> nd);
/**
* \brief Time delta between First bit Rx and Last bit Rx
* \param firstlastbitDelta Time delta between First bit Rx and Last bit Rx
*/
double firstlastbitDelta;
};
} // namespace ns3
#endif
|