Base class providing common user-level ascii trace operations for helpers representing net devices. More...

#include "trace-helper.h"

Inheritance diagram for ns3::AsciiTraceHelperForDevice:

Public Member Functions
	AsciiTraceHelperForDevice ()
	Construct an AsciiTraceHelperForDevice.

virtual	~AsciiTraceHelperForDevice ()
	Destroy an AsciiTraceHelperForDevice.

void	EnableAscii (Ptr< OutputStreamWrapper > stream, NetDeviceContainer d)
	Enable ascii trace output on each device in the container which is of the appropriate type.

void	EnableAscii (Ptr< OutputStreamWrapper > stream, NodeContainer n)
	Enable ascii trace output on each device (which is of the appropriate type) in the nodes provided in the container.

void	EnableAscii (Ptr< OutputStreamWrapper > stream, Ptr< NetDevice > nd)
	Enable ascii trace output on the indicated net device.

void	EnableAscii (Ptr< OutputStreamWrapper > stream, std::string ndName)
	Enable ascii trace output the indicated net device using a device previously named using the ns-3 object name service.

void	EnableAscii (Ptr< OutputStreamWrapper > stream, uint32_t nodeid, uint32_t deviceid)
	Enable ascii trace output on the device specified by a global node-id (of a previously created node) and associated device-id.

void	EnableAscii (std::string prefix, NetDeviceContainer d)
	Enable ascii trace output on each device in the container which is of the appropriate type.

void	EnableAscii (std::string prefix, NodeContainer n)
	Enable ascii trace output on each device (which is of the appropriate type) in the nodes provided in the container.

void	EnableAscii (std::string prefix, Ptr< NetDevice > nd, bool explicitFilename=false)
	Enable ascii trace output on the indicated net device.

void	EnableAscii (std::string prefix, std::string ndName, bool explicitFilename=false)
	Enable ascii trace output the indicated net device using a device previously named using the ns-3 object name service.

void	EnableAscii (std::string prefix, uint32_t nodeid, uint32_t deviceid, bool explicitFilename)
	Enable ascii trace output on the device specified by a global node-id (of a previously created node) and associated device-id.

void	EnableAsciiAll (Ptr< OutputStreamWrapper > stream)
	Enable ascii trace output on each device (which is of the appropriate type) in the set of all nodes created in the simulation.

void	EnableAsciiAll (std::string prefix)
	Enable ascii trace output on each device (which is of the appropriate type) in the set of all nodes created in the simulation.

virtual void	EnableAsciiInternal (Ptr< OutputStreamWrapper > stream, std::string prefix, Ptr< NetDevice > nd, bool explicitFilename)=0
	Enable ascii trace output on the indicated net device.

Private Member Functions
void	EnableAsciiImpl (Ptr< OutputStreamWrapper > stream, std::string prefix, NetDeviceContainer d)
	Enable ascii trace output on each device in the container which is of the appropriate type (implementation).

void	EnableAsciiImpl (Ptr< OutputStreamWrapper > stream, std::string prefix, NodeContainer n)
	Enable ascii trace output on each device (which is of the appropriate type) in the nodes provided in the container (implementation).

void	EnableAsciiImpl (Ptr< OutputStreamWrapper > stream, std::string prefix, Ptr< NetDevice > nd, bool explicitFilename)
	Enable ascii trace output the indicated net device (implementation).

void	EnableAsciiImpl (Ptr< OutputStreamWrapper > stream, std::string prefix, std::string ndName, bool explicitFilename)
	Enable ascii trace output the indicated net device using a device previously named using the ns-3 object name service (implementation).

void	EnableAsciiImpl (Ptr< OutputStreamWrapper > stream, std::string prefix, uint32_t nodeid, uint32_t deviceid, bool explicitFilename)
	Enable ascii trace output on the device specified by a global node-id (of a previously created node) and associated device-id (implementation)

Detailed Description

Base class providing common user-level ascii trace operations for helpers representing net devices.

Definition at line 728 of file trace-helper.h.

Constructor & Destructor Documentation

◆ AsciiTraceHelperForDevice()

ns3::AsciiTraceHelperForDevice::AsciiTraceHelperForDevice ( )

