A Discrete-Event Network Simulator
API
animation-interface.h
Go to the documentation of this file.
1/*
2 * This program is free software; you can redistribute it and/or modify
3 * it under the terms of the GNU General Public License version 2 as
4 * published by the Free Software Foundation;
5 *
6 * This program is distributed in the hope that it will be useful,
7 * but WITHOUT ANY WARRANTY; without even the implied warranty of
8 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9 * GNU General Public License for more details.
10 *
11 * You should have received a copy of the GNU General Public License
12 * along with this program; if not, write to the Free Software
13 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
14 *
15 * Author: George F. Riley<riley@ece.gatech.edu>
16 * Author: John Abraham <john.abraham@gatech.edu>
17 * Contributions: Eugene Kalishenko <ydginster@gmail.com> (Open Source and Linux Laboratory
18 * http://dev.osll.ru/)
19 */
20
21// Interface between ns3 and the network animator
22
23#ifndef ANIMATION_INTERFACE__H
24#define ANIMATION_INTERFACE__H
25
26#include "ns3/config.h"
27#include "ns3/ipv4-l3-protocol.h"
28#include "ns3/ipv4.h"
29#include "ns3/log.h"
30#include "ns3/lte-enb-net-device.h"
31#include "ns3/lte-ue-net-device.h"
32#include "ns3/mac48-address.h"
33#include "ns3/net-device.h"
34#include "ns3/node-container.h"
35#include "ns3/node-list.h"
36#include "ns3/nstime.h"
37#include "ns3/ptr.h"
38#include "ns3/random-variable-stream.h"
39#include "ns3/rectangle.h"
40#include "ns3/simulator.h"
41#include "ns3/uan-phy-gen.h"
42#include "ns3/wifi-phy.h"
43
44#include <cstdio>
45#include <map>
46#include <string>
47
48namespace ns3
49{
50
51#define MAX_PKTS_PER_TRACE_FILE 100000
52#define PURGE_INTERVAL 5
53#define NETANIM_VERSION "netanim-3.108"
54#define CHECK_STARTED_INTIMEWINDOW \
55 { \
56 if (!m_started || !IsInTimeWindow()) \
57 { \
58 return; \
59 } \
60 }
61#define CHECK_STARTED_INTIMEWINDOW_TRACKPACKETS \
62 { \
63 if (!m_started || !IsInTimeWindow() || !m_trackPackets) \
64 { \
65 return; \
66 } \
67 }
68
69struct NodeSize;
70class WifiPsdu;
71
88{
89 public:
95 AnimationInterface(const std::string filename);
96
100 typedef enum
101 {
105
111 typedef void (*AnimWriteCallback)(const char* str);
112
118
127 void EnableIpv4L3ProtocolCounters(Time startTime,
129 Time pollInterval = Seconds(1));
130
139 void EnableQueueCounters(Time startTime, Time stopTime, Time pollInterval = Seconds(1));
140
149 void EnableWifiMacCounters(Time startTime, Time stopTime, Time pollInterval = Seconds(1));
150
159 void EnableWifiPhyCounters(Time startTime, Time stopTime, Time pollInterval = Seconds(1));
160
172 AnimationInterface& EnableIpv4RouteTracking(std::string fileName,
173 Time startTime,
175 Time pollInterval = Seconds(5));
176
189 AnimationInterface& EnableIpv4RouteTracking(std::string fileName,
190 Time startTime,
192 NodeContainer nc,
193 Time pollInterval = Seconds(5));
194
201 static bool IsInitialized();
202
209 void SetStartTime(Time t);
210
217 void SetStopTime(Time t);
218
227 void SetMaxPktsPerTraceFile(uint64_t maxPktsPerFile);
228
238
246
252
261 static void SetConstantPosition(Ptr<Node> n, double x, double y, double z = 0);
262
269 void UpdateNodeDescription(Ptr<Node> n, std::string descr);
270
277 void UpdateNodeDescription(uint32_t nodeId, std::string descr);
278
285 void UpdateNodeImage(uint32_t nodeId, uint32_t resourceId);
286
294 void UpdateNodeSize(uint32_t nodeId, double width, double height);
295
304 void UpdateNodeColor(Ptr<Node> n, uint8_t r, uint8_t g, uint8_t b);
305
314 void UpdateNodeColor(uint32_t nodeId, uint8_t r, uint8_t g, uint8_t b);
315
323 void UpdateNodeCounter(uint32_t nodeCounterId, uint32_t nodeId, double counter);
324
336 void SetBackgroundImage(std::string fileName,
337 double x,
338 double y,
339 double scaleX,
340 double scaleY,
341 double opacity);
342
350 void UpdateLinkDescription(uint32_t fromNode, uint32_t toNode, std::string linkDescription);
351
359 void UpdateLinkDescription(Ptr<Node> fromNode, Ptr<Node> toNode, std::string linkDescription);
360
369 std::string destinationIpv4Address);
370
376 bool IsStarted();
377
382 void SkipPacketTracing();
383
391 void EnablePacketMetadata(bool enable = true);
392
399 uint64_t GetTracePktCount();
400
409 uint32_t AddNodeCounter(std::string counterName, CounterType counterType);
410
418 uint32_t AddResource(std::string resourcePath);
419
427 double GetNodeEnergyFraction(Ptr<const Node> node) const;
428
429 private:
434
435 {
436 public:
443 AnimPacketInfo(const AnimPacketInfo& pInfo);
451 AnimPacketInfo(Ptr<const NetDevice> tx_nd, const Time fbTx, uint32_t txNodeId = 0);
454 double m_fbTx;
455 double m_lbTx;
456 double m_fbRx;
457 double m_lbRx;
464 void ProcessRxBegin(Ptr<const NetDevice> nd, const double fbRx);
465 };
466
468 typedef struct
469 {
470 uint8_t r;
471 uint8_t g;
472 uint8_t b;
473 } Rgb;
474
476 typedef struct
477 {
481
483 typedef struct
484 {
486 std::string toNodeDescription;
487 std::string linkDescription;
489
492 {
501 {
502 // Check if they are the same node pairs but flipped
503 if (((first.fromNode == second.fromNode) && (first.toNode == second.toNode)) ||
504 ((first.fromNode == second.toNode) && (first.toNode == second.fromNode)))
505 {
506 return false;
507 }
508 std::ostringstream oss1;
509 oss1 << first.fromNode << first.toNode;
510 std::ostringstream oss2;
511 oss2 << second.fromNode << second.toNode;
512 return oss1.str() < oss2.str();
513 }
514 };
515
517 typedef struct
518 {
519 std::string destination;
522
524 typedef struct
525 {
527 std::string nextHop;
529
531 typedef enum
532 {
539 WAVE
541
543 typedef struct
544 {
545 double width;
546 double height;
547 } NodeSize;
548
549 typedef std::map<P2pLinkNodeIdPair, LinkProperties, LinkPairCompare>
551 typedef std::map<uint32_t, std::string> NodeDescriptionsMap;
552 typedef std::map<uint32_t, Rgb> NodeColorsMap;
553 typedef std::map<uint64_t, AnimPacketInfo>
555 typedef std::map<uint32_t, double> EnergyFractionMap;
556 typedef std::vector<Ipv4RoutePathElement>
558 typedef std::multimap<uint32_t, std::string> NodeIdIpv4Map;
559 typedef std::multimap<uint32_t, std::string> NodeIdIpv6Map;
560 typedef std::pair<uint32_t, std::string> NodeIdIpv4Pair;
561 typedef std::pair<uint32_t, std::string> NodeIdIpv6Pair;
562
563 // Node Counters
564 typedef std::map<uint32_t, uint64_t> NodeCounterMap64;
565
568 {
569 public:
576 AnimXmlElement(std::string tagName, bool emptyElement = true);
577 template <typename T>
584 void AddAttribute(std::string attribute, T value, bool xmlEscape = false);
589 void SetText(std::string text);
600 std::string ToString(bool autoClose = true);
601
602 private:
603 std::string m_tagName;
604 std::string m_text;
605 std::vector<std::string> m_attributes;
606 std::vector<std::string> m_children;
607 };
608
609 // ##### State #####
610
611 FILE* m_f;
614 std::string m_outputFileName;
615 uint64_t gAnimUid;
622 std::string m_originalFileName;
624 std::string m_routingFileName;
637
638 // Counter ID
640
644
648
653
656
664
665 std::map<uint32_t, Vector> m_nodeLocation;
666 std::map<std::string, uint32_t> m_macToNodeIdMap;
667 std::map<std::string, uint32_t> m_ipv4ToNodeIdMap;
668 std::map<std::string, uint32_t> m_ipv6ToNodeIdMap;
671
677 std::vector<Ipv4RouteTrackElement> m_ipv4RouteTrackElements;
678 std::map<uint32_t, NodeSize> m_nodeSizes;
679 std::vector<std::string> m_resources;
680 std::vector<std::string> m_nodeCounters;
681
682 /* Value-added custom counters */
699
705 const std::vector<std::string> GetElementsFromContext(const std::string& context) const;
711 Ptr<Node> GetNodeFromContext(const std::string& context) const;
717 Ptr<NetDevice> GetNetDeviceFromContext(std::string context);
718
719 // ##### General #####
725 void StartAnimation(bool restart = false);
732 void SetOutputFile(const std::string& fn, bool routing = false);
738 void StopAnimation(bool onlyAnimation = false);
744 std::string CounterTypeToString(CounterType counterType);
756 void AddByteTag(uint64_t animUid, Ptr<const Packet> p);
764 int WriteN(const char* data, uint32_t count, FILE* f);
771 int WriteN(const std::string& st, FILE* f);
777 std::string GetMacAddress(Ptr<NetDevice> nd);
783 std::string GetIpv4Address(Ptr<NetDevice> nd);
789 std::string GetIpv6Address(Ptr<NetDevice> nd);
795 std::vector<std::string> GetIpv4Addresses(Ptr<NetDevice> nd);
801 std::vector<std::string> GetIpv6Addresses(Ptr<NetDevice> nd);
802
807 std::string GetNetAnimVersion();
809 void MobilityAutoCheck();
816 bool IsPacketPending(uint64_t animUid, ProtocolType protocolType);
821 void PurgePendingPackets(ProtocolType protocolType);
833 std::string ProtocolTypeToString(ProtocolType protocolType);
840 void AddPendingPacket(ProtocolType protocolType, uint64_t animUid, AnimPacketInfo pktInfo);
852 void AddToIpv4AddressNodeIdTable(std::string ipv4Address, uint32_t nodeId);
858 void AddToIpv4AddressNodeIdTable(std::vector<std::string> ipv4Addresses, uint32_t nodeId);
864 void AddToIpv6AddressNodeIdTable(std::string ipv6Address, uint32_t nodeId);
870 void AddToIpv6AddressNodeIdTable(std::vector<std::string> ipv6Addresses, uint32_t nodeId);
875 bool IsInTimeWindow();
878
886 void TrackQueueCounters();
887 // ##### Routing #####
889 void TrackIpv4Route();
891 void TrackIpv4RoutePaths();
897 std::string GetIpv4RoutingTable(Ptr<Node> n);
904 void RecursiveIpv4RoutePathSearch(std::string from,
905 std::string to,
906 Ipv4RoutePathElements& rpElements);
913 void WriteRoutePath(uint32_t nodeId, std::string destination, Ipv4RoutePathElements rpElements);
914
915 // ##### Trace #####
921 void EnqueueTrace(std::string context, Ptr<const Packet>);
927 void DequeueTrace(std::string context, Ptr<const Packet>);
933 void QueueDropTrace(std::string context, Ptr<const Packet>);
941 void Ipv4TxTrace(std::string context,
943 Ptr<Ipv4> ipv4,
944 uint32_t interfaceIndex);
952 void Ipv4RxTrace(std::string context,
954 Ptr<Ipv4> ipv4,
955 uint32_t interfaceIndex);
965 void Ipv4DropTrace(std::string context,
966 const Ipv4Header& ipv4Header,
969 Ptr<Ipv4> ipv4,
970 uint32_t interfaceIndex);
971
977 void WifiMacTxTrace(std::string context, Ptr<const Packet> p);
983 void WifiMacTxDropTrace(std::string context, Ptr<const Packet> p);
989 void WifiMacRxTrace(std::string context, Ptr<const Packet> p);
995 void WifiMacRxDropTrace(std::string context, Ptr<const Packet> p);
1001 void WifiPhyTxDropTrace(std::string context, Ptr<const Packet> p);
1008 void WifiPhyRxDropTrace(std::string context,
1010 WifiPhyRxfailureReason reason);
1016 void LrWpanMacTxTrace(std::string context, Ptr<const Packet> p);
1022 void LrWpanMacTxDropTrace(std::string context, Ptr<const Packet> p);
1028 void LrWpanMacRxTrace(std::string context, Ptr<const Packet> p);
1034 void LrWpanMacRxDropTrace(std::string context, Ptr<const Packet> p);
1044 void DevTxTrace(std::string context,
1046 Ptr<NetDevice> tx,
1047 Ptr<NetDevice> rx,
1048 Time txTime,
1049 Time rxTime);
1057 void WifiPhyTxBeginTrace(std::string context,
1058 WifiConstPsduMap psduMap,
1059 WifiTxVector txVector,
1060 double txPowerW);
1068 void WifiPhyRxBeginTrace(std::string context,
1070 RxPowerWattPerChannelBand rxPowersW);
1076 void WavePhyTxBeginTrace(std::string context, Ptr<const Packet> p);
1083 void WavePhyRxBeginTrace(std::string context, Ptr<const Packet> p);
1090 void LrWpanPhyTxBeginTrace(std::string context, Ptr<const Packet> p);
1097 void LrWpanPhyRxBeginTrace(std::string context, Ptr<const Packet> p);
1104 void WimaxTxTrace(std::string context, Ptr<const Packet> p, const Mac48Address& m);
1111 void WimaxRxTrace(std::string context, Ptr<const Packet> p, const Mac48Address& m);
1117 void CsmaPhyTxBeginTrace(std::string context, Ptr<const Packet> p);
1124 void CsmaPhyTxEndTrace(std::string context, Ptr<const Packet> p);
1131 void CsmaPhyRxEndTrace(std::string context, Ptr<const Packet> p);
1138 void CsmaMacRxTrace(std::string context, Ptr<const Packet> p);
1145 void LteTxTrace(std::string context, Ptr<const Packet> p, const Mac48Address& m);
1152 void LteRxTrace(std::string context, Ptr<const Packet> p, const Mac48Address& m);
1158 void LteSpectrumPhyTxStart(std::string context, Ptr<const PacketBurst> pb);
1164 void LteSpectrumPhyRxStart(std::string context, Ptr<const PacketBurst> pb);
1170 void UanPhyGenTxTrace(std::string context, Ptr<const Packet>);
1176 void UanPhyGenRxTrace(std::string context, Ptr<const Packet>);
1183 void RemainingEnergyTrace(std::string context, double previousEnergy, double currentEnergy);
1190 void GenericWirelessTxTrace(std::string context,
1192 ProtocolType protocolType);
1199 void GenericWirelessRxTrace(std::string context,
1201 ProtocolType protocolType);
1202
1204 void ConnectCallbacks();
1206 void ConnectLte();
1213 void ConnectLteUe(Ptr<Node> n, Ptr<LteUeNetDevice> nd, uint32_t devIndex);
1221
1222 // ##### Mobility #####
1228 Vector GetPosition(Ptr<Node> n);
1234 Vector UpdatePosition(Ptr<Node> n);
1241 Vector UpdatePosition(Ptr<Node> n, Vector v);
1247 Vector UpdatePosition(Ptr<NetDevice> ndev);
1254 bool NodeHasMoved(Ptr<Node> n, Vector newLocation);
1259 std::vector<Ptr<Node>> GetMovedNodes();
1265
1266 // ##### XML Helpers #####
1267
1274 void WriteNonP2pLinkProperties(uint32_t id, std::string ipv4Address, std::string channelType);
1286 void OutputWirelessPacketTxInfo(Ptr<const Packet> p, AnimPacketInfo& pktInfo, uint64_t animUid);
1293 void OutputWirelessPacketRxInfo(Ptr<const Packet> p, AnimPacketInfo& pktInfo, uint64_t animUid);
1301 void WriteLinkProperties();
1303 void WriteIpv4Addresses();
1305 void WriteIpv6Addresses();
1307 void WriteNodes();
1309 void WriteNodeColors();
1311 void WriteNodeSizes();
1313 void WriteNodeEnergies();
1318 void WriteXmlAnim(bool routing = false);
1325 void WriteXmlUpdateNodePosition(uint32_t nodeId, double x, double y);
1333 void WriteXmlUpdateNodeColor(uint32_t nodeId, uint8_t r, uint8_t g, uint8_t b);
1345 void WriteXmlUpdateNodeSize(uint32_t nodeId, double width, double height);
1351 void WriteXmlAddResource(uint32_t resourceId, std::string resourcePath);
1358 void WriteXmlAddNodeCounter(uint32_t counterId,
1359 std::string counterName,
1360 CounterType counterType);
1366 void WriteXmlUpdateNodeImage(uint32_t nodeId, uint32_t resourceId);
1373 void WriteXmlUpdateNodeCounter(uint32_t counterId, uint32_t nodeId, double value);
1381 void WriteXmlNode(uint32_t id, uint32_t sysId, double locX, double locY);
1388 void WriteXmlLink(uint32_t fromId, uint32_t toLp, uint32_t toId);
1395 void WriteXmlUpdateLink(uint32_t fromId, uint32_t toId, std::string linkDescription);
1407 void WriteXmlP(std::string pktType,
1408 uint32_t fId,
1409 double fbTx,
1410 double lbTx,
1411 uint32_t tId,
1412 double fbRx,
1413 double lbRx,
1414 std::string metaInfo = "");
1423 void WriteXmlP(uint64_t animUid, std::string pktType, uint32_t fId, double fbTx, double lbTx);
1431 void WriteXmlPRef(uint64_t animUid, uint32_t fId, double fbTx, std::string metaInfo = "");
1437 void WriteXmlClose(std::string name, bool routing = false);
1444 void WriteXmlNonP2pLinkProperties(uint32_t id, std::string ipAddress, std::string channelType);
1450 void WriteXmlRouting(uint32_t id, std::string routingInfo);
1457 void WriteXmlRp(uint32_t nodeId, std::string destination, Ipv4RoutePathElements rpElements);
1467 void WriteXmlUpdateBackground(std::string fileName,
1468 double x,
1469 double y,
1470 double scaleX,
1471 double scaleY,
1472 double opacity);
1478 void WriteXmlIpv4Addresses(uint32_t nodeId, std::vector<std::string> ipv4Addresses);
1484 void WriteXmlIpv6Addresses(uint32_t nodeId, std::vector<std::string> ipv6Addresses);
1485};
1486
1498class AnimByteTag : public Tag
1499{
1500 public:
1506 static TypeId GetTypeId();
1507
1513 TypeId GetInstanceTypeId() const override;
1514
1520 uint32_t GetSerializedSize() const override;
1521
1527 void Serialize(TagBuffer i) const override;
1528
1534 void Deserialize(TagBuffer i) override;
1535
1541 void Print(std::ostream& os) const override;
1542
1548 void Set(uint64_t AnimUid);
1549
1555 uint64_t Get() const;
1556
1557 private:
1558 uint64_t m_AnimUid;
1559};
1560
1561} // namespace ns3
1562#endif
double f(double x, void *params)
Definition: 80211b.c:71
Byte tag using by Anim to uniquely identify packets.
TypeId GetInstanceTypeId() const override
Get Instance Type Id.
void Serialize(TagBuffer i) const override
Serialize function.
void Print(std::ostream &os) const override
Print tag info.
uint32_t GetSerializedSize() const override
Get Serialized Size.
uint64_t Get() const
Get Uid in tag.
static TypeId GetTypeId()
Get Type Id.
void Deserialize(TagBuffer i) override
Deserialize function.
uint64_t m_AnimUid
the UID
void Set(uint64_t AnimUid)
Set global Uid in tag.
Ptr< const NetDevice > m_txnd
transmit device
void ProcessRxBegin(Ptr< const NetDevice > nd, const double fbRx)
Process receive begin.
Ptr< const NetDevice > m_rxnd
receive device
void AppendChild(AnimXmlElement e)
Append child function.
std::vector< std::string > m_children
list of children
void SetText(std::string text)
Set text function.
std::vector< std::string > m_attributes
list of attributes
std::string ToString(bool autoClose=true)
Get text for the element function.
AnimXmlElement(std::string tagName, bool emptyElement=true)
Constructor.
void AddAttribute(std::string attribute, T value, bool xmlEscape=false)
Add attribute function.
Interface to network animator.
FILE * m_f
File handle for output (0 if none)
Time m_wifiMacCountersPollInterval
wifi MAC counters poll interval
void CsmaPhyRxEndTrace(std::string context, Ptr< const Packet > p)
CSMA Phy receive end trace function.
void WriteNodeSizes()
Write node sizes function.
uint32_t AddNodeCounter(std::string counterName, CounterType counterType)
Setup a node counter.
void TrackQueueCounters()
Track queue counters function.
void SetMobilityPollInterval(Time t)
Set mobility poll interval:WARNING: setting a low interval can cause slowness.
uint32_t m_wifiMacRxCounterId
wifi MAC receive counter ID
bool IsPacketPending(uint64_t animUid, ProtocolType protocolType)
Is packet pending function.
bool NodeHasMoved(Ptr< Node > n, Vector newLocation)
Node has moved function.
void LrWpanPhyTxBeginTrace(std::string context, Ptr< const Packet > p)
LR-WPAN Phy receive begin trace function.
uint32_t m_queueDropCounterId
queue drop counter ID
void WimaxTxTrace(std::string context, Ptr< const Packet > p, const Mac48Address &m)
WIMax transmit trace function.
void LrWpanPhyRxBeginTrace(std::string context, Ptr< const Packet > p)
LR-WPAN Phy receive begin trace function.
Time m_routingPollInterval
routing poll interval
void OutputCsmaPacket(Ptr< const Packet > p, AnimPacketInfo &pktInfo)
Output CSMA packet function.
uint64_t GetAnimUidFromPacket(Ptr< const Packet >)
Get anim UID from packet function.
EnergyFractionMap m_nodeEnergyFraction
node energy fraction
AnimUidPacketInfoMap m_pendingWavePackets
pending WAVE packets
void GenericWirelessTxTrace(std::string context, Ptr< const Packet > p, ProtocolType protocolType)
Generic wireless transmit trace function.
std::map< uint32_t, Rgb > NodeColorsMap
NodeColorsMap typedef.
void LteRxTrace(std::string context, Ptr< const Packet > p, const Mac48Address &m)
LTE receive trace function.
std::string ProtocolTypeToString(ProtocolType protocolType)
Protocol type to string function.
NodeCounterMap64 m_nodeLrWpanMacRx
node LR-WPAN MAC receive
std::string m_routingFileName
routing file name
NodeCounterMap64 m_nodeIpv4Tx
node IPv4 transmit
std::map< std::string, uint32_t > m_ipv6ToNodeIdMap
IPv6 to node ID map.
void MobilityAutoCheck()
Mobility auto check function.
void WriteXmlRouting(uint32_t id, std::string routingInfo)
Write XML routing function.
void WifiPhyRxDropTrace(std::string context, Ptr< const Packet > p, WifiPhyRxfailureReason reason)
wifi Phy receive drop trace function
void WifiMacRxDropTrace(std::string context, Ptr< const Packet > p)
wifi MAC receive drop trace function
NodeCounterMap64 m_nodeQueueDrop
node queue drop
void ConnectLteUe(Ptr< Node > n, Ptr< LteUeNetDevice > nd, uint32_t devIndex)
Connect LTE ue function.
void DequeueTrace(std::string context, Ptr< const Packet >)
Dequeue trace function.
void ConnectCallbacks()
Connect callbacks function.
void WriteRoutePath(uint32_t nodeId, std::string destination, Ipv4RoutePathElements rpElements)
Write route path function.
AnimUidPacketInfoMap * ProtocolTypeToPendingPackets(ProtocolType protocolType)
Protocol type to pending packets function.
void RemainingEnergyTrace(std::string context, double previousEnergy, double currentEnergy)
Remaining energy trace function.
void Ipv4DropTrace(std::string context, const Ipv4Header &ipv4Header, Ptr< const Packet > p, Ipv4L3Protocol::DropReason dropReason, Ptr< Ipv4 > ipv4, uint32_t interfaceIndex)
IPv4 drop trace function.
NodeColorsMap m_nodeColors
node colors
std::multimap< uint32_t, std::string > NodeIdIpv6Map
NodeIdIpv6Map typedef.
void UpdateNodeCounter(uint32_t nodeCounterId, uint32_t nodeId, double counter)
Helper function to update a node's counter referenced by the nodeCounterId.
void WifiPhyRxBeginTrace(std::string context, Ptr< const Packet > p, RxPowerWattPerChannelBand rxPowersW)
wifi Phy receive begin trace function
void LrWpanMacRxDropTrace(std::string context, Ptr< const Packet > p)
LR-WPAN MAC receive drop trace function.
void LteSpectrumPhyTxStart(std::string context, Ptr< const PacketBurst > pb)
LTE Spectrum Phy transmit start function.
NodeCounterMap64 m_nodeLrWpanMacTx
node LR-WPAN MAC transmit
void WriteXmlAddNodeCounter(uint32_t counterId, std::string counterName, CounterType counterType)
Write XML add node counter function.
void WriteXmlPRef(uint64_t animUid, uint32_t fId, double fbTx, std::string metaInfo="")
Write XMLP Ref function.
NodeCounterMap64 m_nodeWifiPhyTxDrop
node wifi Phy transmit drop
void WriteLinkProperties()
Write link properties function.
void WriteIpv4Addresses()
Write IPv4 Addresses function.
const std::vector< std::string > GetElementsFromContext(const std::string &context) const
Get elements from context.
void WriteXmlAddResource(uint32_t resourceId, std::string resourcePath)
Write XML add resource function.
void OutputWirelessPacketTxInfo(Ptr< const Packet > p, AnimPacketInfo &pktInfo, uint64_t animUid)
Output wireless packet transmit info.
void LteSpectrumPhyRxStart(std::string context, Ptr< const PacketBurst > pb)
LTE Spectrum Phy receive start function.
void SetOutputFile(const std::string &fn, bool routing=false)
Set output file function.
NodeCounterMap64 m_nodeWifiMacTx
node wifi MAC transmit
std::map< uint32_t, std::string > NodeDescriptionsMap
NodeDescriptionsMap typedef.
AnimUidPacketInfoMap m_pendingWimaxPackets
pending wimax packets
void LteTxTrace(std::string context, Ptr< const Packet > p, const Mac48Address &m)
LTE transmit trace function.
void EnableIpv4L3ProtocolCounters(Time startTime, Time stopTime, Time pollInterval=Seconds(1))
Enable tracking of Ipv4 L3 Protocol Counters such as Tx, Rx, Drop.
int WriteN(const char *data, uint32_t count, FILE *f)
WriteN function.
std::map< std::string, uint32_t > m_macToNodeIdMap
MAC to node ID map.
Ptr< Node > GetNodeFromContext(const std::string &context) const
Get node from context.
std::map< uint32_t, Vector > m_nodeLocation
node location
Ptr< NetDevice > GetNetDeviceFromContext(std::string context)
Get net device from context.
FILE * m_routingF
File handle for routing table output (0 if None);.
void UpdateNodeImage(uint32_t nodeId, uint32_t resourceId)
Helper function to update the image of a node.
void TrackWifiPhyCounters()
Track wifi phy counters function.
void WavePhyTxBeginTrace(std::string context, Ptr< const Packet > p)
WAVE Phy transmit begin trace function.
AnimUidPacketInfoMap m_pendingUanPackets
pending UAN packets
void TrackIpv4RoutePaths()
Track IPv4 route paths function.
double GetNodeEnergyFraction(Ptr< const Node > node) const
Get node's energy fraction (This used only for testing)
bool IsInTimeWindow()
Is in time window function.
void CsmaPhyTxBeginTrace(std::string context, Ptr< const Packet > p)
CSMA Phy transmit begin trace function.
bool m_enablePacketMetadata
enable packet metadata
void PurgePendingPackets(ProtocolType protocolType)
Purge pending packets function.
void SetMaxPktsPerTraceFile(uint64_t maxPktsPerFile)
Set Max packets per trace file.
uint64_t m_maxPktsPerFile
maximum pakets per file
uint32_t m_ipv4L3ProtocolRxCounterId
IPv4 L3 protocol receive counter ID.
NodeCounterMap64 m_nodeIpv4Rx
node IPv4 receive
~AnimationInterface()
Destructor for the animator interface.
void AddToIpv4AddressNodeIdTable(std::string ipv4Address, uint32_t nodeId)
Add to IPv4 address node ID table function.
NodeIdIpv4Map m_nodeIdIpv4Map
node ID to IPv4 map
Time m_queueCountersPollInterval
queue counters poll interval
std::map< P2pLinkNodeIdPair, LinkProperties, LinkPairCompare > LinkPropertiesMap
LinkPropertiesMap typedef.
std::vector< std::string > GetIpv6Addresses(Ptr< NetDevice > nd)
Get IPv6 addresses.
void UpdateLinkDescription(uint32_t fromNode, uint32_t toNode, std::string linkDescription)
Helper function to update the description for a link.
void Ipv4RxTrace(std::string context, Ptr< const Packet > p, Ptr< Ipv4 > ipv4, uint32_t interfaceIndex)
IPv4 receive trace function.
bool IsStarted()
Is AnimationInterface started.
NodeCounterMap64 m_nodeQueueEnqueue
node queue enqueue
void WriteXmlUpdateNodeCounter(uint32_t counterId, uint32_t nodeId, double value)
Write XML update node counter function.
std::vector< std::string > GetIpv4Addresses(Ptr< NetDevice > nd)
Get IPv4 addresses.
Time m_wifiPhyCountersPollInterval
wifi Phy counters poll interval
uint32_t m_queueDequeueCounterId
queue dequeue counter ID
NodeCounterMap64 m_nodeWifiMacRx
node wifi MAC receive
void AddToIpv6AddressNodeIdTable(std::string ipv6Address, uint32_t nodeId)
Add to IPv6 address node ID table function.
AnimationInterface & AddSourceDestination(uint32_t fromNodeId, std::string destinationIpv4Address)
Helper function to print the routing path from a source node to destination IP.
NodeCounterMap64 m_nodeIpv4Drop
node IPv4 drop
Time m_ipv4L3ProtocolCountersStopTime
IPv4 L3 protocol counters stop time.
uint32_t m_queueEnqueueCounterId
queue enqueue counter ID
void AddByteTag(uint64_t animUid, Ptr< const Packet > p)
Add byte tag function.
Time m_ipv4L3ProtocolCountersPollInterval
IPv4 L3 protocol counters poll interval.
void WriteNonP2pLinkProperties(uint32_t id, std::string ipv4Address, std::string channelType)
Write non P2P link properties function.
void StopAnimation(bool onlyAnimation=false)
Stop animation function.
std::vector< Ipv4RoutePathElement > Ipv4RoutePathElements
Ipv4RoutePathElements typedef.
void UanPhyGenTxTrace(std::string context, Ptr< const Packet >)
UAN Phy gen transmit trace function.
void WifiMacTxDropTrace(std::string context, Ptr< const Packet > p)
wifi MAC transmit drop trace function
uint32_t m_ipv4L3ProtocolTxCounterId
IPv4 L3 protocol transmit counter ID.
Time m_queueCountersStopTime
queue counters stop time
std::string CounterTypeToString(CounterType counterType)
Counter type to string function.
ProtocolType
ProtocolType enumeration.
std::string GetMacAddress(Ptr< NetDevice > nd)
Get MAC address function.
std::vector< Ptr< Node > > GetMovedNodes()
Get moved nodes function.
uint32_t m_wifiMacTxCounterId
wifi MAC transmit counter ID
void SkipPacketTracing()
Do not trace packets.
NodeCounterMap64 m_nodeWifiMacRxDrop
node wifi MAC receive drop
NodeDescriptionsMap m_nodeDescriptions
node description
void WriteXmlAnim(bool routing=false)
Write XML anim function.
std::map< uint32_t, double > EnergyFractionMap
EnergyFractionMap typedef.
void SetStartTime(Time t)
Specify the time at which capture should start.
uint32_t AddResource(std::string resourcePath)
Add a resource such as the path to an image file.
AnimationInterface(const std::string filename)
Constructor.
std::string GetIpv6Address(Ptr< NetDevice > nd)
Get IPv6 address.
void WriteNodeEnergies()
Write node energies function.
std::map< uint32_t, uint64_t > NodeCounterMap64
NodeCounterMap64 typedef.
static Rectangle * userBoundary
user boundary
void CsmaMacRxTrace(std::string context, Ptr< const Packet > p)
CSMA MAC receive trace function.
void WifiPhyTxBeginTrace(std::string context, WifiConstPsduMap psduMap, WifiTxVector txVector, double txPowerW)
wifi Phy transmit PSDU begin trace function
void UanPhyGenRxTrace(std::string context, Ptr< const Packet >)
UAN Phy gen receive trace function.
LinkPropertiesMap m_linkProperties
link properties
void WriteXmlUpdateNodeDescription(uint32_t nodeId)
Write XML update node description function.
std::map< uint32_t, NodeSize > m_nodeSizes
node sizes
std::pair< uint32_t, std::string > NodeIdIpv6Pair
NodeIdIpv6Pair typedef.
void(* AnimWriteCallback)(const char *str)
typedef for WriteCallBack used for listening to AnimationInterface write messages
void ConnectLte()
Connect LTE function.
bool m_trackPackets
track packets
std::string GetNetAnimVersion()
Get netanim version function.
void WriteXmlNonP2pLinkProperties(uint32_t id, std::string ipAddress, std::string channelType)
Write XML non P2P link properties function.
void UpdateNodeSize(uint32_t nodeId, double width, double height)
Helper function to update the size of a node.
AnimationInterface & EnableIpv4RouteTracking(std::string fileName, Time startTime, Time stopTime, Time pollInterval=Seconds(5))
Enable tracking of the Ipv4 routing table for all Nodes.
void WriteXmlClose(std::string name, bool routing=false)
Write XML close function.
uint64_t gAnimUid
Packet unique identifier used by AnimationInterface.
void CheckMaxPktsPerTraceFile()
Check maximum packets per trace file function.
NodeCounterMap64 m_nodeLrWpanMacTxDrop
node LR-WPAN MAC transmit drop
NodeIdIpv6Map m_nodeIdIpv6Map
node ID to IPv6 map
void TrackIpv4Route()
Track IPv4 router function.
void EnableWifiPhyCounters(Time startTime, Time stopTime, Time pollInterval=Seconds(1))
Enable tracking of Wifi Phy Counters such as TxDrop, RxDrop.
AnimUidPacketInfoMap m_pendingWifiPackets
pending wifi packets
void EnablePacketMetadata(bool enable=true)
Enable Packet metadata.
Time m_routingStopTime
routing stop time
void SetStopTime(Time t)
Specify the time at which capture should stop.
void MobilityCourseChangeTrace(Ptr< const MobilityModel > mob)
Mobility course change trace function.
void EnableWifiMacCounters(Time startTime, Time stopTime, Time pollInterval=Seconds(1))
Enable tracking of Wifi Mac Counters such as Tx, TxDrop, Rx, RxDrop.
void WriteXmlP(std::string pktType, uint32_t fId, double fbTx, double lbTx, uint32_t tId, double fbRx, double lbRx, std::string metaInfo="")
Write XMLP function.
uint32_t m_wifiMacTxDropCounterId
wifi MAC transmit drop counter ID
void WriteXmlRp(uint32_t nodeId, std::string destination, Ipv4RoutePathElements rpElements)
Write XMLRP function.
AnimUidPacketInfoMap m_pendingLrWpanPackets
pending LR-WPAN packets
void WifiMacTxTrace(std::string context, Ptr< const Packet > p)
wifi MAC transmit trace function
void ResetAnimWriteCallback()
Reset the write callback function.
void WimaxRxTrace(std::string context, Ptr< const Packet > p, const Mac48Address &m)
WIMax receive trace function.
void LrWpanMacTxDropTrace(std::string context, Ptr< const Packet > p)
LR-WPAN MAC transmit drop trace function.
void LrWpanMacRxTrace(std::string context, Ptr< const Packet > p)
LR-WPAN MAC receive trace function.
uint64_t GetTracePktCount()
Get trace file packet count (This used only for testing)
std::vector< std::string > m_nodeCounters
node counters
void WriteXmlNode(uint32_t id, uint32_t sysId, double locX, double locY)
Write XML node function.
AnimWriteCallback m_writeCallback
write callback
NodeCounterMap64 m_nodeWifiMacTxDrop
node wifi MAC transmit drop
uint64_t m_currentPktCount
current packet count
std::string GetIpv4RoutingTable(Ptr< Node > n)
Get IPv4 routing table function.
void Ipv4TxTrace(std::string context, Ptr< const Packet > p, Ptr< Ipv4 > ipv4, uint32_t interfaceIndex)
IPv4 transmit trace function.
std::pair< uint32_t, std::string > NodeIdIpv4Pair
NodeIdIpv4Pair typedef.
void EnqueueTrace(std::string context, Ptr< const Packet >)
Enqueue trace function.
void WriteXmlUpdateNodeColor(uint32_t nodeId, uint8_t r, uint8_t g, uint8_t b)
Write XML update node color function.
Vector UpdatePosition(Ptr< Node > n)
Update position function.
std::string m_outputFileName
output file name
void WriteIpv6Addresses()
Write IPv6 Addresses function.
void AddPendingPacket(ProtocolType protocolType, uint64_t animUid, AnimPacketInfo pktInfo)
Add pending packet function.
NodeCounterMap64 m_nodeWifiPhyRxDrop
node wifi Phy receive drop
void WriteXmlIpv4Addresses(uint32_t nodeId, std::vector< std::string > ipv4Addresses)
Write XML Ipv4 addresses function.
Vector GetPosition(Ptr< Node > n)
Get position function.
AnimUidPacketInfoMap m_pendingLtePackets
pending LTE packets
void SetBackgroundImage(std::string fileName, double x, double y, double scaleX, double scaleY, double opacity)
Helper function to set the background image.
void WriteNodes()
Write nodes function.
NodeCounterMap64 m_nodeLrWpanMacRxDrop
node LR-WPAN MAC receive drop
Time m_wifiMacCountersStopTime
wifi MAC counters stop time
void WriteNodeColors()
Write node colors function.
void RecursiveIpv4RoutePathSearch(std::string from, std::string to, Ipv4RoutePathElements &rpElements)
Recursive IPv4 route path search function.
static bool IsInitialized()
Check if AnimationInterface is initialized.
void LrWpanMacTxTrace(std::string context, Ptr< const Packet > p)
LR-WPAN MAC transmit trace function.
void WriteXmlUpdateBackground(std::string fileName, double x, double y, double scaleX, double scaleY, double opacity)
Write XML update background function.
void CsmaPhyTxEndTrace(std::string context, Ptr< const Packet > p)
CSMA Phy transmit end trace function.
void WriteXmlUpdateNodeSize(uint32_t nodeId, double width, double height)
Write XML update node size function.
uint32_t m_remainingEnergyCounterId
remaining energy counter ID
void WriteXmlUpdateNodeImage(uint32_t nodeId, uint32_t resourceId)
Write XML update node image function.
uint32_t m_wifiMacRxDropCounterId
wifi MAC receive drop counter ID
void TrackWifiMacCounters()
Track wifi MAC counters function.
void WriteNodeUpdate(uint32_t nodeId)
Write node update function.
std::string m_originalFileName
original file name
void UpdateNodeDescription(Ptr< Node > n, std::string descr)
Helper function to update the description for a given node.
void UpdateNodeColor(Ptr< Node > n, uint8_t r, uint8_t g, uint8_t b)
Helper function to update the node color.
static void SetConstantPosition(Ptr< Node > n, double x, double y, double z=0)
Helper function to set Constant Position for a given node.
NodeCounterMap64 m_nodeQueueDequeue
node queue dequeue
void WifiPhyTxDropTrace(std::string context, Ptr< const Packet > p)
wifi Phy transmit drop trace function
uint32_t m_wifiPhyRxDropCounterId
wifi Phy receive drop counter ID
void WriteXmlUpdateLink(uint32_t fromId, uint32_t toId, std::string linkDescription)
Write XML update link counter function.
void ConnectLteEnb(Ptr< Node > n, Ptr< LteEnbNetDevice > nd, uint32_t devIndex)
Connect LTE ENB function.
void GenericWirelessRxTrace(std::string context, Ptr< const Packet > p, ProtocolType protocolType)
Generic wireless receive trace function.
std::string GetPacketMetadata(Ptr< const Packet > p)
Get packet metadata function.
uint32_t m_wifiPhyTxDropCounterId
wifi Phy transmit drop counter ID
std::vector< Ipv4RouteTrackElement > m_ipv4RouteTrackElements
IPv route track elements.
std::multimap< uint32_t, std::string > NodeIdIpv4Map
NodeIdIpv4Map typedef.
void EnableQueueCounters(Time startTime, Time stopTime, Time pollInterval=Seconds(1))
Enable tracking of Queue Counters such as Enqueue, Dequeue, Queue Drops.
uint32_t m_ipv4L3ProtocolDropCounterId
IPv4 protocol drop counter ID.
Time m_wifiPhyCountersStopTime
wifi Phy counters stop time
Time m_mobilityPollInterval
mobility poll interval
void OutputWirelessPacketRxInfo(Ptr< const Packet > p, AnimPacketInfo &pktInfo, uint64_t animUid)
Output wireless packet receive info.
std::map< std::string, uint32_t > m_ipv4ToNodeIdMap
IPv4 to node ID map.
AnimUidPacketInfoMap m_pendingCsmaPackets
pending CSMA packets
std::vector< std::string > m_resources
resources
void TrackIpv4L3ProtocolCounters()
Track IPv4 L3 protocol counters function.
void WriteXmlUpdateNodePosition(uint32_t nodeId, double x, double y)
Write XML update node position function.
void StartAnimation(bool restart=false)
Start animation function.
void DevTxTrace(std::string context, Ptr< const Packet > p, Ptr< NetDevice > tx, Ptr< NetDevice > rx, Time txTime, Time rxTime)
Device transmit trace function.
std::string GetIpv4Address(Ptr< NetDevice > nd)
Get IPv4 address.
void WavePhyRxBeginTrace(std::string context, Ptr< const Packet > p)
WAVE Phy receive begin trace function.
void WifiMacRxTrace(std::string context, Ptr< const Packet > p)
wifi MAC receive trace function
void WriteXmlIpv6Addresses(uint32_t nodeId, std::vector< std::string > ipv6Addresses)
Write XML Ipv6 addresses function.
NodeContainer m_routingNc
routing node container
void SetAnimWriteCallback(AnimWriteCallback cb)
Set a callback function to listen to AnimationInterface write events.
void QueueDropTrace(std::string context, Ptr< const Packet >)
Queue trace function.
void WriteXmlLink(uint32_t fromId, uint32_t toLp, uint32_t toId)
Write XML link counter function.
std::map< uint64_t, AnimPacketInfo > AnimUidPacketInfoMap
AnimUidPacketInfoMap typedef.
Packet header for IPv4.
Definition: ipv4-header.h:34
DropReason
Reason why a packet has been dropped.
an EUI-48 address
Definition: mac48-address.h:46
keep track of a set of node pointers.
a 2d rectangle
Definition: rectangle.h:35
read and write tag data
Definition: tag-buffer.h:52
tag a set of bytes in a packet
Definition: tag.h:39
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:105
a unique identifier for an interface.
Definition: type-id.h:60
This class mimics the TXVECTOR which is to be passed to the PHY in order to define the parameters whi...
Time stopTime
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1338
WifiPhyRxfailureReason
Enumeration of the possible reception failure reasons.
Definition: first.py:1
Every class exported by the ns3 library is enclosed in the ns3 namespace.
std::unordered_map< uint16_t, Ptr< const WifiPsdu > > WifiConstPsduMap
Map of const PSDUs indexed by STA-ID.
std::map< WifiSpectrumBand, double > RxPowerWattPerChannelBand
A map of the received power (Watts) for each band.
Definition: phy-entity.h:78
Definition: second.py:1
value
Definition: second.py:41
uint8_t data[writeSize]