NS-3
ns3::AsciiTraceHelperForIpv4 Class Reference

Base class providing common user-level ascii trace operations for helpers representing IPv4 protocols . More...

#include <internet-trace-helper.h>

Inheritance diagram for ns3::AsciiTraceHelperForIpv4:

List of all members.

Public Member Functions

 AsciiTraceHelperForIpv4 ()
 Construct an AsciiTraceHelperForIpv4.
virtual ~AsciiTraceHelperForIpv4 ()
 Destroy an AsciiTraceHelperForIpv4.
virtual void EnableAsciiIpv4Internal (Ptr< OutputStreamWrapper > stream, std::string prefix, Ptr< Ipv4 > ipv4, uint32_t interface, bool explicitFilename)=0
 Enable ascii trace output on the indicated Ipv4 and interface pair.
void EnableAsciiIpv4 (std::string prefix, Ptr< Ipv4 > ipv4, uint32_t interface, bool explicitFilename=false)
 Enable ascii trace output on the indicated Ipv4 and interface pair.
void EnableAsciiIpv4 (Ptr< OutputStreamWrapper > stream, Ptr< Ipv4 > ipv4, uint32_t interface)
 Enable ascii trace output on the indicated Ipv4 and interface pair.
void EnableAsciiIpv4 (std::string prefix, std::string ipv4Name, uint32_t interface, bool explicitFilename=false)
 Enable ascii trace output the indicated Ipv4 and interface pair using an Ipv4 previously named using the ns-3 object name service.
void EnableAsciiIpv4 (Ptr< OutputStreamWrapper > stream, std::string ipv4Name, uint32_t interface)
 Enable ascii trace output the indicated net device using a device previously named using the ns-3 object name service.
void EnableAsciiIpv4 (std::string prefix, Ipv4InterfaceContainer c)
 Enable ascii trace output on each Ipv4 and interface pair in the container.
void EnableAsciiIpv4 (Ptr< OutputStreamWrapper > stream, Ipv4InterfaceContainer c)
 Enable ascii trace output on each device in the container which is of the appropriate type.
void EnableAsciiIpv4 (std::string prefix, NodeContainer n)
 Enable ascii trace output on all Ipv4 and interface pairs existing in the nodes provided in the container.
void EnableAsciiIpv4 (Ptr< OutputStreamWrapper > stream, NodeContainer n)
 Enable ascii trace output on all Ipv4 and interface pairs existing in the nodes provided in the container.
void EnableAsciiIpv4All (std::string prefix)
 Enable ascii trace output on all Ipv4 and interface pairs existing in the set of all nodes created in the simulation.
