A Discrete-Event Network Simulator
API
ns3::AnimationInterface Class Reference

Interface to network animator. More...

#include "animation-interface.h"

+ Collaboration diagram for ns3::AnimationInterface:

Classes

class  AnimPacketInfo
 AnimPacketInfo class. More...
 
class  AnimXmlElement
 AnimXmlElement class. More...
 
struct  Ipv4RoutePathElement
 Ipv4RoutePathElement structure. More...
 
struct  Ipv4RouteTrackElement
 Ipv4RouteTrackElement structure. More...
 
struct  LinkPairCompare
 LinkPairCompare structure. More...
 
struct  LinkProperties
 LinkProperties structure. More...
 
struct  NodeSize
 NodeSize structure. More...
 
struct  P2pLinkNodeIdPair
 P2pLinkNodeIdPair structure. More...
 
struct  Rgb
 RGB structure. More...
 

Public Types

typedef void(* AnimWriteCallback) (const char *str)
 typedef for WriteCallBack used for listening to AnimationInterface write messages More...
 
enum  CounterType { UINT32_COUNTER, DOUBLE_COUNTER }
 Counter Types. More...
 

Public Member Functions

 AnimationInterface (const std::string filename)
 Constructor. More...
 
 ~AnimationInterface ()
 Destructor for the animator interface. More...
 
uint32_t AddNodeCounter (std::string counterName, CounterType counterType)
 Setup a node counter. More...
 
uint32_t AddResource (std::string resourcePath)
 Add a resource such as the path to an image file. More...
 
AnimationInterfaceAddSourceDestination (uint32_t fromNodeId, std::string destinationIpv4Address)
 Helper function to print the routing path from a source node to destination IP. More...
 
void EnableIpv4L3ProtocolCounters (Time startTime, Time stopTime, Time pollInterval=Seconds(1))
 Enable tracking of Ipv4 L3 Protocol Counters such as Tx, Rx, Drop. More...
 
AnimationInterfaceEnableIpv4RouteTracking (std::string fileName, Time startTime, Time stopTime, Time pollInterval=Seconds(5))
 Enable tracking of the Ipv4 routing table for all Nodes. More...
 
AnimationInterfaceEnableIpv4RouteTracking (std::string fileName, Time startTime, Time stopTime, NodeContainer nc, Time pollInterval=Seconds(5))
 Enable tracking of the Ipv4 routing table for a set of Nodes. More...
 
void EnablePacketMetadata (bool enable=true)
 Enable Packet metadata. More...
 
void EnableQueueCounters (Time startTime, Time stopTime, Time pollInterval=Seconds(1))
 Enable tracking of Queue Counters such as Enqueue, Dequeue, Queue Drops. More...
 
void EnableWifiMacCounters (Time startTime, Time stopTime, Time pollInterval=Seconds(1))
 Enable tracking of Wifi Mac Counters such as Tx, TxDrop, Rx, RxDrop. More...
 
void EnableWifiPhyCounters (Time startTime, Time stopTime, Time pollInterval=Seconds(1))
 Enable tracking of Wifi Phy Counters such as TxDrop, RxDrop. More...
 
double GetNodeEnergyFraction (Ptr< const Node > node) const
 Get node's energy fraction (This used only for testing) More...
 
uint64_t GetTracePktCount ()
 Get trace file packet count (This used only for testing) More...
 
bool IsStarted (void)
 Is AnimationInterface started. More...
 
void ResetAnimWriteCallback ()
 Reset the write callback function. More...
 
void SetAnimWriteCallback (AnimWriteCallback cb)
 Set a callback function to listen to AnimationInterface write events. More...
 
void SetBackgroundImage (std::string fileName, double x, double y, double scaleX, double scaleY, double opacity)
 Helper function to set the background image. More...
 
void SetMaxPktsPerTraceFile (uint64_t maxPktsPerFile)
 Set Max packets per trace file. More...
 
void SetMobilityPollInterval (Time t)
 Set mobility poll interval:WARNING: setting a low interval can cause slowness. More...
 
void SetStartTime (Time t)
 Specify the time at which capture should start. More...
 
void SetStopTime (Time t)
 Specify the time at which capture should stop. More...
 
void SkipPacketTracing ()
 Do not trace packets. More...
 
void UpdateLinkDescription (uint32_t fromNode, uint32_t toNode, std::string linkDescription)
 Helper function to update the description for a link. More...
 
void UpdateLinkDescription (Ptr< Node > fromNode, Ptr< Node > toNode, std::string linkDescription)
 Helper function to update the description for a link. More...
 
void UpdateNodeColor (Ptr< Node > n, uint8_t r, uint8_t g, uint8_t b)
 Helper function to update the node color. More...
 
void UpdateNodeColor (uint32_t nodeId, uint8_t r, uint8_t g, uint8_t b)
 Helper function to update the node color. More...
 
void UpdateNodeCounter (uint32_t nodeCounterId, uint32_t nodeId, double counter)
 Helper function to update a node's counter referenced by the nodeCounterId. More...
 
void UpdateNodeDescription (Ptr< Node > n, std::string descr)
 Helper function to update the description for a given node. More...
 
void UpdateNodeDescription (uint32_t nodeId, std::string descr)
 Helper function to update the description for a given node. More...
 
void UpdateNodeImage (uint32_t nodeId, uint32_t resourceId)
 Helper function to update the image of a node. More...
 
void UpdateNodeSize (uint32_t nodeId, double width, double height)
 Helper function to update the size of a node. More...
 

Static Public Member Functions

static bool IsInitialized (void)
 Check if AnimationInterface is initialized. More...
 
static void SetConstantPosition (Ptr< Node > n, double x, double y, double z=0)
 Helper function to set Constant Position for a given node. More...
 

Private Types

typedef std::map< uint64_t, AnimPacketInfoAnimUidPacketInfoMap
 AnimUidPacketInfoMap typedef. More...
 
typedef std::map< uint32_t, double > EnergyFractionMap
 EnergyFractionMap typedef. More...
 
typedef std::vector< Ipv4RoutePathElementIpv4RoutePathElements
 Ipv4RoutePathElements typedef. More...
 
typedef std::map< P2pLinkNodeIdPair, LinkProperties, LinkPairCompareLinkPropertiesMap
 LinkPropertiesMap typedef. More...
 
typedef std::map< uint32_t, RgbNodeColorsMap
 NodeColorsMap typedef. More...
 
typedef std::map< uint32_t, uint64_t > NodeCounterMap64
 NodeCounterMap64 typedef. More...
 
typedef std::map< uint32_t, std::string > NodeDescriptionsMap
 NodeDescriptionsMap typedef. More...
 
typedef std::multimap< uint32_t, std::string > NodeIdIpv4Map
 NodeIdIpv4Map typedef. More...
 
typedef std::pair< uint32_t, std::string > NodeIdIpv4Pair
 NodeIdIpv4Pair typedef. More...
 
typedef std::multimap< uint32_t, std::string > NodeIdIpv6Map
 NodeIdIpv6Map typedef. More...
 
typedef std::pair< uint32_t, std::string > NodeIdIpv6Pair
 NodeIdIpv6Pair typedef. More...
 
enum  ProtocolType {
  UAN, LTE, WIFI, WIMAX,
  CSMA, LRWPAN, WAVE
}
 ProtocolType enumeration. More...
 

Private Member Functions

void AddByteTag (uint64_t animUid, Ptr< const Packet > p)
 Add byte tag function. More...
 
void AddPendingPacket (ProtocolType protocolType, uint64_t animUid, AnimPacketInfo pktInfo)
 Add pending packet function. More...
 
void AddToIpv4AddressNodeIdTable (std::string ipv4Address, uint32_t nodeId)
 Add to IPv4 address node ID table function. More...
 
void AddToIpv4AddressNodeIdTable (std::vector< std::string > ipv4Addresses, uint32_t nodeId)
 Add to IPv4 address node ID table function. More...
 
void AddToIpv6AddressNodeIdTable (std::string ipv6Address, uint32_t nodeId)
 Add to IPv6 address node ID table function. More...
 
void AddToIpv6AddressNodeIdTable (std::vector< std::string > ipv6Addresses, uint32_t nodeId)
 Add to IPv6 address node ID table function. More...
 
void CheckMaxPktsPerTraceFile ()
 Check maximum packets per trace file function. More...
 
void ConnectCallbacks ()
 Connect callbacks function. More...
 
void ConnectLte ()
 Connect LTE function. More...
 
void ConnectLteEnb (Ptr< Node > n, Ptr< LteEnbNetDevice > nd, uint32_t devIndex)
 Connect LTE ENB function. More...
 
void ConnectLteUe (Ptr< Node > n, Ptr< LteUeNetDevice > nd, uint32_t devIndex)
 Connect LTE ue function. More...
 
std::string CounterTypeToString (CounterType counterType)
 Counter type to string function. More...
 
void CsmaMacRxTrace (std::string context, Ptr< const Packet > p)
 CSMA MAC receive trace function. More...
 
