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.
virtual void	EnableAsciiInternal (Ptr< OutputStreamWrapper > stream, std::string prefix, Ptr< NetDevice > nd, bool explicitFilename)=0
	Enable ascii trace output on the indicated net device.
void	EnableAscii (std::string prefix, Ptr< NetDevice > nd, bool explicitFilename=false)
	Enable ascii trace output on the indicated net device.
void	EnableAscii (Ptr< OutputStreamWrapper > stream, Ptr< NetDevice > nd)
	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 (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 (std::string prefix, NetDeviceContainer d)
	Enable ascii trace output on each device in the container which is of the appropriate type.
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 (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 (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	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.
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	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	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.

Detailed Description

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

Member Function Documentation

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

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

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

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

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.

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.

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.

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 of type ns3::CsmaNetDevice

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 of type ns3::CsmaNetDevice

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.

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.

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.

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

src/helper/trace-helper.h

ns3::AsciiTraceHelperForDevice Class Reference

Public Member Functions

Detailed Description

Member Function Documentation