void EnableAsciiIpv4All (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 EnableAsciiIpv4 (std::string prefix, uint32_t nodeid, uint32_t deviceid, bool explicitFilename)
 Enable pcap output on the Ipv4 and interface pair specified by a global node-id (of a previously created node) and interface. Since there can be only one Ipv4 aggregated to a node, the node-id unambiguously determines the Ipv4.
void EnableAsciiIpv4 (Ptr< OutputStreamWrapper > stream, uint32_t nodeid, uint32_t interface, bool explicitFilename)
 Enable pcap output on the Ipv4 and interface pair specified by a global node-id (of a previously created node) and interface. Since there can be only one Ipv4 aggregated to a node, the node-id unambiguously determines the Ipv4.

Detailed Description

Base class providing common user-level ascii trace operations for helpers representing IPv4 protocols .


Member Function Documentation

void ns3::AsciiTraceHelperForIpv4::EnableAsciiIpv4 ( std::string  prefix,
Ptr< Ipv4 ipv4,
uint32_t  interface,
bool  explicitFilename = false 
)

Enable ascii trace output on the indicated Ipv4 and interface pair.

Parameters:
prefixFilename prefix to use for ascii files.
ipv4Ptr<Ipv4> on which you want to enable tracing.
interfaceThe interface on which you want to enable tracing.
explicitFilenameTreat the prefix as an explicit filename if true.
void ns3::AsciiTraceHelperForIpv4::EnableAsciiIpv4 ( Ptr< OutputStreamWrapper stream,
uint32_t  nodeid,
uint32_t  interface,
bool  explicitFilename 
)

Enable pcap output on the Ipv4 and interface pair specified by a global node-id (of a previously created node) and interface. Since there can be only one Ipv4 aggregated to a node, the node-id unambiguously determines the Ipv4.

Parameters:
streamAn OutputStreamWrapper representing an existing file to use when writing trace data.
nodeidThe node identifier/number of the node on which to enable ascii tracing
interfaceThe interface on which you want to enable tracing.
explicitFilenameTreat the prefix as an explicit filename if true
void ns3::AsciiTraceHelperForIpv4::EnableAsciiIpv4 ( std::string  prefix,
uint32_t  nodeid,
uint32_t  deviceid,
bool  explicitFilename 
)

Enable pcap output on the Ipv4 and interface pair specified by a global node-id (of a previously created node) and interface. Since there can be only one Ipv4 aggregated to a node, the node-id unambiguously determines the Ipv4.

Parameters:
prefixFilename prefix to use when creating ascii trace files
nodeidThe node identifier/number of the node on which to enable ascii tracing
deviceidThe device identifier/index of the device on which to enable ascii tracing
explicitFilenameTreat the prefix as an explicit filename if true
void ns3::AsciiTraceHelperForIpv4::EnableAsciiIpv4 ( std::string  prefix,
std::string  ipv4Name,
uint32_t  interface,
bool  explicitFilename = false 
)

Enable ascii trace output the indicated Ipv4 and interface pair using an Ipv4 previously named using the ns-3 object name service.

Parameters:
prefixfilename prefix to use for ascii files.
ipv4NameThe name of the Ipv4 on which you want to enable tracing.
interfaceThe interface on which you want to enable tracing.
explicitFilenameTreat the prefix as an explicit filename if true.
void ns3::AsciiTraceHelperForIpv4::EnableAsciiIpv4 ( std::string  prefix,
NodeContainer  n 
)

Enable ascii trace output on all Ipv4 and interface pairs existing in the nodes provided in the container.

Parameters:
prefixFilename prefix to use for ascii files.
ncontainer of nodes.
void ns3::AsciiTraceHelperForIpv4::EnableAsciiIpv4 ( Ptr< OutputStreamWrapper stream,
NodeContainer  n 
)

Enable ascii trace output on all Ipv4 and interface pairs existing in the nodes provided in the container.

Parameters:
streamAn OutputStreamWrapper representing an existing file to use when writing trace data.
ncontainer of nodes.
void ns3::AsciiTraceHelperForIpv4::EnableAsciiIpv4 ( Ptr< OutputStreamWrapper stream,
std::string  ipv4Name,
uint32_t  interface 
)

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

Parameters:
streamAn OutputStreamWrapper representing an existing file to use when writing trace data.
ipv4NameThe name of the Ipv4 on which you want to enable tracing.
interfaceThe interface on which you want to enable tracing.
void ns3::AsciiTraceHelperForIpv4::EnableAsciiIpv4 ( Ptr< OutputStreamWrapper stream,
Ipv4InterfaceContainer  c 
)

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

Parameters:
streamAn OutputStreamWrapper representing an existing file to use when writing trace data.
cIpv4InterfaceContainer of Ipv4 and interface pairs on which to enable tracing.
void ns3::AsciiTraceHelperForIpv4::EnableAsciiIpv4 ( std::string  prefix,
Ipv4InterfaceContainer  c 
)

Enable ascii trace output on each Ipv4 and interface pair in the container.

Parameters:
prefixFilename prefix to use for ascii files.
cIpv4InterfaceContainer of Ipv4 and interface pairs on which to enable tracing.
void ns3::AsciiTraceHelperForIpv4::EnableAsciiIpv4 ( Ptr< OutputStreamWrapper stream,
Ptr< Ipv4 ipv4,
uint32_t  interface 
)

Enable ascii trace output on the indicated Ipv4 and interface pair.

Parameters:
streamAn OutputStreamWrapper representing an existing file to use when writing trace data.
ipv4Ptr<Ipv4> on which you want to enable tracing.
interfaceThe interface on which you want to enable tracing.
void ns3::AsciiTraceHelperForIpv4::EnableAsciiIpv4All ( std::string  prefix)

Enable ascii trace output on all Ipv4 and interface pairs existing in the set of all nodes created in the simulation.

Parameters:
prefixFilename prefix to use for ascii files.
void ns3::AsciiTraceHelperForIpv4::EnableAsciiIpv4All ( 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:
streamAn OutputStreamWrapper representing an existing file to use when writing trace data.

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