void CsmaPhyRxEndTrace (std::string context, Ptr< const Packet > p)
 CSMA Phy receive end trace function. More...
 
void CsmaPhyTxBeginTrace (std::string context, Ptr< const Packet > p)
 CSMA Phy transmit begin trace function. More...
 
void CsmaPhyTxEndTrace (std::string context, Ptr< const Packet > p)
 CSMA Phy transmit end trace function. More...
 
void DequeueTrace (std::string context, Ptr< const Packet >)
 Dequeue trace function. More...
 
void DevTxTrace (std::string context, Ptr< const Packet > p, Ptr< NetDevice > tx, Ptr< NetDevice > rx, Time txTime, Time rxTime)
 Device transmit trace function. More...
 
void EnqueueTrace (std::string context, Ptr< const Packet >)
 Enqueue trace function. More...
 
void GenericWirelessRxTrace (std::string context, Ptr< const Packet > p, ProtocolType protocolType)
 Generic wireless receive trace function. More...
 
void GenericWirelessTxTrace (std::string context, Ptr< const Packet > p, ProtocolType protocolType)
 Generic wireless transmit trace function. More...
 
uint64_t GetAnimUidFromPacket (Ptr< const Packet >)
 Get anim UID from packet function. More...
 
const std::vector< std::string > GetElementsFromContext (const std::string &context) const
 Get elements from context. More...
 
std::string GetIpv4Address (Ptr< NetDevice > nd)
 Get IPv4 address. More...
 
std::vector< std::string > GetIpv4Addresses (Ptr< NetDevice > nd)
 Get IPv4 addresses. More...
 
std::string GetIpv4RoutingTable (Ptr< Node > n)
 Get IPv4 routing table function. More...
 
std::string GetIpv6Address (Ptr< NetDevice > nd)
 Get IPv6 address. More...
 
std::vector< std::string > GetIpv6Addresses (Ptr< NetDevice > nd)
 Get IPv6 addresses. More...
 
std::string GetMacAddress (Ptr< NetDevice > nd)
 Get MAC address function. More...
 
std::vector< Ptr< Node > > GetMovedNodes ()
 Get moved nodes function. More...
 
std::string GetNetAnimVersion ()
 Get netanim version function. More...
 
Ptr< NetDeviceGetNetDeviceFromContext (std::string context)
 Get net device from context. More...
 
Ptr< NodeGetNodeFromContext (const std::string &context) const
 Get node from context. More...
 
std::string GetPacketMetadata (Ptr< const Packet > p)
 Get packet metadata function. More...
 
Vector GetPosition (Ptr< Node > n)
 Get position function. More...
 
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. More...
 
void Ipv4RxTrace (std::string context, Ptr< const Packet > p, Ptr< Ipv4 > ipv4, uint32_t interfaceIndex)
 IPv4 receive trace function. More...
 
void Ipv4TxTrace (std::string context, Ptr< const Packet > p, Ptr< Ipv4 > ipv4, uint32_t interfaceIndex)
 IPv4 transmit trace function. More...
 
bool IsInTimeWindow ()
 Is in time window function. More...
 
bool IsPacketPending (uint64_t animUid, ProtocolType protocolType)
 Is packet pending function. More...
 
void LrWpanMacRxDropTrace (std::string context, Ptr< const Packet > p)
 LR-WPAN MAC receive drop trace function. More...
 
void LrWpanMacRxTrace (std::string context, Ptr< const Packet > p)
 LR-WPAN MAC receive trace function. More...
 
void LrWpanMacTxDropTrace (std::string context, Ptr< const Packet > p)
 LR-WPAN MAC transmit drop trace function. More...
 
void LrWpanMacTxTrace (std::string context, Ptr< const Packet > p)
 LR-WPAN MAC transmit trace function. More...
 
void LrWpanPhyRxBeginTrace (std::string context, Ptr< const Packet > p)
 LR-WPAN Phy receive begin trace function. More...
 
void LrWpanPhyTxBeginTrace (std::string context, Ptr< const Packet > p)
 LR-WPAN Phy receive begin trace function. More...
 
void LteRxTrace (std::string context, Ptr< const Packet > p, const Mac48Address &m)
 LTE receive trace function. More...
 
void LteSpectrumPhyRxStart (std::string context, Ptr< const PacketBurst > pb)
 LTE Spectrum Phy receive start function. More...
 
void LteSpectrumPhyTxStart (std::string context, Ptr< const PacketBurst > pb)
 LTE Spectrum Phy transmit start function. More...
 
void LteTxTrace (std::string context, Ptr< const Packet > p, const Mac48Address &m)
 LTE transmit trace function. More...
 
void MobilityAutoCheck ()
 Mobility auto check function. More...
 
void MobilityCourseChangeTrace (Ptr< const MobilityModel > mob)
 Mobility course change trace function. More...
 
bool NodeHasMoved (Ptr< Node > n, Vector newLocation)
 Node has moved function. More...
 
void OutputCsmaPacket (Ptr< const Packet > p, AnimPacketInfo &pktInfo)
 Output CSMA packet function. More...
 
void OutputWirelessPacketRxInfo (Ptr< const Packet > p, AnimPacketInfo &pktInfo, uint64_t animUid)
 Output wireless packet receive info. More...
 
void OutputWirelessPacketTxInfo (Ptr< const Packet > p, AnimPacketInfo &pktInfo, uint64_t animUid)
 Output wireless packet transmit info. More...
 
AnimUidPacketInfoMapProtocolTypeToPendingPackets (ProtocolType protocolType)
 Protocol type to pending packets function. More...
 
std::string ProtocolTypeToString (ProtocolType protocolType)
 Protocol type to string function. More...
 
void PurgePendingPackets (ProtocolType protocolType)
 Purge pending packets function. More...
 
void QueueDropTrace (std::string context, Ptr< const Packet >)
 Queue trace function. More...
 
void RecursiveIpv4RoutePathSearch (std::string from, std::string to, Ipv4RoutePathElements &rpElements)
 Recursive IPv4 route path search function. More...
 
void RemainingEnergyTrace (std::string context, double previousEnergy, double currentEnergy)
 Remaining energy trace function. More...
 
void SetOutputFile (const std::string &fn, bool routing=false)
 Set output file function. More...
 
void StartAnimation (bool restart=false)
 Start animation function. More...
 
void StopAnimation (bool onlyAnimation=false)
 Stop animation function. More...
 
void TrackIpv4L3ProtocolCounters ()
 Track IPv4 L3 protocol counters function. More...
 
void TrackIpv4Route ()
 Track IPv4 router function. More...
 
void TrackIpv4RoutePaths ()
 Track IPv4 route paths function. More...
 
void TrackQueueCounters ()
 Track queue counters function. More...
 
void TrackWifiMacCounters ()
 Track wifi MAC counters function. More...
 
void TrackWifiPhyCounters ()
 Track wifi phy counters function. More...
 
void UanPhyGenRxTrace (std::string context, Ptr< const Packet >)
 UAN Phy gen receive trace function. More...
 
void UanPhyGenTxTrace (std::string context, Ptr< const Packet >)
 UAN Phy gen transmit trace function. More...
 
Vector UpdatePosition (Ptr< Node > n)
 Update position function. More...
 
Vector UpdatePosition (Ptr< Node > n, Vector v)
 Update position function. More...
 
Vector UpdatePosition (Ptr< NetDevice > ndev)
 Update position function. More...
 
void WavePhyRxBeginTrace (std::string context, Ptr< const Packet > p)
 WAVE Phy receive begin trace function. More...
 
void WavePhyTxBeginTrace (std::string context, Ptr< const Packet > p)
 WAVE Phy transmit begin trace function. More...
 
void WifiMacRxDropTrace (std::string context, Ptr< const Packet > p)
 wifi MAC receive drop trace function More...
 
void WifiMacRxTrace (std::string context, Ptr< const Packet > p)
 wifi MAC receive trace function More...
 
void WifiMacTxDropTrace (std::string context, Ptr< const Packet > p)
 wifi MAC transmit drop trace function More...
 
void WifiMacTxTrace (std::string context, Ptr< const Packet > p)
 wifi MAC transmit trace function More...
 
void WifiPhyRxBeginTrace (std::string context, Ptr< const Packet > p)
 wifi Phy receive begin trace function More...
 
void WifiPhyRxDropTrace (std::string context, Ptr< const Packet > p)
 wifi Phy recieve drop trace function More...
 
void WifiPhyTxBeginTrace (std::string context, Ptr< const Packet > p)
 wifi Phy transmit begin trace function More...
 
void WifiPhyTxDropTrace (std::string context, Ptr< const Packet > p)
 wifi Phy transmit drop trace function More...
 
void WimaxRxTrace (std::string context, Ptr< const Packet > p, const Mac48Address &m)
 WIMax receive trace function. More...
 
void WimaxTxTrace (std::string context, Ptr< const Packet > p, const Mac48Address &m)
 WIMax transmit trace function. More...
 
void WriteIpv4Addresses ()
 Write IPv4 Addresses function. More...
 
