A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::AnimationInterface Class Reference

Interface to network animator. More...

#include <animation-interface.h>

+ Collaboration diagram for ns3::AnimationInterface:

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, bool enable3105=true, uint64_t maxPktsPerFile=MAX_PKTS_PER_TRACE_FILE)
 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...
 
int64_t AssignStreams (int64_t stream)
 Assign a fixed random variable stream number to the random variables used by this model. 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...
 
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 SetMobilityPollInterval (Time t)
 Set mobility poll interval:WARNING: setting a low interval can cause slowness. More...
 
void SetRandomPosition (bool setRandPos)
 Set random position if a Mobility Model does not exists for the node. 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 ShowNode (uint32_t nodeId, bool show=true)
 Helper function to show/hide a node. More...
 
void ShowNode (Ptr< Node > n, bool show=true)
 Helper function to show/hide a node. 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...
 
static void SetLinkDescription (uint32_t fromNode, uint32_t toNode, std::string linkDescription, std::string fromNodeDescription="", std::string toNodeDescription="")
 Helper function to set the description for a link. More...
 
static void SetLinkDescription (Ptr< Node > fromNode, Ptr< Node > toNode, std::string linkDescription, std::string fromNodeDescription="", std::string toNodeDescription="")
 Helper function to set the description for a link. More...
 
static void SetNodeColor (Ptr< Node > n, uint8_t r, uint8_t g, uint8_t b)
 Helper function to set the node color. More...
 
static void SetNodeColor (NodeContainer nc, uint8_t r, uint8_t g, uint8_t b)
 Helper function to set the color of nodes in a container. More...
 
static void SetNodeDescription (Ptr< Node > n, std::string descr)
 Helper function to set a brief description for a given node. More...
 
static void SetNodeDescription (NodeContainer nc, std::string descr)
 Helper function to set a brief description for nodes in a Node Container. More...
 

Private Types

typedef std::map< uint32_t,
double > 
EnergyFractionMap
 
typedef std::vector
< Ipv4RoutePathElement
Ipv4RoutePathElements
 

Private Member Functions

void AddPendingCsmaPacket (uint64_t AnimUid, AnimPacketInfo &)
 
void AddPendingLtePacket (uint64_t AnimUid, AnimPacketInfo &)
 
void AddPendingUanPacket (uint64_t AnimUid, AnimPacketInfo &)
 
void AddPendingWifiPacket (uint64_t AnimUid, AnimPacketInfo &)
 
void AddPendingWimaxPacket (uint64_t AnimUid, AnimPacketInfo &)
 
void AddToIpv4AddressNodeIdTable (std::string, uint32_t)
 
void AppendXMLNodeColor (std::ostream &ostream, const Rgb &color) const
 
void AppendXMLNodeDescription (std::ostream &ostream, uint32_t id) const
 
void AppendXMLRemainingEnergy (std::ostream &ostream, uint32_t id) const
 
void ConnectCallbacks ()
 
void ConnectLte ()
 
void ConnectLteEnb (Ptr< Node > n, Ptr< LteEnbNetDevice > nd, uint32_t devIndex)
 
void ConnectLteUe (Ptr< Node > n, Ptr< LteUeNetDevice > nd, uint32_t devIndex)
 
std::string CounterTypeToString (CounterType counterType)
 
void CsmaMacRxTrace (std::string context, Ptr< const Packet > p)
 
bool CsmaPacketIsPending (uint64_t AnimUid)
 
void CsmaPhyRxEndTrace (std::string context, Ptr< const Packet > p)
 
void CsmaPhyTxBeginTrace (std::string context, Ptr< const Packet > p)
 
void CsmaPhyTxEndTrace (std::string context, Ptr< const Packet > p)
 
void DevTxTrace (std::string context, Ptr< const Packet > p, Ptr< NetDevice > tx, Ptr< NetDevice > rx, Time txTime, Time rxTime)
 
uint64_t GetAnimUidFromPacket (Ptr< const Packet >)
 
const std::vector< std::string > GetElementsFromContext (const std::string &context) const
 
std::string GetIpv4Address (Ptr< NetDevice > nd)
 
std::string GetIpv4RoutingTable (Ptr< Node > n)
 
std::string GetMacAddress (Ptr< NetDevice > nd)
 
std::string GetNetAnimVersion ()
 
Ptr< NetDeviceGetNetDeviceFromContext (std::string context)
 