inline

Construct an AsciiTraceHelperForDevice.

Definition at line 734 of file trace-helper.h.

◆ ~AsciiTraceHelperForDevice()

virtual ns3::AsciiTraceHelperForDevice::~AsciiTraceHelperForDevice ( )

inlinevirtual

Destroy an AsciiTraceHelperForDevice.

Definition at line 741 of file trace-helper.h.

Member Function Documentation

◆ EnableAscii() [1/10]

void ns3::AsciiTraceHelperForDevice::EnableAscii	(	Ptr< OutputStreamWrapper >	stream,
		NetDeviceContainer	d
	)

Enable ascii trace output on each device in the container which is of the appropriate type.

Parameters

stream	An OutputStreamWrapper representing an existing file to use when writing trace data.
d	container of devices

Definition at line 557 of file trace-helper.cc.

◆ EnableAscii() [2/10]

void ns3::AsciiTraceHelperForDevice::EnableAscii	(	Ptr< OutputStreamWrapper >	stream,
		NodeContainer	n
	)

Enable ascii trace output on each device (which is of the appropriate type) in the nodes provided in the container.

Parameters

stream	An OutputStreamWrapper representing an existing file to use when writing trace data.
n	container of nodes.

Definition at line 590 of file trace-helper.cc.

◆ EnableAscii() [3/10]

void ns3::AsciiTraceHelperForDevice::EnableAscii	(	Ptr< OutputStreamWrapper >	stream,
		Ptr< NetDevice >	nd
	)

Enable ascii trace output on the indicated net device.

Parameters

stream	An OutputStreamWrapper representing an existing file to use when writing trace data.
nd	Net device for which you want to enable tracing.

Definition at line 506 of file trace-helper.cc.

◆ EnableAscii() [4/10]

void ns3::AsciiTraceHelperForDevice::EnableAscii	(	Ptr< OutputStreamWrapper >	stream,
		std::string	ndName
	)

Enable ascii trace output the indicated net device using a device previously named using the ns-3 object name service.

Parameters

stream	An OutputStreamWrapper representing an existing file to use when writing trace data.
ndName	The name of the net device in which you want to enable tracing.

Definition at line 526 of file trace-helper.cc.

◆ EnableAscii() [5/10]

void ns3::AsciiTraceHelperForDevice::EnableAscii	(	Ptr< OutputStreamWrapper >	stream,
		uint32_t	nodeid,
		uint32_t	deviceid
	)

Enable ascii trace output on the device specified by a global node-id (of a previously created node) and associated device-id.

Parameters

stream	An OutputStreamWrapper representing an existing file to use when writing trace data.
nodeid	The node identifier/number of the node on which to enable ascii tracing
deviceid	The device identifier/index of the device on which to enable ascii tracing

Definition at line 637 of file trace-helper.cc.

◆ EnableAscii() [6/10]

void ns3::AsciiTraceHelperForDevice::EnableAscii	(	std::string	prefix,
		NetDeviceContainer	d
	)

Enable ascii trace output on each device in the container which is of the appropriate type.

Parameters

prefix	Filename prefix to use for ascii files.
d	container of devices

Definition at line 548 of file trace-helper.cc.

◆ EnableAscii() [7/10]

void ns3::AsciiTraceHelperForDevice::EnableAscii	(	std::string	prefix,
		NodeContainer	n
	)

Enable ascii trace output on each device (which is of the appropriate type) in the nodes provided in the container.

Parameters

prefix	Filename prefix to use for ascii files.
n	container of nodes.

Definition at line 581 of file trace-helper.cc.

◆ EnableAscii() [8/10]

void ns3::AsciiTraceHelperForDevice::EnableAscii	(	std::string	prefix,
		Ptr< NetDevice >	nd,
		bool	explicitFilename = `false`
	)

Enable ascii trace output on the indicated net device.

Parameters

prefix	Filename prefix to use for ascii files.
nd	Net device for which you want to enable tracing.
explicitFilename	Treat the prefix as an explicit filename if true

Definition at line 497 of file trace-helper.cc.