void WriteIpv6Addresses ()
 Write IPv6 Addresses function. More...
 
void WriteLinkProperties ()
 Write link properties function. More...
 
int WriteN (const char *data, uint32_t count, FILE *f)
 WriteN functon. More...
 
int WriteN (const std::string &st, FILE *f)
 WriteN function. More...
 
void WriteNodeColors ()
 Write node colors function. More...
 
void WriteNodeEnergies ()
 Write node energies function. More...
 
void WriteNodes ()
 Write nodes function. More...
 
void WriteNodeSizes ()
 Write node sizes function. More...
 
void WriteNodeUpdate (uint32_t nodeId)
 Write node update function. More...
 
void WriteNonP2pLinkProperties (uint32_t id, std::string ipv4Address, std::string channelType)
 Write non P2P link properties function. More...
 
void WriteRoutePath (uint32_t nodeId, std::string destination, Ipv4RoutePathElements rpElements)
 Write route path function. More...
 
void WriteXmlAddNodeCounter (uint32_t counterId, std::string counterName, CounterType counterType)
 Write XML add node counter function. More...
 
void WriteXmlAddResource (uint32_t resourceId, std::string resourcePath)
 Write XML add resource function. More...
 
void WriteXmlAnim (bool routing=false)
 Write XML anim function. More...
 
void WriteXmlClose (std::string name, bool routing=false)
 Write XML close function. More...
 
void WriteXmlIpv4Addresses (uint32_t nodeId, std::vector< std::string > ipv4Addresses)
 Write XML Ipv4 addresses function. More...
 
void WriteXmlIpv6Addresses (uint32_t nodeId, std::vector< std::string > ipv6Addresses)
 Write XML Ipv6 addresses function. More...
 
void WriteXmlLink (uint32_t fromId, uint32_t toLp, uint32_t toId)
 Write XML link counter function. More...
 
void WriteXmlNode (uint32_t id, uint32_t sysId, double locX, double locY)
 Write XML node function. More...
 
void WriteXmlNonP2pLinkProperties (uint32_t id, std::string ipAddress, std::string channelType)
 Write XML non P2P link properties function. More...
 
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. More...
 
void WriteXmlP (uint64_t animUid, std::string pktType, uint32_t fId, double fbTx, double lbTx)
 Write XMLP function. More...
 
void WriteXmlPRef (uint64_t animUid, uint32_t fId, double fbTx, std::string metaInfo="")
 Write XMLP Ref function. More...
 
void WriteXmlRouting (uint32_t id, std::string routingInfo)
 Write XML routing function. More...
 
void WriteXmlRp (uint32_t nodeId, std::string destination, Ipv4RoutePathElements rpElements)
 Write XMLRP function. More...
 
void WriteXmlUpdateBackground (std::string fileName, double x, double y, double scaleX, double scaleY, double opacity)
 Write XML update background function. More...
 
void WriteXmlUpdateLink (uint32_t fromId, uint32_t toId, std::string linkDescription)
 Write XML update link counter function. More...
 
void WriteXmlUpdateNodeColor (uint32_t nodeId, uint8_t r, uint8_t g, uint8_t b)
 Write XML update node color function. More...
 
void WriteXmlUpdateNodeCounter (uint32_t counterId, uint32_t nodeId, double value)
 Write XML update node counter function. More...
 
void WriteXmlUpdateNodeDescription (uint32_t nodeId)
 Write XML update node description function. More...
 
void WriteXmlUpdateNodeImage (uint32_t nodeId, uint32_t resourceId)
 Write XML update node image function. More...
 
void WriteXmlUpdateNodePosition (uint32_t nodeId, double x, double y)
 Write XML update node position function. More...
 
void WriteXmlUpdateNodeSize (uint32_t nodeId, double width, double height)
 Write XML update node size function. More...
 

Private Attributes

uint64_t gAnimUid
 Packet unique identifier used by AnimationInterface. More...
 
uint64_t m_currentPktCount
 current packet count More...
 
bool m_enablePacketMetadata
 enable packet metadata More...
 
FILE * m_f
 File handle for output (0 if none) More...
 
Time m_ipv4L3ProtocolCountersPollInterval
 IPv4 L3 protocol counters poll interval. More...
 
Time m_ipv4L3ProtocolCountersStopTime
 IPv4 L3 protocol counters stop time. More...
 
uint32_t m_ipv4L3ProtocolDropCounterId
 IPv4 protocol drop counter ID. More...
 
uint32_t m_ipv4L3ProtocolRxCounterId
 IPv4 L3 protocol receive counter ID. More...
 
uint32_t m_ipv4L3ProtocolTxCounterId
 IPv4 L3 protocol transmit counter ID. More...
 
std::vector< Ipv4RouteTrackElementm_ipv4RouteTrackElements
 IPv route track elements. More...
 
std::map< std::string, uint32_t > m_ipv4ToNodeIdMap
 IPv4 to node ID map. More...
 
std::map< std::string, uint32_t > m_ipv6ToNodeIdMap
 IPv6 to node ID map. More...
 
LinkPropertiesMap m_linkProperties
 link properties More...
 
std::map< std::string, uint32_t > m_macToNodeIdMap
 MAC to node ID map. More...
 
uint64_t m_maxPktsPerFile
 maximum pakets per file More...
 
Time m_mobilityPollInterval
 mobility poll interval More...
 
NodeColorsMap m_nodeColors
 node colors More...
 
std::vector< std::string > m_nodeCounters
 node counters More...
 
NodeDescriptionsMap m_nodeDescriptions
 node description More...
 
EnergyFractionMap m_nodeEnergyFraction
 node energy fraction More...
 
NodeIdIpv4Map m_nodeIdIpv4Map
 node ID to IPv4 map More...
 
NodeIdIpv6Map m_nodeIdIpv6Map
 node ID to IPv6 map More...
 
NodeCounterMap64 m_nodeIpv4Drop
 node IPv4 drop More...
 
NodeCounterMap64 m_nodeIpv4Rx
 node IPv4 receive More...
 
NodeCounterMap64 m_nodeIpv4Tx
 node IPv4 transmit More...
 
std::map< uint32_t, Vector > m_nodeLocation
 node location More...
 
NodeCounterMap64 m_nodeLrWpanMacRx
 node LR-WPAN MAC receive More...
 
NodeCounterMap64 m_nodeLrWpanMacRxDrop
 node LR-WPAN MAC receive drop More...
 
NodeCounterMap64 m_nodeLrWpanMacTx
 node LR-WPAN MAC transmit More...
 
NodeCounterMap64 m_nodeLrWpanMacTxDrop
 node LR-WPAN MAC transmit drop More...
 
NodeCounterMap64 m_nodeQueueDequeue
 node queue dequeue More...
 
NodeCounterMap64 m_nodeQueueDrop
 node queue drop More...
 
NodeCounterMap64 m_nodeQueueEnqueue
 node queue enqueue More...
 
std::map< uint32_t, NodeSizem_nodeSizes
 node sizes More...
 
NodeCounterMap64 m_nodeWifiMacRx
 node wifi MAC receive More...
 
NodeCounterMap64 m_nodeWifiMacRxDrop
 node wifi MAC receive drop More...
 
NodeCounterMap64 m_nodeWifiMacTx
 node wifi MAC transmit More...
 
NodeCounterMap64 m_nodeWifiMacTxDrop
 node wifi MAC transmit drop More...
 
NodeCounterMap64 m_nodeWifiPhyRxDrop
 node wifi Phy receive drop More...
 
NodeCounterMap64 m_nodeWifiPhyTxDrop
 node wifi Phy transmit drop More...
 
std::string m_originalFileName
 original file name More...
 
std::string m_outputFileName
 output file name More...
 
AnimUidPacketInfoMap m_pendingCsmaPackets
 pending CSMA packets More...
 
AnimUidPacketInfoMap m_pendingLrWpanPackets
 pending LR-WPAN packets More...
 
AnimUidPacketInfoMap m_pendingLtePackets
 pending LTE packets More...
 
AnimUidPacketInfoMap m_pendingUanPackets
 pending UAN packets More...
 
AnimUidPacketInfoMap m_pendingWavePackets
 pending WAVE packets More...
 
AnimUidPacketInfoMap m_pendingWifiPackets
 pending wifi packets More...
 
AnimUidPacketInfoMap m_pendingWimaxPackets
 pending wimax packets More...
 
Time m_queueCountersPollInterval
 queue counters poll interval More...
 
Time m_queueCountersStopTime
 queue counters stop time More...
 
uint32_t m_queueDequeueCounterId
 queue dequeue counter ID More...
 
uint32_t m_queueDropCounterId
 queue drop counter ID More...
 
uint32_t m_queueEnqueueCounterId
 queue enqueue counter ID More...
 
uint32_t m_remainingEnergyCounterId
 remaining energy counter ID More...
 
std::vector< std::string > m_resources
 resources More...
 
FILE * m_routingF
 File handle for routing table output (0 if None);. More...
 
std::string m_routingFileName
 routing file name More...
 