Ptr< NodeGetNodeFromContext (const std::string &context) const
 
std::string GetPacketMetadata (Ptr< const Packet > p)
 
Vector GetPosition (Ptr< Node > n)
 
std::string GetPreamble (void)
 
std::string GetXMLClose (std::string name)
 
std::string GetXMLOpen_anim (uint32_t lp)
 
std::string GetXMLOpen_packet (uint32_t fromLp, uint32_t fromId, double fbTx, double lbTx, std::string auxInfo="")
 
std::string GetXMLOpen_topology (double minX, double minY, double maxX, double maxY)
 
std::string GetXMLOpen_wpacket (uint32_t fromLp, uint32_t fromId, double fbTx, double lbTx, double range)
 
std::string GetXMLOpenClose_link (uint32_t fromLp, uint32_t fromId, uint32_t toLp, uint32_t toId)
 
std::string GetXMLOpenClose_linkupdate (uint32_t fromId, uint32_t toId, std::string)
 
std::string GetXMLOpenClose_meta (std::string metaInfo)
 
std::string GetXMLOpenClose_node (uint32_t lp, uint32_t id, double locX, double locY)
 
std::string GetXMLOpenClose_node (uint32_t lp, uint32_t id, double locX, double locY, struct Rgb rgb)
 
std::string GetXMLOpenClose_nodeupdate (uint32_t id, bool visible=true)
 
std::string GetXMLOpenClose_NonP2pLinkProperties (uint32_t id, std::string ipv4Address, std::string channelType)
 
std::string GetXMLOpenClose_p (std::string pktType, uint32_t fId, double fbTx, double lbTx, uint32_t tId, double fbRx, double lbRx, std::string metaInfo="", std::string auxInfo="")
 
std::string GetXMLOpenClose_routing (uint32_t id, std::string routingInfo)
 
std::string GetXMLOpenClose_rp (uint32_t nodeId, std::string destination, Ipv4RoutePathElements rpElements)
 
std::string GetXMLOpenClose_rx (uint32_t toLp, uint32_t toId, double fbRx, double lbRx)
 
std::string GetXMLOpenCloseAddNodeCounter (uint32_t counterId, std::string counterName, CounterType counterType)
 
std::string GetXMLOpenCloseAddResource (uint32_t resourceId, std::string resourcePath)
 
std::string GetXMLOpenCloseUpdateBackground (std::string fileName, double x, double y, double scaleX, double scaleY, double opacity)
 
std::string GetXMLOpenCloseUpdateNodeColor (uint32_t nodeId, uint8_t r, uint8_t g, uint8_t b)
 
std::string GetXMLOpenCloseUpdateNodeCounter (uint32_t counterId, uint32_t nodeId, double value)
 
std::string GetXMLOpenCloseUpdateNodeDescription (uint32_t nodeId)
 
std::string GetXMLOpenCloseUpdateNodeImage (uint32_t nodeId, uint32_t resourceId)
 
std::string GetXMLOpenCloseUpdateNodePosition (uint32_t nodeId, double x, double y)
 
std::string GetXMLOpenCloseUpdateNodeSize (uint32_t nodeId, double width, double height)
 
bool IsInTimeWindow ()
 
bool LtePacketIsPending (uint64_t AnimUid)
 
void LteRxTrace (std::string context, Ptr< const Packet > p, const Mac48Address &)
 
void LteSpectrumPhyRxStart (std::string context, Ptr< const PacketBurst > pb)
 
void LteSpectrumPhyTxStart (std::string context, Ptr< const PacketBurst > pb)
 
void LteTxTrace (std::string context, Ptr< const Packet > p, const Mac48Address &)
 
void MobilityAutoCheck ()
 
void MobilityCourseChangeTrace (Ptr< const MobilityModel > mob)
 
bool NodeHasMoved (Ptr< Node > n, Vector newLocation)
 
void OutputCsmaPacket (Ptr< const Packet > p, AnimPacketInfo &pktInfo, AnimRxInfo pktrxInfo)
 
void OutputWirelessPacket (Ptr< const Packet > p, AnimPacketInfo &pktInfo, AnimRxInfo pktrxInfo)
 
void PurgePendingCsma ()
 
void PurgePendingLte ()
 
void PurgePendingWifi ()
 
void PurgePendingWimax ()
 
void RecalcTopoBounds (Vector v)
 
std::vector< Ptr< Node > > RecalcTopoBounds ()
 