Referenced by LrWpanAckTestCase::DoRun(), and Ns3TcpCubicTestCase::DoRun().

Here is the caller graph for this function:

◆ EnableAscii() [9/10]

void ns3::AsciiTraceHelperForDevice::EnableAscii	(	std::string	prefix,
		std::string	ndName,
		bool	explicitFilename = `false`
	)

Enable ascii trace output the indicated net device using a device previously named using the ns-3 object name service.

Parameters

prefix	filename prefix to use for ascii files.
ndName	The name of the net device in which you want to enable tracing.
explicitFilename	Treat the prefix as an explicit filename if true

Definition at line 515 of file trace-helper.cc.

◆ EnableAscii() [10/10]

void ns3::AsciiTraceHelperForDevice::EnableAscii	(	std::string	prefix,
		uint32_t	nodeid,
		uint32_t	deviceid,
		bool	explicitFilename
	)

Enable ascii trace output on the device specified by a global node-id (of a previously created node) and associated device-id.

Parameters

prefix	Filename prefix to use when creating ascii trace files
nodeid	The node identifier/number of the node on which to enable ascii tracing
deviceid	The device identifier/index of the device on which to enable ascii tracing
explicitFilename	Treat the prefix as an explicit filename if true

Definition at line 648 of file trace-helper.cc.

◆ EnableAsciiAll() [1/2]

void ns3::AsciiTraceHelperForDevice::EnableAsciiAll ( Ptr< OutputStreamWrapper > stream )

Enable ascii trace output on each device (which is of the appropriate type) in the set of all nodes created in the simulation.

Parameters

stream An OutputStreamWrapper representing an existing file to use when writing trace data.

Definition at line 628 of file trace-helper.cc.

References ns3::NodeContainer::GetGlobal().

Here is the call graph for this function:

◆ EnableAsciiAll() [2/2]

void ns3::AsciiTraceHelperForDevice::EnableAsciiAll ( std::string prefix )

Enable ascii trace output on each device (which is of the appropriate type) in the set of all nodes created in the simulation.

Parameters

prefix Filename prefix to use for ascii files.

Definition at line 619 of file trace-helper.cc.

References ns3::NodeContainer::GetGlobal().

Referenced by DsdvManetExample::CreateDevices(), MeshTest::CreateNodes(), and NeighborCacheExample::Run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ EnableAsciiImpl() [1/5]

void ns3::AsciiTraceHelperForDevice::EnableAsciiImpl	(	Ptr< OutputStreamWrapper >	stream,
		std::string	prefix,
		NetDeviceContainer	d
	)

private

Enable ascii trace output on each device in the container which is of the appropriate type (implementation).

Parameters

stream	An OutputStreamWrapper representing an existing file to use when writing trace data.
prefix	Filename prefix to use for ascii files.
d	container of devices

Definition at line 566 of file trace-helper.cc.

References ns3::NetDeviceContainer::Begin(), and ns3::NetDeviceContainer::End().

Here is the call graph for this function:

◆ EnableAsciiImpl() [2/5]

void ns3::AsciiTraceHelperForDevice::EnableAsciiImpl	(	Ptr< OutputStreamWrapper >	stream,
		std::string	prefix,
		NodeContainer	n
	)

private

Enable ascii trace output on each device (which is of the appropriate type) in the nodes provided in the container (implementation).

Parameters

stream	An OutputStreamWrapper representing an existing file to use when writing trace data.
prefix	Filename prefix to use for ascii files.
n	container of nodes.

Definition at line 599 of file trace-helper.cc.

References ns3::NetDeviceContainer::Add(), ns3::NodeContainer::Begin(), and ns3::NodeContainer::End().

Here is the call graph for this function:

◆ EnableAsciiImpl() [3/5]

void ns3::AsciiTraceHelperForDevice::EnableAsciiImpl	(	Ptr< OutputStreamWrapper >	stream,
		std::string	prefix,
		Ptr< NetDevice >	nd,
		bool	explicitFilename
	)

private

Enable ascii trace output the indicated net device (implementation).

Parameters

stream	An OutputStreamWrapper representing an existing file to use when writing trace data.
prefix	filename prefix to use for ascii files.
nd	Net device for which you want to enable tracing
explicitFilename	Treat the prefix as an explicit filename if true