NodeContainer m_routingNc
 routing node container More...
 
Time m_routingPollInterval
 routing poll interval More...
 
Time m_routingStopTime
 routing stop time More...
 
bool m_started
 started More...
 
Time m_startTime
 start time More...
 
Time m_stopTime
 stop time More...
 
bool m_trackPackets
 track packets More...
 
Time m_wifiMacCountersPollInterval
 wifi MAC counters poll interval More...
 
Time m_wifiMacCountersStopTime
 wifi MAC counters stop time More...
 
uint32_t m_wifiMacRxCounterId
 wifi MAC receive counter ID More...
 
uint32_t m_wifiMacRxDropCounterId
 wifi MAC receive drop counter ID More...
 
uint32_t m_wifiMacTxCounterId
 wifi MAC transmit counter ID More...
 
uint32_t m_wifiMacTxDropCounterId
 wifi MAC transmit drop counter ID More...
 
Time m_wifiPhyCountersPollInterval
 wifi Phy counters poll interval More...
 
Time m_wifiPhyCountersStopTime
 wifi Phy counters stop time More...
 
uint32_t m_wifiPhyRxDropCounterId
 wifi Phy receive drop counter ID More...
 
uint32_t m_wifiPhyTxDropCounterId
 wifi Phy transmit drop counter ID More...
 
AnimWriteCallback m_writeCallback
 write callback More...
 

Static Private Attributes

static RectangleuserBoundary
 user boundary More...
 

Detailed Description

Interface to network animator.

Provides functions that facilitate communications with an external or internal network animator.

Definition at line 72 of file animation-interface.h.

Member Typedef Documentation

AnimUidPacketInfoMap typedef.

Definition at line 549 of file animation-interface.h.

typedef void(* ns3::AnimationInterface::AnimWriteCallback) (const char *str)

typedef for WriteCallBack used for listening to AnimationInterface write messages

Definition at line 97 of file animation-interface.h.

typedef std::map<uint32_t, double> ns3::AnimationInterface::EnergyFractionMap
private

EnergyFractionMap typedef.

Definition at line 550 of file animation-interface.h.

Ipv4RoutePathElements typedef.

Definition at line 551 of file animation-interface.h.

LinkPropertiesMap typedef.

Definition at line 546 of file animation-interface.h.

typedef std::map<uint32_t, Rgb> ns3::AnimationInterface::NodeColorsMap
private

NodeColorsMap typedef.

Definition at line 548 of file animation-interface.h.

typedef std::map<uint32_t, uint64_t> ns3::AnimationInterface::NodeCounterMap64
private

NodeCounterMap64 typedef.

Definition at line 559 of file animation-interface.h.

typedef std::map<uint32_t, std::string> ns3::AnimationInterface::NodeDescriptionsMap
private

NodeDescriptionsMap typedef.

Definition at line 547 of file animation-interface.h.

typedef std::multimap<uint32_t, std::string> ns3::AnimationInterface::NodeIdIpv4Map
private

NodeIdIpv4Map typedef.

Definition at line 552 of file animation-interface.h.

typedef std::pair<uint32_t, std::string> ns3::AnimationInterface::NodeIdIpv4Pair
private

NodeIdIpv4Pair typedef.

Definition at line 554 of file animation-interface.h.

typedef std::multimap<uint32_t, std::string> ns3::AnimationInterface::NodeIdIpv6Map
private

NodeIdIpv6Map typedef.

Definition at line 553 of file animation-interface.h.

typedef std::pair<uint32_t, std::string> ns3::AnimationInterface::NodeIdIpv6Pair
private

NodeIdIpv6Pair typedef.

Definition at line 555 of file animation-interface.h.

Constructor & Destructor Documentation

ns3::AnimationInterface::AnimationInterface ( const std::string  filename)

Constructor.

Parameters
filenameThe Filename for the trace file used by the Animator

Definition at line 74 of file animation-interface.cc.

References StartAnimation().

+ Here is the call graph for this function:

ns3::AnimationInterface::~AnimationInterface ( )

Destructor for the animator interface.

Definition at line 96 of file animation-interface.cc.

References StopAnimation().

+ Here is the call graph for this function:

Member Function Documentation

void ns3::AnimationInterface::AddByteTag ( uint64_t  animUid,
Ptr< const Packet p 
)
private

Add byte tag function.

Parameters
animUidthe UID
pthe packet

Definition at line 629 of file animation-interface.cc.

References ns3::Packet::AddByteTag(), and ns3::AnimByteTag::Set().

Referenced by CsmaPhyTxBeginTrace(), GenericWirelessTxTrace(), LrWpanPhyTxBeginTrace(), and LteSpectrumPhyTxStart().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

uint32_t ns3::AnimationInterface::AddNodeCounter ( std::string  counterName,
CounterType  counterType 
)

Setup a node counter.

Parameters
counterNameA string to identify the counter
counterTypeThe type of the counter, such as uint32, double etc
Returns
The id of the counter to be used as a reference for future

Definition at line 237 of file animation-interface.cc.

References m_nodeCounters, and WriteXmlAddNodeCounter().

Referenced by EnableIpv4L3ProtocolCounters(), EnableQueueCounters(), EnableWifiMacCounters(), EnableWifiPhyCounters(), and WriteNodeEnergies().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::AnimationInterface::AddPendingPacket ( ProtocolType  protocolType,
uint64_t  animUid,
AnimPacketInfo  pktInfo 
)
private

Add pending packet function.

Parameters
protocolTypethe protocol type
animUidthe UID
pktInfothe packet info

Definition at line 1260 of file animation-interface.cc.

References NS_ASSERT, and ProtocolTypeToPendingPackets().

Referenced by CsmaPhyTxBeginTrace(), CsmaPhyTxEndTrace(), GenericWirelessTxTrace(), LrWpanPhyTxBeginTrace(), LteSpectrumPhyTxStart(), WavePhyRxBeginTrace(), and WifiPhyRxBeginTrace().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

uint32_t ns3::AnimationInterface::AddResource ( std::string  resourcePath)

Add a resource such as the path to an image file.

Parameters
resourcePathAbsolute Path to an image/resource
Returns
a number identifying the resource

Definition at line 246 of file animation-interface.cc.

References m_resources, and WriteXmlAddResource().

+ Here is the call graph for this function:

AnimationInterface & ns3::AnimationInterface::AddSourceDestination ( uint32_t  fromNodeId,
std::string  destinationIpv4Address 
)

Helper function to print the routing path from a source node to destination IP.

Parameters
fromNodeIdThe source node
destinationIpv4AddressThe destination Ipv4 Address
Returns
reference to this AnimationInterface object

Definition at line 211 of file animation-interface.cc.

References m_ipv4RouteTrackElements.

void ns3::AnimationInterface::AddToIpv4AddressNodeIdTable ( std::string  ipv4Address,
uint32_t  nodeId 
)
private

Add to IPv4 address node ID table function.

Parameters
ipv4Addressthe IPv4 address
nodeIdthe node ID

Definition at line 1481 of file animation-interface.cc.

References m_ipv4ToNodeIdMap, and m_nodeIdIpv4Map.

Referenced by AddToIpv4AddressNodeIdTable(), and WriteLinkProperties().

+ Here is the caller graph for this function:

void ns3::AnimationInterface::AddToIpv4AddressNodeIdTable ( std::vector< std::string >  ipv4Addresses,
uint32_t  nodeId 
)
private

Add to IPv4 address node ID table function.

Parameters
ipv4Addressesthe list of IPv4 addresses
nodeIdthe node ID

Definition at line 1488 of file animation-interface.cc.

References AddToIpv4AddressNodeIdTable().

+ Here is the call graph for this function:

void ns3::AnimationInterface::AddToIpv6AddressNodeIdTable ( std::string  ipv6Address,
uint32_t  nodeId 
)
private

Add to IPv6 address node ID table function.

Parameters
ipv6Addressthe IPv6 address
nodeIdthe node ID

Definition at line 1499 of file animation-interface.cc.

References m_ipv6ToNodeIdMap, and m_nodeIdIpv6Map.

Referenced by AddToIpv6AddressNodeIdTable(), and WriteLinkProperties().

+ Here is the caller graph for this function:

void ns3::AnimationInterface::AddToIpv6AddressNodeIdTable ( std::vector< std::string >  ipv6Addresses,
uint32_t  nodeId 
)
private

Add to IPv6 address node ID table function.

Parameters
ipv6Addressesthe list of IPv6 addresses
nodeIdthe node ID

Definition at line 1506 of file animation-interface.cc.

References AddToIpv6AddressNodeIdTable().

+ Here is the call graph for this function:

void ns3::AnimationInterface::CheckMaxPktsPerTraceFile ( )
private

Check maximum packets per trace file function.

Definition at line 2097 of file animation-interface.cc.

References m_currentPktCount, m_maxPktsPerFile, NS_LOG_UNCOND, and StopAnimation().

Referenced by DevTxTrace(), OutputCsmaPacket(), OutputWirelessPacketRxInfo(), and OutputWirelessPacketTxInfo().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::AnimationInterface::ConnectLte ( )
private