void RecursiveIpv4RoutePathSearch (std::string fromIpv4, std::string toIpv4, Ipv4RoutePathElements &)
 
void RemainingEnergyTrace (std::string context, double previousEnergy, double currentEnergy)
 
bool SetOutputFile (const std::string &fn)
 Specify that animation commands are to be written to the specified output file. More...
 
bool SetRoutingOutputFile (const std::string &fn)
 
void SetXMLOutput ()
 Specify that animation commands are to be written in XML format. More...
 
void StartAnimation (bool restart=false)
 Writes the topology information and sets up the appropriate animation packet tx callback. More...
 
void StartNewTraceFile ()
 
void StopAnimation (bool onlyAnimation=false)
 Closes the interface to the animator. More...
 
void TrackIpv4Route ()
 
void TrackIpv4RoutePaths ()
 
bool UanPacketIsPending (uint64_t AnimUid)
 
void UanPhyGenRxTrace (std::string context, Ptr< const Packet >)
 
void UanPhyGenTxTrace (std::string context, Ptr< const Packet >)
 
Vector UpdatePosition (Ptr< Node > n)
 
Vector UpdatePosition (Ptr< Node > n, Vector v)
 
void WifiMacRxTrace (std::string context, Ptr< const Packet > p)
 
bool WifiPacketIsPending (uint64_t AnimUid)
 
void WifiPhyRxBeginTrace (std::string context, Ptr< const Packet > p)
 
void WifiPhyRxDropTrace (std::string context, Ptr< const Packet > p)
 
void WifiPhyRxEndTrace (std::string context, Ptr< const Packet > p)
 
void WifiPhyTxBeginTrace (std::string context, Ptr< const Packet > p)
 
void WifiPhyTxDropTrace (std::string context, Ptr< const Packet > p)
 
void WifiPhyTxEndTrace (std::string context, Ptr< const Packet > p)
 
bool WimaxPacketIsPending (uint64_t AnimUid)
 
void WimaxRxTrace (std::string context, Ptr< const Packet > p, const Mac48Address &)
 
void WimaxTxTrace (std::string context, Ptr< const Packet > p, const Mac48Address &)
 
void WriteDummyPacket ()
 
int WriteN (const char *, uint32_t, FILE *f)
 
int WriteN (const std::string &, FILE *f)
 
void WriteNodeUpdate (uint32_t nodeId)
 
void WriteNonP2pLinkProperties (uint32_t id, std::string ipv4Address, std::string channelType)
 
void WriteRoutePath (uint32_t nodeId, std::string destination, Ipv4RoutePathElements rpElements)
 

Private Attributes

uint64_t gAnimUid
 
uint64_t m_currentPktCount
 
bool m_enable3105
 
bool m_enablePacketMetadata
 
FILE * m_f
 
std::vector
< Ipv4RouteTrackElement
m_ipv4RouteTrackElements
 
std::map< std::string, uint32_t > m_ipv4ToNodeIdMap
 
std::map< std::string, uint32_t > m_macToNodeIdMap
 
uint64_t m_maxPktsPerFile
 
Time m_mobilityPollInterval
 
std::vector< std::string > m_nodeCounters
 
EnergyFractionMap m_nodeEnergyFraction
 
std::map< uint32_t, Vectorm_nodeLocation
 
std::map< uint32_t, NodeSizem_nodeSizes
 
std::string m_originalFileName
 
std::string m_outputFileName
 
bool m_outputFileSet
 
std::map< uint64_t,
AnimPacketInfo
m_pendingCsmaPackets
 
std::map< uint64_t,
AnimPacketInfo
m_pendingLtePackets
 
std::map< uint64_t,
AnimPacketInfo
m_pendingUanPackets
 
std::map< uint64_t,
AnimPacketInfo
m_pendingWifiPackets
 
std::map< uint64_t,
AnimPacketInfo
m_pendingWimaxPackets
 
bool m_randomPosition
 
uint32_t m_remainingEnergyCounterId
 
std::vector< std::string > m_resources
 
FILE * m_routingF
 
std::string m_routingFileName
 
NodeContainer m_routingNc
 
Time m_routingPollInterval
 
Time m_routingStopTime
 
bool m_started
 
Time m_startTime
 
Time m_stopTime
 
double m_topoMaxX
 
double m_topoMaxY
 
double m_topoMinX
 
double m_topoMinY
 
bool m_trackPackets
 