◆ EnableAsciiImpl() [4/5]

void ns3::AsciiTraceHelperForDevice::EnableAsciiImpl	(	Ptr< OutputStreamWrapper >	stream,
		std::string	prefix,
		std::string	ndName,
		bool	explicitFilename
	)

private

Enable ascii trace output the indicated net device using a device previously named using the ns-3 object name service (implementation).

Parameters

stream	An OutputStreamWrapper representing an existing file to use when writing trace data.
prefix	filename prefix to use for ascii files.
ndName	The name of the net device in which you want to enable tracing.
explicitFilename	Treat the prefix as an explicit filename if true

Definition at line 535 of file trace-helper.cc.

◆ EnableAsciiImpl() [5/5]

void ns3::AsciiTraceHelperForDevice::EnableAsciiImpl	(	Ptr< OutputStreamWrapper >	stream,
		std::string	prefix,
		uint32_t	nodeid,
		uint32_t	deviceid,
		bool	explicitFilename
	)

private

Enable ascii trace output on the device specified by a global node-id (of a previously created node) and associated device-id (implementation)

Parameters

stream	An OutputStreamWrapper representing an existing file to use when writing trace data.
prefix	Filename prefix to use for ascii trace files.
nodeid	The node identifier/number of the node on which to enable ascii tracing
deviceid	The device identifier/index of the device on which to enable ascii tracing
explicitFilename	Treat the prefix as an explicit filename if true

Definition at line 660 of file trace-helper.cc.

References ns3::NodeContainer::Begin(), ns3::NodeContainer::End(), ns3::NodeContainer::GetGlobal(), and NS_ABORT_MSG_IF.

Here is the call graph for this function:

◆ EnableAsciiInternal()

virtual void ns3::AsciiTraceHelperForDevice::EnableAsciiInternal	(	Ptr< OutputStreamWrapper >	stream,
		std::string	prefix,
		Ptr< NetDevice >	nd,
		bool	explicitFilename
	)

pure virtual

Enable ascii trace output on the indicated net device.

The implementation is expected to use a provided Ptr<OutputStreamWrapper> if it is non-null. If the OutputStreamWrapper is null, the implementation is expected to use a provided prefix to construct a new file name for each net device using the rules described in the class overview.

If the prefix is provided, there will be one file per net device created. In this case, adding a trace context to the file would be pointless, so the device implementation is expected to TraceConnectWithoutContext.

If the output stream object is provided, there may be many different devices writing to a single file. In this case, the device adding a trace context could be important, so the device implementation is expected to TraceConnect.

Parameters

stream	An OutputStreamWrapper representing an existing file to use when writing trace data.
prefix	Filename prefix to use for ascii trace files.
nd	Net device for which you want to enable tracing
explicitFilename	Treat the prefix as an explicit filename if true

Implemented in ns3::CsmaHelper, ns3::FdNetDeviceHelper, ns3::LrWpanHelper, ns3::PointToPointHelper, ns3::WifiPhyHelper, and ns3::WimaxHelper.

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

src/network/helper/trace-helper.h
src/network/helper/trace-helper.cc

Public Member Functions

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ AsciiTraceHelperForDevice()

◆ ~AsciiTraceHelperForDevice()

Member Function Documentation

◆ EnableAscii() [1/10]

◆ EnableAscii() [2/10]

◆ EnableAscii() [3/10]

◆ EnableAscii() [4/10]

◆ EnableAscii() [5/10]

◆ EnableAscii() [6/10]

◆ EnableAscii() [7/10]

◆ EnableAscii() [8/10]

◆ EnableAscii() [9/10]

◆ EnableAscii() [10/10]

◆ EnableAsciiAll() [1/2]

◆ EnableAsciiAll() [2/2]

◆ EnableAsciiImpl() [1/5]

◆ EnableAsciiImpl() [2/5]

◆ EnableAsciiImpl() [3/5]

◆ EnableAsciiImpl() [4/5]

◆ EnableAsciiImpl() [5/5]

◆ EnableAsciiInternal()