Connect LTE function.

Definition at line 1564 of file animation-interface.cc.

References ns3::NodeList::Begin(), ConnectLteEnb(), ConnectLteUe(), ns3::NodeList::End(), ns3::Node::GetDevice(), ns3::Node::GetNDevices(), and NS_ASSERT.

Referenced by ConnectCallbacks().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::AnimationInterface::ConnectLteEnb ( Ptr< Node n,
Ptr< LteEnbNetDevice nd,
uint32_t  devIndex 
)
private

Connect LTE ENB function.

Parameters
nthe node
ndthe device
devIndexthe device index

Definition at line 1518 of file animation-interface.cc.

References ns3::Node::GetId(), ns3::LteEnbNetDevice::GetPhy(), LteSpectrumPhyRxStart(), LteSpectrumPhyTxStart(), and ns3::MakeCallback().

Referenced by ConnectLte().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::AnimationInterface::ConnectLteUe ( Ptr< Node n,
Ptr< LteUeNetDevice nd,
uint32_t  devIndex 
)
private

Connect LTE ue function.

Parameters
nthe node
ndthe device
devIndexthe device index

Definition at line 1542 of file animation-interface.cc.

References ns3::Node::GetId(), LteSpectrumPhyRxStart(), LteSpectrumPhyTxStart(), and ns3::MakeCallback().

Referenced by ConnectLte().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

std::string ns3::AnimationInterface::CounterTypeToString ( CounterType  counterType)
private

Counter type to string function.

Parameters
counterTypethe counter type
Returns
the string

Definition at line 1399 of file animation-interface.cc.

References DOUBLE_COUNTER, and UINT32_COUNTER.

Referenced by WriteXmlAddNodeCounter().

+ Here is the caller graph for this function:

void ns3::AnimationInterface::CsmaMacRxTrace ( std::string  context,
Ptr< const Packet p 
)
private

CSMA MAC receive trace function.

Parameters
contextthe context
pthe packet
Todo:
NS_ASSERT (CsmaPacketIsPending (AnimUid) == true);

Definition at line 1198 of file animation-interface.cc.

References CHECK_STARTED_INTIMEWINDOW_TRACKPACKETS, CSMA, GetAnimUidFromPacket(), GetNetDeviceFromContext(), IsPacketPending(), m_pendingCsmaPackets, NS_ASSERT, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_WARN, and OutputCsmaPacket().

Referenced by ConnectCallbacks().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::AnimationInterface::CsmaPhyRxEndTrace ( std::string  context,
Ptr< const Packet p 
)
private

CSMA Phy receive end trace function.

Parameters
contextthe context
pthe packet
Todo:
NS_ASSERT (CsmaPacketIsPending (AnimUid) == true);

Definition at line 1176 of file animation-interface.cc.

References CHECK_STARTED_INTIMEWINDOW_TRACKPACKETS, CSMA, GetAnimUidFromPacket(), GetNetDeviceFromContext(), IsPacketPending(), m_pendingCsmaPackets, ns3::Simulator::Now(), NS_ASSERT, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_WARN, OutputCsmaPacket(), ns3::AnimationInterface::AnimPacketInfo::ProcessRxBegin(), and UpdatePosition().

Referenced by ConnectCallbacks().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::AnimationInterface::CsmaPhyTxBeginTrace ( std::string  context,
Ptr< const Packet p 
)
private

CSMA Phy transmit begin trace function.

Parameters
contextthe context
pthe packet

Definition at line 1135 of file animation-interface.cc.

References AddByteTag(), AddPendingPacket(), CHECK_STARTED_INTIMEWINDOW_TRACKPACKETS, CSMA, gAnimUid, GetNetDeviceFromContext(), ns3::Simulator::Now(), NS_ASSERT, NS_LOG_FUNCTION, NS_LOG_INFO, and UpdatePosition().

Referenced by ConnectCallbacks().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::AnimationInterface::CsmaPhyTxEndTrace ( std::string  context,
Ptr< const Packet p 
)
private

CSMA Phy transmit end trace function.

Parameters
contextthe context
pthe packet
Todo:
NS_ASSERT (IsPacketPending (AnimUid) == true);

Definition at line 1153 of file animation-interface.cc.

References AddPendingPacket(), CHECK_STARTED_INTIMEWINDOW_TRACKPACKETS, CSMA, GetAnimUidFromPacket(), GetNetDeviceFromContext(), ns3::Time::GetSeconds(), IsPacketPending(), ns3::AnimationInterface::AnimPacketInfo::m_lbTx, m_pendingCsmaPackets, ns3::Simulator::Now(), NS_ASSERT, NS_FATAL_ERROR, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_WARN, and UpdatePosition().

Referenced by ConnectCallbacks().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::AnimationInterface::DequeueTrace ( std::string  context,
Ptr< const Packet p 
)
private

Dequeue trace function.

Parameters
contextthe context
pthe packet

Definition at line 762 of file animation-interface.cc.

References GetNodeFromContext(), and m_nodeQueueDequeue.

Referenced by ConnectCallbacks().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::AnimationInterface::DevTxTrace ( std::string  context,
Ptr< const Packet p,
Ptr< NetDevice tx,
Ptr< NetDevice rx,
Time  txTime,
Time  rxTime 
)
private

Device transmit trace function.

Parameters
contextthe context
pthe packet
txthe transmit device
rxthe receive device
txTimethe transmit time
rxTimethe reeive time

Definition at line 778 of file animation-interface.cc.

References CHECK_STARTED_INTIMEWINDOW_TRACKPACKETS, CheckMaxPktsPerTraceFile(), GetPacketMetadata(), ns3::Time::GetSeconds(), m_enablePacketMetadata, ns3::Simulator::Now(), NS_ASSERT, NS_LOG_FUNCTION, and WriteXmlP().

Referenced by ConnectCallbacks().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::AnimationInterface::EnableIpv4L3ProtocolCounters ( Time  startTime,
Time  stopTime,
Time  pollInterval = Seconds (1) 
)

Enable tracking of Ipv4 L3 Protocol Counters such as Tx, Rx, Drop.

Parameters
startTimeStart Time for capturing values
stopTimeStop Time for capturing values
pollIntervalThe periodic interval at which the counters are written to the trace file Default: 1s
Returns
none

Definition at line 172 of file animation-interface.cc.

References AddNodeCounter(), ns3::NodeList::Begin(), DOUBLE_COUNTER, ns3::NodeList::End(), ns3::Node::GetId(), m_ipv4L3ProtocolCountersPollInterval, m_ipv4L3ProtocolCountersStopTime, m_ipv4L3ProtocolDropCounterId, m_ipv4L3ProtocolRxCounterId, m_ipv4L3ProtocolTxCounterId, m_nodeIpv4Drop, m_nodeIpv4Rx, m_nodeIpv4Tx, ns3::Simulator::Schedule(), stopTime, TrackIpv4L3ProtocolCounters(), and UpdateNodeCounter().

+ Here is the call graph for this function:

AnimationInterface & ns3::AnimationInterface::EnableIpv4RouteTracking ( std::string  fileName,
Time  startTime,
Time  stopTime,
Time  pollInterval = Seconds (5) 
)

Enable tracking of the Ipv4 routing table for all Nodes.

Parameters
fileNameTrace file for storing routing table information
startTimeStart time for capture
stopTimeEnd time for capture
pollIntervalThe periodic interval at which routing table information is polled Default: 5s
Returns
reference to this AnimationInterface object

Definition at line 193 of file animation-interface.cc.

References m_routingPollInterval, m_routingStopTime, ns3::Simulator::Schedule(), SetOutputFile(), stopTime, TrackIpv4Route(), and WriteXmlAnim().

Referenced by EnableIpv4RouteTracking().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

AnimationInterface & ns3::AnimationInterface::EnableIpv4RouteTracking ( std::string  fileName,
Time  startTime,
Time  stopTime,
NodeContainer  nc,
Time  pollInterval = Seconds (5) 
)

Enable tracking of the Ipv4 routing table for a set of Nodes.

Parameters
fileNameTrace file for storing routing table information
startTimeStart time for capture
stopTimeEnd time for capture
ncA NodeContainer containing nodes for which Routing table has to be tracked
pollIntervalThe periodic interval at which routing table information is polled Default: 5s
Returns
reference to this AnimationInterface object

Definition at line 204 of file animation-interface.cc.

References EnableIpv4RouteTracking(), and m_routingNc.

+ Here is the call graph for this function:

void ns3::AnimationInterface::EnablePacketMetadata ( bool  enable = true)

Enable Packet metadata.

Parameters
enableif true enables writing the packet metadata to the XML trace file if false disables writing the packet metadata
Returns
none

Definition at line 255 of file animation-interface.cc.

References ns3::Packet::EnablePrinting(), and m_enablePacketMetadata.

+ Here is the call graph for this function:

void ns3::AnimationInterface::EnableQueueCounters ( Time  startTime,
Time  stopTime,
Time  pollInterval = Seconds (1) 
)