Ptr< UniformRandomVariablem_uniformRandomVariable
 Provides uniform random variables. More...
 
AnimWriteCallback m_writeCallback
 

Static Private Attributes

static std::map
< P2pLinkNodeIdPair,
LinkProperties,
LinkPairCompare
linkProperties
 
static std::map< uint32_t, RgbnodeColors
 
static std::map< uint32_t,
std::string > 
nodeDescriptions
 

Detailed Description

Interface to network animator.

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

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

Member Typedef Documentation

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

typedef for WriteCallBack used for listening to AnimationInterface write messages

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

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

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

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

Member Enumeration Documentation

Counter Types.

Enumerator
UINT32_COUNTER 
DOUBLE_COUNTER 

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

Constructor & Destructor Documentation

ns3::AnimationInterface::AnimationInterface ( const std::string  filename,
bool  enable3105 = true,
uint64_t  maxPktsPerFile = MAX_PKTS_PER_TRACE_FILE 
)

Constructor.

Parameters
filenameThe Filename for the trace file used by the Animator
enable3105Enables 3.105 behavior. This flag will be made obsolete after the transition period
maxPktsPerFileThe maximum number of packets per trace file. AnimationInterface will create trace files with the following filenames : filename, filename-1, filename-2..., filename-N where each file contains packet info for 'maxPktPerFile' number of packets

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

References ns3::initialized, m_uniformRandomVariable, and StartAnimation().

+ Here is the call graph for this function:

ns3::AnimationInterface::~AnimationInterface ( )

Destructor for the animator interface.

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

References StopAnimation().

+ Here is the call graph for this function:

Member Function Documentation

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 328 of file animation-interface.cc.

References GetXMLOpenCloseAddNodeCounter(), m_f, m_nodeCounters, and WriteN().

Referenced by main(), and StartAnimation().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::AnimationInterface::AddPendingCsmaPacket ( uint64_t  AnimUid,
AnimPacketInfo pktinfo 
)
private

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

References m_pendingCsmaPackets, ns3::AnimPacketInfo::m_txnd, and NS_ASSERT.

Referenced by CsmaPhyTxBeginTrace(), and CsmaPhyTxEndTrace().

+ Here is the caller graph for this function:

void ns3::AnimationInterface::AddPendingLtePacket ( uint64_t  AnimUid,
AnimPacketInfo pktinfo 
)
private

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

References m_pendingLtePackets, ns3::AnimPacketInfo::m_txnd, and NS_ASSERT.

Referenced by LteSpectrumPhyTxStart(), and LteTxTrace().

+ Here is the caller graph for this function:

void ns3::AnimationInterface::AddPendingUanPacket ( uint64_t  AnimUid,
AnimPacketInfo pktinfo 
)
private

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

References m_pendingUanPackets.

Referenced by UanPhyGenTxTrace().

+ Here is the caller graph for this function:

void ns3::AnimationInterface::AddPendingWifiPacket ( uint64_t  AnimUid,
AnimPacketInfo pktinfo 
)
private

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

References m_pendingWifiPackets.

Referenced by WifiPhyRxBeginTrace(), WifiPhyRxEndTrace(), and WifiPhyTxBeginTrace().

+ Here is the caller graph for this function:

void ns3::AnimationInterface::AddPendingWimaxPacket ( uint64_t  AnimUid,
AnimPacketInfo pktinfo 
)
private

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

References m_pendingWimaxPackets, ns3::AnimPacketInfo::m_txnd, and NS_ASSERT.

Referenced by WimaxTxTrace().

+ 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 338 of file animation-interface.cc.

References GetXMLOpenCloseAddResource(), m_f, m_resources, and WriteN().

Referenced by main().

+ Here is the call graph for this function:

+ Here is the caller 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 767 of file animation-interface.cc.

References m_ipv4RouteTrackElements.

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

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

References m_ipv4ToNodeIdMap.

Referenced by StartAnimation().

+ Here is the caller graph for this function:

void ns3::AnimationInterface::AppendXMLNodeColor ( std::ostream &  ostream,
const Rgb color 
) const
private

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

References ns3::Rgb::b, ns3::Rgb::g, and ns3::Rgb::r.

Referenced by GetXMLOpenClose_node(), and GetXMLOpenClose_nodeupdate().

+ Here is the caller graph for this function:

void ns3::AnimationInterface::AppendXMLNodeDescription ( std::ostream &  ostream,
uint32_t  id 
) const
private

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

