Base class providing common user-level ascii trace operations for helpers representing IPv4 protocols . More...
#include "internet-trace-helper.h"
Public Member Functions | |
AsciiTraceHelperForIpv4 () | |
Construct an AsciiTraceHelperForIpv4. | |
virtual | ~AsciiTraceHelperForIpv4 () |
Destroy an AsciiTraceHelperForIpv4. | |
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 (Ptr< OutputStreamWrapper > stream, 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, Ptr< Ipv4 > ipv4, uint32_t interface) |
Enable ascii trace output on the indicated Ipv4 and interface pair. | |
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 (Ptr< OutputStreamWrapper > stream, uint32_t nodeid, uint32_t interface, bool explicitFilename) |
Enable ascii trace output on the Ipv4 and interface pair specified by a global node-id (of a previously created node) and interface. | |
void | EnableAsciiIpv4 (std::string prefix, Ipv4InterfaceContainer c) |
Enable ascii trace output on each Ipv4 and interface pair in the container. | |
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 (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 (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 (std::string prefix, uint32_t nodeid, uint32_t deviceid, bool explicitFilename) |
Enable ascii trace output on the Ipv4 and interface pair specified by a global node-id (of a previously created node) and interface. | |
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 | 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. | |
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. | |
Private Member Functions | |
void | EnableAsciiIpv4Impl (Ptr< OutputStreamWrapper > stream, std::string prefix, Ipv4InterfaceContainer c) |
Enable ascii trace output on the Ipv4 and interface pair specified by a global node-id (of a previously created node) and interface. | |
void | EnableAsciiIpv4Impl (Ptr< OutputStreamWrapper > stream, std::string prefix, NodeContainer n) |
Enable ascii trace output on the Ipv4 and interface pair specified by a global node-id (of a previously created node) and interface. | |
void | EnableAsciiIpv4Impl (Ptr< OutputStreamWrapper > stream, std::string prefix, Ptr< Ipv4 > ipv4, uint32_t interface, bool explicitFilename) |
Enable ascii trace output on the Ipv4 and interface pair specified by a global node-id (of a previously created node) and interface. | |
void | EnableAsciiIpv4Impl (Ptr< OutputStreamWrapper > stream, std::string prefix, std::string ipv4Name, uint32_t interface, bool explicitFilename) |
Enable ascii trace output on the Ipv4 and interface pair specified by a global node-id (of a previously created node) and interface. | |
void | EnableAsciiIpv4Impl (Ptr< OutputStreamWrapper > stream, std::string prefix, uint32_t nodeid, uint32_t interface, bool explicitFilename) |
Enable ascii trace output on the Ipv4 and interface pair specified by a global node-id (of a previously created node) and interface. | |
Base class providing common user-level ascii trace operations for helpers representing IPv4 protocols .
Definition at line 142 of file internet-trace-helper.h.
|
inline |
Construct an AsciiTraceHelperForIpv4.
Definition at line 148 of file internet-trace-helper.h.
|
inlinevirtual |
Destroy an AsciiTraceHelperForIpv4.
Definition at line 155 of file internet-trace-helper.h.
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.
stream | An OutputStreamWrapper representing an existing file to use when writing trace data. |
c | Ipv4InterfaceContainer of Ipv4 and interface pairs on which to enable tracing. |
Definition at line 188 of file internet-trace-helper.cc.
References EnableAsciiIpv4Impl().
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.
stream | An OutputStreamWrapper representing an existing file to use when writing trace data. |
n | container of nodes. |
Definition at line 221 of file internet-trace-helper.cc.
References EnableAsciiIpv4Impl().
void ns3::AsciiTraceHelperForIpv4::EnableAsciiIpv4 | ( | Ptr< OutputStreamWrapper > | stream, |
Ptr< Ipv4 > | ipv4, | ||
uint32_t | interface | ||
) |
Enable ascii trace output on the indicated Ipv4 and interface pair.
stream | An OutputStreamWrapper representing an existing file to use when writing trace data. |
ipv4 | Ptr<Ipv4> on which you want to enable tracing. |
interface | The interface on which you want to enable tracing. |
Definition at line 131 of file internet-trace-helper.cc.
References EnableAsciiIpv4Internal().
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.
stream | An OutputStreamWrapper representing an existing file to use when writing trace data. |
ipv4Name | The name of the Ipv4 on which you want to enable tracing. |
interface | The interface on which you want to enable tracing. |
Definition at line 154 of file internet-trace-helper.cc.
References EnableAsciiIpv4Impl().
void ns3::AsciiTraceHelperForIpv4::EnableAsciiIpv4 | ( | Ptr< OutputStreamWrapper > | stream, |
uint32_t | nodeid, | ||
uint32_t | interface, | ||
bool | explicitFilename | ||
) |
Enable ascii trace 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.
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 |
interface | The interface on which you want to enable tracing. |
explicitFilename | Treat the prefix as an explicit filename if true |
Definition at line 270 of file internet-trace-helper.cc.
References EnableAsciiIpv4Impl().
void ns3::AsciiTraceHelperForIpv4::EnableAsciiIpv4 | ( | std::string | prefix, |
Ipv4InterfaceContainer | c | ||
) |
Enable ascii trace output on each Ipv4 and interface pair in the container.
prefix | Filename prefix to use for ascii files. |
c | Ipv4InterfaceContainer of Ipv4 and interface pairs on which to enable tracing. |
Definition at line 179 of file internet-trace-helper.cc.
References EnableAsciiIpv4Impl().
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.
prefix | Filename prefix to use for ascii files. |
n | container of nodes. |
Definition at line 212 of file internet-trace-helper.cc.
References EnableAsciiIpv4Impl().
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.
prefix | Filename prefix to use for ascii files. |
ipv4 | Ptr<Ipv4> on which you want to enable tracing. |
interface | The interface on which you want to enable tracing. |
explicitFilename | Treat the prefix as an explicit filename if true. |
Definition at line 119 of file internet-trace-helper.cc.
References EnableAsciiIpv4Internal().
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.
prefix | filename prefix to use for ascii files. |
ipv4Name | The name of the Ipv4 on which you want to enable tracing. |
interface | The interface on which you want to enable tracing. |
explicitFilename | Treat the prefix as an explicit filename if true. |
Definition at line 142 of file internet-trace-helper.cc.
References EnableAsciiIpv4Impl().
void ns3::AsciiTraceHelperForIpv4::EnableAsciiIpv4 | ( | std::string | prefix, |
uint32_t | nodeid, | ||
uint32_t | deviceid, | ||
bool | explicitFilename | ||
) |
Enable ascii trace 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.
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 282 of file internet-trace-helper.cc.
References EnableAsciiIpv4Impl().
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.
stream | An OutputStreamWrapper representing an existing file to use when writing trace data. |
Definition at line 261 of file internet-trace-helper.cc.
References EnableAsciiIpv4Impl(), and ns3::NodeContainer::GetGlobal().
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.
prefix | Filename prefix to use for ascii files. |
Definition at line 252 of file internet-trace-helper.cc.
References EnableAsciiIpv4Impl(), and ns3::NodeContainer::GetGlobal().
|
private |
Enable ascii trace 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.
stream | An OutputStreamWrapper representing an existing file to use when writing trace data. |
prefix | Filename prefix to use when creating ascii trace files |
c | Ipv4InterfaceContainer of Ipv4 and interface pairs |
Definition at line 197 of file internet-trace-helper.cc.
References ns3::Ipv4InterfaceContainer::Begin(), EnableAsciiIpv4Internal(), and ns3::Ipv4InterfaceContainer::End().
|
private |
Enable ascii trace 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.
stream | An OutputStreamWrapper representing an existing file to use when writing trace data. |
prefix | Filename prefix to use when creating ascii trace files |
n | container of nodes. |
Definition at line 230 of file internet-trace-helper.cc.
References ns3::NodeContainer::Begin(), EnableAsciiIpv4Internal(), and ns3::NodeContainer::End().
|
private |
Enable ascii trace 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.
stream | An OutputStreamWrapper representing an existing file to use when writing trace data. |
prefix | Filename prefix to use when creating ascii trace files |
ipv4 | Ptr<Ipv4> on which you want to enable tracing. |
interface | The device identifier/index of the device on which to enable ascii tracing |
explicitFilename | Treat the prefix as an explicit filename if true. |
|
private |
Enable ascii trace 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.
stream | An OutputStreamWrapper representing an existing file to use when writing trace data. |
prefix | Filename prefix to use when creating ascii trace files |
ipv4Name | Name of the Ptr<Ipv4> on which you want to enable tracing. |
interface | 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 165 of file internet-trace-helper.cc.
References EnableAsciiIpv4Internal().
|
private |
Enable ascii trace 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.
stream | An OutputStreamWrapper representing an existing file to use when writing trace data. |
prefix | Filename prefix to use when creating ascii trace files |
nodeid | The node identifier/number of the node on which to enable ascii tracing |
interface | 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 294 of file internet-trace-helper.cc.
References ns3::NodeContainer::Begin(), EnableAsciiIpv4Internal(), ns3::NodeContainer::End(), and ns3::NodeContainer::GetGlobal().
Referenced by EnableAsciiIpv4(), and EnableAsciiIpv4All().
|
pure virtual |
Enable ascii trace output on the indicated Ipv4 and interface pair.
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 Ipv4 and interface pair created. In this case, adding a trace context to the file would be pointless, so the helper implementation is expected to TraceConnectWithoutContext.
If the output stream object is provided, there may be many different Ipv4 and interface pairs writing to a single file. In this case, the trace context could be important, so the helper implementation is expected to TraceConnect.
stream | An OutputStreamWrapper representing an existing file to use when writing trace data. |
prefix | Filename prefix to use for ascii trace files. |
ipv4 | Ptr<Ipv4> on which you want to enable tracing. |
interface | The interface on which you want to enable tracing. |
explicitFilename | Treat the prefix as an explicit filename if true. |
Implemented in ns3::InternetStackHelper.
Referenced by EnableAsciiIpv4(), and EnableAsciiIpv4Impl().