Enable tracking of Queue Counters such as Enqueue, Dequeue, Queue Drops.

Parameters
startTimeStart Time for capturing values
stopTimeStop Time for capturing values
pollIntervalThe periodic interval at which the counters are written to the trace file Default: 1s
Returns
none

Definition at line 151 of file animation-interface.cc.

References AddNodeCounter(), ns3::NodeList::Begin(), DOUBLE_COUNTER, ns3::NodeList::End(), ns3::Node::GetId(), m_nodeQueueDequeue, m_nodeQueueDrop, m_nodeQueueEnqueue, m_queueCountersPollInterval, m_queueCountersStopTime, m_queueDequeueCounterId, m_queueDropCounterId, m_queueEnqueueCounterId, ns3::Simulator::Schedule(), stopTime, TrackQueueCounters(), and UpdateNodeCounter().

+ Here is the call graph for this function:

void ns3::AnimationInterface::EnableWifiMacCounters ( Time  startTime,
Time  stopTime,
Time  pollInterval = Seconds (1) 
)

Enable tracking of Wifi Mac Counters such as Tx, TxDrop, Rx, RxDrop.

Parameters
startTimeStart Time for capturing values
stopTimeStop Time for capturing values
pollIntervalThe periodic interval at which the counters are written to the trace file Default: 1s
Returns
none

Definition at line 127 of file animation-interface.cc.

References AddNodeCounter(), ns3::NodeList::Begin(), DOUBLE_COUNTER, ns3::NodeList::End(), ns3::Node::GetId(), m_nodeWifiMacRx, m_nodeWifiMacRxDrop, m_nodeWifiMacTx, m_nodeWifiMacTxDrop, m_wifiMacCountersPollInterval, m_wifiMacCountersStopTime, m_wifiMacRxCounterId, m_wifiMacRxDropCounterId, m_wifiMacTxCounterId, m_wifiMacTxDropCounterId, ns3::Simulator::Schedule(), stopTime, TrackWifiMacCounters(), and UpdateNodeCounter().

+ Here is the call graph for this function:

void ns3::AnimationInterface::EnableWifiPhyCounters ( Time  startTime,
Time  stopTime,
Time  pollInterval = Seconds (1) 
)

Enable tracking of Wifi Phy Counters such as TxDrop, RxDrop.

Parameters
startTimeStart Time for capturing values
stopTimeStop Time for capturing values
pollIntervalThe periodic interval at which the counters are written to the trace file Default: 1s
Returns
none

Definition at line 108 of file animation-interface.cc.

References AddNodeCounter(), ns3::NodeList::Begin(), DOUBLE_COUNTER, ns3::NodeList::End(), ns3::Node::GetId(), m_nodeWifiPhyRxDrop, m_nodeWifiPhyTxDrop, m_wifiPhyCountersPollInterval, m_wifiPhyCountersStopTime, m_wifiPhyRxDropCounterId, m_wifiPhyTxDropCounterId, ns3::Simulator::Schedule(), stopTime, TrackWifiPhyCounters(), and UpdateNodeCounter().

+ Here is the call graph for this function:

void ns3::AnimationInterface::EnqueueTrace ( std::string  context,
Ptr< const Packet p 
)
private

Enqueue trace function.

Parameters
contextthe context
pthe packet

Definition at line 754 of file animation-interface.cc.

References GetNodeFromContext(), and m_nodeQueueEnqueue.

Referenced by ConnectCallbacks().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::AnimationInterface::GenericWirelessRxTrace ( std::string  context,
Ptr< const Packet p,
ProtocolType  protocolType 
)
private

Generic wireless receive trace function.

Parameters
contextthe context
pthe packet
protocolTypethe protocol type

Definition at line 836 of file animation-interface.cc.

References CHECK_STARTED_INTIMEWINDOW_TRACKPACKETS, GetAnimUidFromPacket(), GetNetDeviceFromContext(), IsPacketPending(), ns3::Simulator::Now(), NS_ASSERT, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_WARN, OutputWirelessPacketRxInfo(), ProtocolTypeToPendingPackets(), ProtocolTypeToString(), and UpdatePosition().

Referenced by LteRxTrace(), UanPhyGenRxTrace(), and WimaxRxTrace().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::AnimationInterface::GenericWirelessTxTrace ( std::string  context,
Ptr< const Packet p,
ProtocolType  protocolType 
)
private

Generic wireless transmit trace function.

Parameters
contextthe context
pthe packet
protocolTypethe protocol type

Definition at line 806 of file animation-interface.cc.

References AddByteTag(), AddPendingPacket(), CHECK_STARTED_INTIMEWINDOW_TRACKPACKETS, gAnimUid, ns3::Node::GetId(), GetNetDeviceFromContext(), m_macToNodeIdMap, ns3::Simulator::Now(), NS_ASSERT, NS_LOG_FUNCTION, NS_LOG_INFO, OutputWirelessPacketTxInfo(), ProtocolTypeToPendingPackets(), ProtocolTypeToString(), and UpdatePosition().

Referenced by LteTxTrace(), UanPhyGenTxTrace(), WavePhyTxBeginTrace(), WifiPhyTxBeginTrace(), and WimaxTxTrace().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

uint64_t ns3::AnimationInterface::GetAnimUidFromPacket ( Ptr< const Packet p)
private
const std::vector< std::string > ns3::AnimationInterface::GetElementsFromContext ( const std::string &  context) const
private

Get elements from context.

Parameters
contextthe context string
Returns
the elements

Definition at line 561 of file animation-interface.cc.

Referenced by GetNetDeviceFromContext(), and GetNodeFromContext().

+ Here is the caller graph for this function:

std::string ns3::AnimationInterface::GetIpv4Address ( Ptr< NetDevice nd)
private

Get IPv4 address.

Parameters
ndthe device
Returns
the IPv4 address

Definition at line 1758 of file animation-interface.cc.

References ns3::Ipv4InterfaceAddress::GetLocal(), ns3::NodeList::GetNode(), and NS_LOG_WARN.

Referenced by WriteLinkProperties().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

std::vector< std::string > ns3::AnimationInterface::GetIpv4Addresses ( Ptr< NetDevice nd)
private

Get IPv4 addresses.

Parameters
ndthe device
Returns
the IPv4 address list

Definition at line 1815 of file animation-interface.cc.

References ns3::Ipv4InterfaceAddress::GetLocal(), ns3::NodeList::GetNode(), and NS_LOG_WARN.

Referenced by WriteLinkProperties().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

std::string ns3::AnimationInterface::GetIpv4RoutingTable ( Ptr< Node n)
private

Get IPv4 routing table function.

Parameters
nthe node
Returns
the IPv4 routing table

Definition at line 2297 of file animation-interface.cc.

References ns3::Node::GetId(), ns3::Object::GetObject(), ns3::Ipv4::GetRoutingProtocol(), NS_ASSERT, and NS_LOG_WARN.

Referenced by TrackIpv4Route().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

std::string ns3::AnimationInterface::GetIpv6Address ( Ptr< NetDevice nd)
private

Get IPv6 address.

Parameters
ndthe device
Returns
the IPv6 address

Definition at line 1779 of file animation-interface.cc.

References ns3::Ipv6InterfaceAddress::GetAddress(), ns3::NodeList::GetNode(), ns3::Ipv6Address::IsLinkLocal(), and NS_LOG_WARN.

Referenced by WriteLinkProperties().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

std::vector< std::string > ns3::AnimationInterface::GetIpv6Addresses ( Ptr< NetDevice nd)
private

Get IPv6 addresses.

Parameters
ndthe device
Returns
the IPv6 address list

Definition at line 1841 of file animation-interface.cc.

References ns3::Ipv6InterfaceAddress::GetAddress(), ns3::NodeList::GetNode(), and NS_LOG_WARN.

Referenced by WriteLinkProperties().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

std::string ns3::AnimationInterface::GetMacAddress ( Ptr< NetDevice nd)
private

Get MAC address function.

Parameters
ndthe device
Returns
the MAC address

Definition at line 1749 of file animation-interface.cc.

Referenced by WriteLinkProperties().

+ Here is the caller graph for this function:

std::vector< Ptr< Node > > ns3::AnimationInterface::GetMovedNodes ( )
private

Get moved nodes function.

Returns
the list of moved nodes

Definition at line 468 of file animation-interface.cc.

References ns3::NodeList::Begin(), ns3::NodeList::End(), ns3::Object::GetObject(), ns3::MobilityModel::GetPosition(), GetPosition(), third::mobility, NodeHasMoved(), NS_ASSERT, and UpdatePosition().

Referenced by MobilityAutoCheck().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

std::string ns3::AnimationInterface::GetNetAnimVersion ( )
private

Get netanim version function.

Returns
the net anim version string

Definition at line 2110 of file animation-interface.cc.

References NETANIM_VERSION.

Referenced by WriteXmlAnim().

+ Here is the caller graph for this function:

Ptr< NetDevice > ns3::AnimationInterface::GetNetDeviceFromContext ( std::string  context)
private