References nodeDescriptions.

Referenced by GetXMLOpenClose_node(), and GetXMLOpenClose_nodeupdate().

+ Here is the caller graph for this function:

void ns3::AnimationInterface::AppendXMLRemainingEnergy ( std::ostream &  ostream,
uint32_t  id 
) const
private

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

References ns3::NodeList::GetNode(), ns3::Object::GetObject(), and m_nodeEnergyFraction.

Referenced by GetXMLOpenClose_node(), and GetXMLOpenClose_nodeupdate().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

int64_t ns3::AnimationInterface::AssignStreams ( int64_t  stream)

Assign a fixed random variable stream number to the random variables used by this model.

Return the number of streams (possibly zero) that have been assigned.

Parameters
streamfirst stream index to use
Returns
the number of stream indices assigned by this model

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

References m_uniformRandomVariable, NS_LOG_FUNCTION, and ns3::RandomVariableStream::SetStream().

+ Here is the call graph for this function:

void ns3::AnimationInterface::ConnectLte ( )
private

Definition at line 819 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

Definition at line 775 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

Definition at line 798 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

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

References DOUBLE_COUNTER, and UINT32_COUNTER.

Referenced by GetXMLOpenCloseAddNodeCounter().

+ Here is the caller graph for this function:

void ns3::AnimationInterface::CsmaMacRxTrace ( std::string  context,
Ptr< const Packet p 
)
private
Todo:
NS_ASSERT (CsmaPacketIsPending (AnimUid) == true);

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

References CsmaPacketIsPending(), GetAnimUidFromPacket(), GetNetDeviceFromContext(), ns3::AnimPacketInfo::GetRxInfo(), IsInTimeWindow(), ns3::AnimRxInfo::IsPhyRxComplete(), m_pendingCsmaPackets, m_started, m_trackPackets, 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:

bool ns3::AnimationInterface::CsmaPacketIsPending ( uint64_t  AnimUid)
private

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

References m_pendingCsmaPackets.

Referenced by CsmaMacRxTrace(), CsmaPhyRxEndTrace(), and CsmaPhyTxEndTrace().

+ Here is the caller graph for this function:

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

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

References ns3::Packet::AddByteTag(), AddPendingCsmaPacket(), gAnimUid, GetNetDeviceFromContext(), IsInTimeWindow(), m_started, m_trackPackets, ns3::Simulator::Now(), NS_ASSERT, NS_LOG_INFO, ns3::AnimByteTag::Set(), 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
Todo:
NS_ASSERT (CsmaPacketIsPending (AnimUid) == true);

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

References AddPendingCsmaPacket(), CsmaPacketIsPending(), GetAnimUidFromPacket(), GetNetDeviceFromContext(), ns3::Time::GetSeconds(), IsInTimeWindow(), ns3::AnimPacketInfo::m_lbTx, m_pendingCsmaPackets, m_started, m_trackPackets, ns3::Simulator::Now(), NS_ASSERT, 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::DevTxTrace ( std::string  context,
Ptr< const Packet p,
Ptr< NetDevice tx,
Ptr< NetDevice rx,
Time  txTime,
Time  rxTime 
)
private

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

References GetPacketMetadata(), ns3::Time::GetSeconds(), GetXMLOpenClose_p(), IsInTimeWindow(), m_currentPktCount, m_enablePacketMetadata, m_f, m_started, m_trackPackets, ns3::Simulator::Now(), NS_ASSERT, StartNewTraceFile(), and WriteN().

Referenced by ConnectCallbacks().

+ 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,
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 92 of file animation-interface.cc.

References GetXMLOpen_anim(), m_routingF, m_routingFileName, m_routingPollInterval, m_routingStopTime, ns3::Simulator::Schedule(), SetRoutingOutputFile(), stopTime, TrackIpv4Route(), and WriteN().

Referenced by EnableIpv4RouteTracking(), and main().

+ 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 103 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

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

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

Referenced by main().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

const std::vector< std::string > ns3::AnimationInterface::GetElementsFromContext ( const std::string &  context) const
private

Definition at line 2334 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

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

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

Referenced by StartAnimation().

+ 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

Definition at line 109 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::GetMacAddress ( Ptr< NetDevice nd)
private

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

Referenced by StartAnimation().

+ Here is the caller graph for this function:

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

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

Referenced by GetXMLOpen_anim().

+ Here is the caller graph for this function:

