ns3::AnimationInterface Class Reference

Interface to network animator. More...

#include <animation-interface.h>

List of all members.

Public Member Functions
	AnimationInterface ()
	Construct the animator interface. No arguments needed.
bool	SetOutputFile (const std::string &fn)
	Specify that animation commands are to be written to the specified output file.
bool	SetServerPort (uint16_t port)
	Specify that animation commands are to be written to a socket.
bool	SetInternalAnimation ()
	Specify that animation window is to be created as part of the ns3 process.
void	StartAnimation ()
	Writes the topology information and sets up the appropriate animation packet tx callback.
void	StopAnimation ()
	Closes the interface to the animator.

---

Detailed Description

Interface to network animator.

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

---

Member Function Documentation

bool ns3::AnimationInterface::SetInternalAnimation

(

)

Specify that animation window is to be created as part of the ns3 process.

This call is used to set the ns3 animator internal to the current process. This will fail if the ns3 library was built without the QT4 developer packages.

Returns:

true if animation started, false if failed.

bool ns3::AnimationInterface::SetOutputFile

(

const std::string &

fn

)

Specify that animation commands are to be written to the specified output file.

This call is used to write the animation information to a text file that can later be used as input to the network animator tool.

Parameters:

fn

The name of the output file.

Returns:

true if successful open.

bool ns3::AnimationInterface::SetServerPort

(

uint16_t

port

)

Specify that animation commands are to be written to a socket.

This call is used to set the ns3 process in server mode, waiting for a TCP connection from the animator. This call will not return until the animator connects in, or if the bind to the specified port fails.

Parameters:

port

Port number to bind to.

Returns:

true if connection created, false if bind failed.

void ns3::AnimationInterface::StartAnimation

(

)

Writes the topology information and sets up the appropriate animation packet tx callback.

Writes the topology information to the appropriate output, depending on prior calls to SetOutputFile, SetServerPort, or SetInternalAnimation. Then creates the callbacks needed for the animator to start processing packets.

---

The documentation for this class was generated from the following file:

• src/contrib/net-anim/animation-interface.h