Get net device from context.

Parameters
contextthe context string
Returns
the device

Definition at line 590 of file animation-interface.cc.

References ns3::Node::GetDevice(), GetElementsFromContext(), and GetNodeFromContext().

Referenced by CsmaMacRxTrace(), CsmaPhyRxEndTrace(), CsmaPhyTxBeginTrace(), CsmaPhyTxEndTrace(), GenericWirelessRxTrace(), GenericWirelessTxTrace(), LrWpanPhyRxBeginTrace(), LrWpanPhyTxBeginTrace(), LteSpectrumPhyRxStart(), LteSpectrumPhyTxStart(), WavePhyRxBeginTrace(), and WifiPhyRxBeginTrace().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

double ns3::AnimationInterface::GetNodeEnergyFraction ( Ptr< const Node node) const

Get node's energy fraction (This used only for testing)

Parameters
node
Returns
current node's remaining energy (between [0, 1])

Definition at line 400 of file animation-interface.cc.

References m_nodeEnergyFraction, and NS_ASSERT.

Referenced by AnimationRemainingEnergyTestCase::CheckLogic().

+ Here is the caller graph for this function:

Ptr< Node > ns3::AnimationInterface::GetNodeFromContext ( const std::string &  context) const
private
std::string ns3::AnimationInterface::GetPacketMetadata ( Ptr< const Packet p)
private

Get packet metadata function.

Parameters
pthe packet
Returns
the meta data

Definition at line 1421 of file animation-interface.cc.

References ns3::Packet::Print().

Referenced by DevTxTrace(), OutputCsmaPacket(), and OutputWirelessPacketTxInfo().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Vector ns3::AnimationInterface::GetPosition ( Ptr< Node n)
private

Get position function.

Parameters
nthe node
Returns
the position vector

Definition at line 1738 of file animation-interface.cc.

References ns3::Node::GetId(), m_nodeLocation, and NS_FATAL_ERROR.

Referenced by GetMovedNodes(), MobilityAutoCheck(), MobilityCourseChangeTrace(), and NodeHasMoved().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

uint64_t ns3::AnimationInterface::GetTracePktCount ( )

Get trace file packet count (This used only for testing)

Returns
Number of packets recorded in the current trace file

Definition at line 1429 of file animation-interface.cc.

References m_currentPktCount.

Referenced by AnimationInterfaceTestCase::CheckLogic().

+ Here is the caller graph for this function:

void ns3::AnimationInterface::Ipv4DropTrace ( std::string  context,
const Ipv4Header ipv4Header,
Ptr< const Packet p,
Ipv4L3Protocol::DropReason  dropReason,
Ptr< Ipv4 ipv4,
uint32_t  interfaceIndex 
)
private

IPv4 drop trace function.

Parameters
contextthe context
ipv4Headerthe IPv4 header
pthe packet
dropReasonthe reason for the drop
ipv4the IP
interfaceIndexthe interface index

Definition at line 742 of file animation-interface.cc.

References GetNodeFromContext(), and m_nodeIpv4Drop.

Referenced by ConnectCallbacks().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::AnimationInterface::Ipv4RxTrace ( std::string  context,
Ptr< const Packet p,
Ptr< Ipv4 ipv4,
uint32_t  interfaceIndex 
)
private

IPv4 receive trace function.

Parameters
contextthe context
pthe packet
ipv4the IP
interfaceIndexthe interface index

Definition at line 735 of file animation-interface.cc.

References GetNodeFromContext(), and m_nodeIpv4Rx.

Referenced by ConnectCallbacks().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::AnimationInterface::Ipv4TxTrace ( std::string  context,
Ptr< const Packet p,
Ptr< Ipv4 ipv4,
uint32_t  interfaceIndex 
)
private

IPv4 transmit trace function.

Parameters
contextthe context
pthe packet
ipv4the IP
interfaceIndexthe interface index

Definition at line 728 of file animation-interface.cc.

References GetNodeFromContext(), and m_nodeIpv4Tx.

Referenced by ConnectCallbacks().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool ns3::AnimationInterface::IsInitialized ( void  )
static

Check if AnimationInterface is initialized.

Returns
true if AnimationInterface was already initialized

Definition at line 265 of file animation-interface.cc.

References ns3::initialized.

bool ns3::AnimationInterface::IsInTimeWindow ( )
private

Is in time window function.

Returns
true if in the time window

Definition at line 2053 of file animation-interface.cc.

References m_startTime, m_stopTime, and ns3::Simulator::Now().

+ Here is the call graph for this function:

bool ns3::AnimationInterface::IsPacketPending ( uint64_t  animUid,
AnimationInterface::ProtocolType  protocolType 
)
private

Is packet pending function.

Parameters
animUidthe UID
protocolTypethe protocol type
Returns
true if a packet is pending

Definition at line 1268 of file animation-interface.cc.

References NS_ASSERT, and ProtocolTypeToPendingPackets().

Referenced by CsmaMacRxTrace(), CsmaPhyRxEndTrace(), CsmaPhyTxEndTrace(), GenericWirelessRxTrace(), LrWpanPhyRxBeginTrace(), LteSpectrumPhyRxStart(), WavePhyRxBeginTrace(), and WifiPhyRxBeginTrace().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool ns3::AnimationInterface::IsStarted ( void  )

Is AnimationInterface started.

Returns
true if AnimationInterface was started

Definition at line 271 of file animation-interface.cc.

References m_started.

void ns3::AnimationInterface::LrWpanMacRxDropTrace ( std::string  context,
Ptr< const Packet p 
)
private

LR-WPAN MAC receive drop trace function.

Parameters
contextthe context
pthe packet

Definition at line 721 of file animation-interface.cc.

References GetNodeFromContext(), and m_nodeLrWpanMacRxDrop.

Referenced by ConnectCallbacks().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::AnimationInterface::LrWpanMacRxTrace ( std::string  context,
Ptr< const Packet p 
)
private

LR-WPAN MAC receive trace function.

Parameters
contextthe context
pthe packet

Definition at line 714 of file animation-interface.cc.

References GetNodeFromContext(), and m_nodeLrWpanMacRx.

Referenced by ConnectCallbacks().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::AnimationInterface::LrWpanMacTxDropTrace ( std::string  context,
Ptr< const Packet p 
)
private

LR-WPAN MAC transmit drop trace function.

Parameters
contextthe context
pthe packet

Definition at line 707 of file animation-interface.cc.

References GetNodeFromContext(), and m_nodeLrWpanMacTxDrop.

Referenced by ConnectCallbacks().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::AnimationInterface::LrWpanMacTxTrace ( std::string  context,
Ptr< const Packet p 
)
private

LR-WPAN MAC transmit trace function.

Parameters
contextthe context
pthe packet

Definition at line 700 of file animation-interface.cc.

References GetNodeFromContext(), and m_nodeLrWpanMacTx.

Referenced by ConnectCallbacks().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::AnimationInterface::LrWpanPhyRxBeginTrace ( std::string  context,
Ptr< const Packet p 
)
private

LR-WPAN Phy receive begin trace function.

Parameters
contextthe context
pthe packet

Definition at line 967 of file animation-interface.cc.

References CHECK_STARTED_INTIMEWINDOW_TRACKPACKETS, ns3::Packet::FindFirstMatchingByteTag(), GetAnimUidFromPacket(), GetNetDeviceFromContext(), IsPacketPending(), LRWPAN, m_pendingLrWpanPackets, ns3::Simulator::Now(), NS_ASSERT, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_WARN, OutputWirelessPacketRxInfo(), and UpdatePosition().

Referenced by ConnectCallbacks().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::AnimationInterface::LrWpanPhyTxBeginTrace ( std::string  context,
Ptr< const Packet p 
)
private

LR-WPAN Phy receive begin trace function.

Parameters
contextthe context
pthe packet

Definition at line 915 of file animation-interface.cc.

References AddByteTag(), AddPendingPacket(), CHECK_STARTED_INTIMEWINDOW_TRACKPACKETS, gAnimUid, GetNetDeviceFromContext(), ns3::LrWpanMacHeader::GetSrcAddrMode(), LRWPAN, m_macToNodeIdMap, m_pendingLrWpanPackets, ns3::Simulator::Now(), NS_ASSERT, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_WARN, OutputWirelessPacketTxInfo(), ns3::Packet::PeekHeader(), and UpdatePosition().

Referenced by ConnectCallbacks().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::AnimationInterface::LteRxTrace ( std::string  context,
Ptr< const Packet p,
const Mac48Address m 
)
private

LTE receive trace function.

Parameters
contextthe context
pthe packet
mthe MAC address

Definition at line 1064 of file animation-interface.cc.

References GenericWirelessRxTrace(), LTE, and NS_LOG_FUNCTION.

Referenced by ConnectCallbacks().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::AnimationInterface::LteSpectrumPhyRxStart ( std::string  context,
Ptr< const PacketBurst pb 
)
private

LTE Spectrum Phy receive start function.

Parameters
contextthe context
pbthe packet burst