Ptr< NetDevice > ns3::AnimationInterface::GetNetDeviceFromContext ( std::string  context)
private
double ns3::AnimationInterface::GetNodeEnergyFraction ( Ptr< const Node node) const

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

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

Definition at line 1679 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

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

References GetElementsFromContext(), ns3::NodeList::GetNode(), and NS_ASSERT.

Referenced by GetNetDeviceFromContext(), and RemainingEnergyTrace().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

std::string ns3::AnimationInterface::GetPacketMetadata ( Ptr< const Packet p)
private

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

References ns3::Packet::Print().

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

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

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

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

Referenced by MobilityAutoCheck(), MobilityCourseChangeTrace(), NodeHasMoved(), RecalcTopoBounds(), and StartAnimation().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

std::string ns3::AnimationInterface::GetPreamble ( void  )
private

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

References s.

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 1674 of file animation-interface.cc.

References m_currentPktCount.

Referenced by AnimationInterfaceTestCase::CheckLogic().

+ Here is the caller graph for this function:

std::string ns3::AnimationInterface::GetXMLClose ( std::string  name)
inlineprivate

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

Referenced by StopAnimation().

+ Here is the caller graph for this function:

std::string ns3::AnimationInterface::GetXMLOpen_anim ( uint32_t  lp)
private

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

References GetNetAnimVersion().

Referenced by EnableIpv4RouteTracking(), and StartAnimation().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

std::string ns3::AnimationInterface::GetXMLOpen_packet ( uint32_t  fromLp,
uint32_t  fromId,
double  fbTx,
double  lbTx,
std::string  auxInfo = "" 
)
private

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

std::string ns3::AnimationInterface::GetXMLOpen_topology ( double  minX,
double  minY,
double  maxX,
double  maxY 
)
private
std::string ns3::AnimationInterface::GetXMLOpen_wpacket ( uint32_t  fromLp,
uint32_t  fromId,
double  fbTx,
double  lbTx,
double  range 
)
private

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

std::string ns3::AnimationInterface::GetXMLOpenClose_link ( uint32_t  fromLp,
uint32_t  fromId,
uint32_t  toLp,
uint32_t  toId 
)
private

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

References ns3::LinkProperties::fromNodeDescription, ns3::LinkProperties::linkDescription, linkProperties, and ns3::LinkProperties::toNodeDescription.

Referenced by StartAnimation().

+ Here is the caller graph for this function:

std::string ns3::AnimationInterface::GetXMLOpenClose_linkupdate ( uint32_t  fromId,
uint32_t  toId,
std::string  linkDescription 
)
private

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

References ns3::Time::GetSeconds(), and ns3::Simulator::Now().

Referenced by UpdateLinkDescription().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

std::string ns3::AnimationInterface::GetXMLOpenClose_meta ( std::string  metaInfo)
private

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

std::string ns3::AnimationInterface::GetXMLOpenClose_node ( uint32_t  lp,
uint32_t  id,
double  locX,
double  locY 
)
private

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

References AppendXMLNodeDescription(), and AppendXMLRemainingEnergy().

Referenced by MobilityAutoCheck(), MobilityCourseChangeTrace(), and StartAnimation().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

std::string ns3::AnimationInterface::GetXMLOpenClose_node ( uint32_t  lp,
uint32_t  id,
double  locX,
double  locY,
struct Rgb  rgb 
)
private

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

References AppendXMLNodeColor(), AppendXMLNodeDescription(), and AppendXMLRemainingEnergy().

+ Here is the call graph for this function:

std::string ns3::AnimationInterface::GetXMLOpenClose_nodeupdate ( uint32_t  id,
bool  visible = true 
)
private

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

References AppendXMLNodeColor(), AppendXMLNodeDescription(), AppendXMLRemainingEnergy(), ns3::Time::GetSeconds(), nodeColors, and ns3::Simulator::Now().

Referenced by UpdateNodeDescription(), and WriteNodeUpdate().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

std::string ns3::AnimationInterface::GetXMLOpenClose_NonP2pLinkProperties ( uint32_t  id,
std::string  ipv4Address,
std::string  channelType 
)
private

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

Referenced by WriteNonP2pLinkProperties().

+ Here is the caller graph for this function:

std::string ns3::AnimationInterface::GetXMLOpenClose_p ( std::string  pktType,
uint32_t  fId,
double  fbTx,
double  lbTx,
uint32_t  tId,
double  fbRx,
double  lbRx,
std::string  metaInfo = "",
std::string  auxInfo = "" 
)
private

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

Referenced by DevTxTrace(), OutputCsmaPacket(), OutputWirelessPacket(), and WriteDummyPacket().

+ Here is the caller graph for this function:

std::string ns3::AnimationInterface::GetXMLOpenClose_routing ( uint32_t  id,
std::string  routingInfo 
)
private

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

References ns3::Time::GetSeconds(), and ns3::Simulator::Now().

Referenced by TrackIpv4Route().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

std::string ns3::AnimationInterface::GetXMLOpenClose_rp ( uint32_t  nodeId,
std::string  destination,
Ipv4RoutePathElements  rpElements 
)
private

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

References ns3::Time::GetSeconds(), ns3::Ipv4RoutePathElement::nextHop, ns3::Ipv4RoutePathElement::nodeId, and ns3::Simulator::Now().

Referenced by WriteRoutePath().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

std::string ns3::AnimationInterface::GetXMLOpenClose_rx ( uint32_t  toLp,
uint32_t  toId,
double  fbRx,
double  lbRx 
)
private

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

std::string ns3::AnimationInterface::GetXMLOpenCloseAddNodeCounter ( uint32_t  counterId,
std::string  counterName,
CounterType  counterType 
)
private

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

References CounterTypeToString().

Referenced by AddNodeCounter().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

std::string ns3::AnimationInterface::GetXMLOpenCloseAddResource ( uint32_t  resourceId,
std::string  resourcePath 
)
private

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

Referenced by AddResource().

+ Here is the caller graph for this function:

std::string ns3::AnimationInterface::GetXMLOpenCloseUpdateBackground ( std::string  fileName,
double  x,
double  y,
double  scaleX,
double  scaleY,
double  opacity 
)
private

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

Referenced by SetBackgroundImage().

+ Here is the caller graph for this function:

std::string ns3::AnimationInterface::GetXMLOpenCloseUpdateNodeColor ( uint32_t  nodeId,
uint8_t  r,
uint8_t  g,
uint8_t  b 
)
private

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

References ns3::Time::GetSeconds(), and ns3::Simulator::Now().

Referenced by UpdateNodeColor().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

std::string ns3::AnimationInterface::GetXMLOpenCloseUpdateNodeCounter ( uint32_t  counterId,
uint32_t  nodeId,
double  value 
)
private

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

References ns3::Time::GetSeconds(), and ns3::Simulator::Now().

Referenced by UpdateNodeCounter().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

std::string ns3::AnimationInterface::GetXMLOpenCloseUpdateNodeDescription ( uint32_t  nodeId)
private

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

References ns3::Time::GetSeconds(), nodeDescriptions, and ns3::Simulator::Now().

Referenced by UpdateNodeDescription().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

std::string ns3::AnimationInterface::GetXMLOpenCloseUpdateNodeImage ( uint32_t  nodeId,
uint32_t  resourceId 
)
private

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

References ns3::Time::GetSeconds(), and ns3::Simulator::Now().

Referenced by UpdateNodeImage().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

std::string ns3::AnimationInterface::GetXMLOpenCloseUpdateNodePosition ( uint32_t  nodeId,
double  x,
double  y 
)
private

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

References ns3::Time::GetSeconds(), and ns3::Simulator::Now().

Referenced by MobilityAutoCheck(), and MobilityCourseChangeTrace().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

std::string ns3::AnimationInterface::GetXMLOpenCloseUpdateNodeSize ( uint32_t  nodeId,
double  width,
double  height 
)
private

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

References ns3::Time::GetSeconds(), and ns3::Simulator::Now().

Referenced by UpdateNodeSize().

+ 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 389 of file animation-interface.cc.

References ns3::initialized.

bool ns3::AnimationInterface::IsStarted ( void  )

Is AnimationInterface started.

Returns
true if AnimationInterface was started

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

References m_started.

bool ns3::AnimationInterface::LtePacketIsPending ( uint64_t  AnimUid)
private

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

References m_pendingLtePackets.

Referenced by LteRxTrace(), and LteSpectrumPhyRxStart().

+ Here is the caller graph for this function:

void ns3::AnimationInterface::LteRxTrace ( std::string  context,
Ptr< const Packet p,
const Mac48Address m 
)
private
void ns3::AnimationInterface::LteSpectrumPhyRxStart ( std::string  context,
Ptr< const PacketBurst pb 
)
private
void ns3::AnimationInterface::LteSpectrumPhyTxStart ( std::string  context,
Ptr< const PacketBurst pb 
)
private
Todo:
0.0001 is used until Lte implements TxBegin and TxEnd traces

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

References ns3::Packet::AddByteTag(), AddPendingLtePacket(), gAnimUid, GetNetDeviceFromContext(), IsInTimeWindow(), list, m_started, m_trackPackets, ns3::Simulator::Now(), NS_ASSERT, NS_LOG_INFO, NS_LOG_WARN, ns3::AnimByteTag::Set(), 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
Todo:
0.0001 is used until Lte implements TxBegin and TxEnd traces

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

References ns3::Packet::AddByteTag(), AddPendingLtePacket(), gAnimUid, GetNetDeviceFromContext(), IsInTimeWindow(), m_started, m_trackPackets, ns3::Simulator::Now(), NS_ASSERT, NS_LOG_INFO, ns3::AnimByteTag::Set(), and UpdatePosition().

Referenced by ConnectCallbacks().

+ 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
bool ns3::AnimationInterface::NodeHasMoved ( Ptr< Node n,
Vector  newLocation 
)
private

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

References GetPosition(), ns3::Vector3D::x, and ns3::Vector3D::y.

Referenced by RecalcTopoBounds().

+ 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,
AnimRxInfo  pktrxInfo 
)
private
void ns3::AnimationInterface::PurgePendingCsma ( )
private

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

References ns3::Time::GetSeconds(), ns3::AnimPacketInfo::m_fbTx, m_pendingCsmaPackets, ns3::Simulator::Now(), 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::PurgePendingLte ( )
private

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

References ns3::Time::GetSeconds(), ns3::AnimPacketInfo::m_fbTx, m_pendingLtePackets, ns3::Simulator::Now(), 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::PurgePendingWifi ( )
private

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

References ns3::Time::GetSeconds(), ns3::AnimPacketInfo::m_fbTx, m_pendingWifiPackets, ns3::Simulator::Now(), 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::PurgePendingWimax ( )
private

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

References ns3::Time::GetSeconds(), ns3::AnimPacketInfo::m_fbTx, m_pendingWimaxPackets, ns3::Simulator::Now(), 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::RecalcTopoBounds ( Vector  v)
private
std::vector< Ptr< Node > > ns3::AnimationInterface::RecalcTopoBounds ( )
private

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

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

Referenced by MobilityAutoCheck(), and MobilityCourseChangeTrace().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::AnimationInterface::RecursiveIpv4RoutePathSearch ( std::string  fromIpv4,
std::string  toIpv4,
Ipv4RoutePathElements rpElements 
)
private
void ns3::AnimationInterface::RemainingEnergyTrace ( std::string  context,
double  previousEnergy,
double  currentEnergy 
)
private

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

References GetNodeFromContext(), IsInTimeWindow(), m_enable3105, m_nodeEnergyFraction, m_remainingEnergyCounterId, m_started, NS_ASSERT, NS_LOG_INFO, UpdateNodeCounter(), and WriteNodeUpdate().

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.

Definition at line 405 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

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

References m_writeCallback.

void ns3::AnimationInterface::SetBackgroundImage ( std::string  fileName,
double  x,
double  y,
double  scaleX,
double  scaleY,
double  opacity 
)

Helper function to set the background image.

Parameters
fileNameFile name of the background image
xX co-ordinate of the image
yY co-ordinate of the image
scaleXX scale of the image
scaleYY scale of the image
opacityOpacity of the background: A value between 0.0 and 1.0. 0.0 is transparent, 1.0 is opaque

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

References GetXMLOpenCloseUpdateBackground(), m_f, NS_FATAL_ERROR, and WriteN().

Referenced by main().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::AnimationInterface::SetConstantPosition ( Ptr< Node n,
double  x,
double  y,
double  z = 0 
)
static

Helper function to set Constant Position for a given node.

Parameters
nPtr to the node
xX co-ordinate of the node
yY co-ordinate of the node
zZ co-ordinate of the node

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

References ns3::Object::AggregateObject(), ns3::Node::GetId(), ns3::Object::GetObject(), NS_ASSERT, and NS_LOG_INFO.

Referenced by main().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::AnimationInterface::SetLinkDescription ( uint32_t  fromNode,
uint32_t  toNode,