Definition at line 1101 of file animation-interface.cc.

References CHECK_STARTED_INTIMEWINDOW_TRACKPACKETS, gAnimUid, GetAnimUidFromPacket(), GetNetDeviceFromContext(), IsPacketPending(), list, LTE, m_pendingLtePackets, ns3::Simulator::Now(), NS_ASSERT, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_WARN, OutputWirelessPacketRxInfo(), ns3::AnimationInterface::AnimPacketInfo::ProcessRxBegin(), and UpdatePosition().

Referenced by ConnectLteEnb(), and ConnectLteUe().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::AnimationInterface::LteSpectrumPhyTxStart ( std::string  context,
Ptr< const PacketBurst pb 
)
private

LTE Spectrum Phy transmit start function.

Parameters
contextthe context
pbthe packet burst

Definition at line 1071 of file animation-interface.cc.

References AddByteTag(), AddPendingPacket(), CHECK_STARTED_INTIMEWINDOW_TRACKPACKETS, gAnimUid, GetNetDeviceFromContext(), list, LTE, ns3::Simulator::Now(), NS_ASSERT, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_WARN, OutputWirelessPacketTxInfo(), and UpdatePosition().

Referenced by ConnectLteEnb(), and ConnectLteUe().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::AnimationInterface::LteTxTrace ( std::string  context,
Ptr< const Packet p,
const Mac48Address m 
)
private

LTE transmit trace function.

Parameters
contextthe context
pthe packet
mthe MAC address

Definition at line 1057 of file animation-interface.cc.

References GenericWirelessTxTrace(), LTE, and NS_LOG_FUNCTION.

Referenced by ConnectCallbacks().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::AnimationInterface::MobilityAutoCheck ( )
private

Mobility auto check function.

Definition at line 444 of file animation-interface.cc.

References CHECK_STARTED_INTIMEWINDOW, CSMA, ns3::Node::GetId(), GetMovedNodes(), GetPosition(), ns3::Simulator::IsFinished(), LRWPAN, LTE, m_mobilityPollInterval, NS_ASSERT, PurgePendingPackets(), ns3::Simulator::Schedule(), WAVE, WIFI, WIMAX, and WriteXmlUpdateNodePosition().

Referenced by StartAnimation().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::AnimationInterface::MobilityCourseChangeTrace ( Ptr< const MobilityModel mob)
private

Mobility course change trace function.

Parameters
mobthe mobility model

Definition at line 408 of file animation-interface.cc.

References CHECK_STARTED_INTIMEWINDOW, ns3::Node::GetId(), GetPosition(), NS_ASSERT, UpdatePosition(), and WriteXmlUpdateNodePosition().

Referenced by ConnectCallbacks().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool ns3::AnimationInterface::NodeHasMoved ( Ptr< Node n,
Vector  newLocation 
)
private

Node has moved function.

Parameters
nthe node
newLocationthe new location vector
Returns
true if the node has moved

Definition at line 427 of file animation-interface.cc.

References GetPosition().

Referenced by GetMovedNodes().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::AnimationInterface::OutputCsmaPacket ( Ptr< const Packet p,
AnimPacketInfo pktInfo 
)
private
void ns3::AnimationInterface::OutputWirelessPacketRxInfo ( Ptr< const Packet p,
AnimPacketInfo pktInfo,
uint64_t  animUid 
)
private

Output wireless packet receive info.

Parameters
pthe packet
pktInfothe packet info
animUidthe UID

Definition at line 1234 of file animation-interface.cc.

References CheckMaxPktsPerTraceFile(), ns3::Node::GetId(), ns3::NetDevice::GetNode(), ns3::AnimationInterface::AnimPacketInfo::m_fbRx, ns3::AnimationInterface::AnimPacketInfo::m_lbRx, ns3::AnimationInterface::AnimPacketInfo::m_rxnd, and WriteXmlP().

Referenced by GenericWirelessRxTrace(), LrWpanPhyRxBeginTrace(), LteSpectrumPhyRxStart(), WavePhyRxBeginTrace(), and WifiPhyRxBeginTrace().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::AnimationInterface::OutputWirelessPacketTxInfo ( Ptr< const Packet p,
AnimPacketInfo pktInfo,
uint64_t  animUid 
)
private

Output wireless packet transmit info.

Parameters
pthe packet
pktInfothe packet info
animUidthe UID

Definition at line 1218 of file animation-interface.cc.

References CheckMaxPktsPerTraceFile(), ns3::Node::GetId(), ns3::NetDevice::GetNode(), GetPacketMetadata(), m_enablePacketMetadata, ns3::AnimationInterface::AnimPacketInfo::m_fbTx, ns3::AnimationInterface::AnimPacketInfo::m_txnd, ns3::AnimationInterface::AnimPacketInfo::m_txNodeId, and WriteXmlPRef().

Referenced by GenericWirelessTxTrace(), LrWpanPhyTxBeginTrace(), and LteSpectrumPhyTxStart().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

AnimationInterface::AnimUidPacketInfoMap * ns3::AnimationInterface::ProtocolTypeToPendingPackets ( AnimationInterface::ProtocolType  protocolType)
private

Protocol type to pending packets function.

Parameters
protocolTypethe protocol type
Returns
AnimUidPacketInfoMap *

Definition at line 1306 of file animation-interface.cc.

References CSMA, LRWPAN, LTE, m_pendingCsmaPackets, m_pendingLrWpanPackets, m_pendingLtePackets, m_pendingUanPackets, m_pendingWavePackets, m_pendingWifiPackets, m_pendingWimaxPackets, UAN, WAVE, WIFI, and WIMAX.

Referenced by AddPendingPacket(), GenericWirelessRxTrace(), GenericWirelessTxTrace(), IsPacketPending(), and PurgePendingPackets().

+ Here is the caller graph for this function:

std::string ns3::AnimationInterface::ProtocolTypeToString ( AnimationInterface::ProtocolType  protocolType)
private

Protocol type to string function.

Parameters
protocolTypethe protocol type
Returns
the protocol type string

Definition at line 1352 of file animation-interface.cc.

References CSMA, LRWPAN, LTE, UAN, WAVE, WIFI, and WIMAX.

Referenced by GenericWirelessRxTrace(), and GenericWirelessTxTrace().

+ Here is the caller graph for this function:

void ns3::AnimationInterface::PurgePendingPackets ( AnimationInterface::ProtocolType  protocolType)
private

Purge pending packets function.

Parameters
protocolTypethe protocol type

Definition at line 1276 of file animation-interface.cc.

References ns3::Time::GetSeconds(), ns3::AnimationInterface::AnimPacketInfo::m_fbTx, ns3::Simulator::Now(), NS_ASSERT, ProtocolTypeToPendingPackets(), and PURGE_INTERVAL.

Referenced by MobilityAutoCheck().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::AnimationInterface::QueueDropTrace ( std::string  context,
Ptr< const Packet p 
)
private

Queue trace function.

Parameters
contextthe context
pthe packet

Definition at line 770 of file animation-interface.cc.

References GetNodeFromContext(), and m_nodeQueueDrop.

Referenced by ConnectCallbacks().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::AnimationInterface::RecursiveIpv4RoutePathSearch ( std::string  from,
std::string  to,
Ipv4RoutePathElements rpElements 
)
private

Recursive IPv4 route path search function.

Parameters
fromthe source node
tothe destination node
rpElementsthe IPv4 routing path elements

Definition at line 2315 of file animation-interface.cc.

References ns3::Socket::ERROR_NOROUTETOHOST, ns3::Ipv4Route::GetGateway(), ns3::Node::GetId(), ns3::NodeList::GetNode(), ns3::Object::GetObject(), ns3::Ipv4::GetRoutingProtocol(), m_ipv4ToNodeIdMap, NS_FATAL_ERROR, NS_LOG_DEBUG, NS_LOG_INFO, NS_LOG_WARN, and ns3::Ipv4Header::SetDestination().

Referenced by TrackIpv4RoutePaths().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::AnimationInterface::RemainingEnergyTrace ( std::string  context,
double  previousEnergy,
double  currentEnergy 
)
private

Remaining energy trace function.

Parameters
contextthe context
previousEnergyThe previous energy
currentEnergyThe current energy

Definition at line 637 of file animation-interface.cc.

References CHECK_STARTED_INTIMEWINDOW, GetNodeFromContext(), m_nodeEnergyFraction, m_remainingEnergyCounterId, NS_ASSERT, NS_LOG_INFO, and UpdateNodeCounter().

Referenced by ConnectCallbacks().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::AnimationInterface::ResetAnimWriteCallback ( )

Reset the write callback function.

Returns
none

Definition at line 283 of file animation-interface.cc.

References m_writeCallback.

Referenced by StopAnimation().

+ Here is the caller graph for this function:

void ns3::AnimationInterface::SetAnimWriteCallback ( AnimWriteCallback  cb)

Set a callback function to listen to AnimationInterface write events.

Parameters
cbAddress of callback function
Returns
none

Definition at line 277 of file