helper class to be used by the visualizer More...

#include "pyviz.h"

Collaboration diagram for ns3::PyViz:

Classes
struct	LastPacketsSample
	Structure to handle a sample of the last received, transmitted or drop packets in a node. More...
struct	NetDeviceStatistics
	NetDeviceStatistics structure. More...
struct	NodeStatistics
	NodeStatistics structure. More...
struct	PacketCaptureOptions
	PacketCaptureOptions structure. More...
struct	PacketDropSample
	PacketDropSample structure. More...
struct	PacketSample
	PacketSample structure. More...
struct	RxPacketSample
	RxPacketSample structure. More...
struct	TransmissionSample
	TransmissionSample structure. More...
struct	TransmissionSampleKey
	TransmissionSampleKey structure. More...
struct	TransmissionSampleValue
	TransmissionSampleValue structure. More...
struct	TxPacketSample
	TxPacketSample structure. More...
struct	TxRecordValue
	TxRecordValue structure. More...

Public Types
enum class	MacAddressMode : std::uint8_t { MAC16ADDRESS = 0 , MAC48ADDRESS = 1 , MAC64ADDRESS = 2 }
	The MAC address mode used by a NetDevice transmissions. More...
enum	PacketCaptureMode { PACKET_CAPTURE_DISABLED = 1 , PACKET_CAPTURE_FILTER_HEADERS_OR , PACKET_CAPTURE_FILTER_HEADERS_AND }
	PacketCaptureMode enumeration. More...
typedef std::vector< PacketDropSample >	PacketDropSampleList
	PacketDropSampleList typedef.
typedef std::vector< TransmissionSample >	TransmissionSampleList
	TransmissionSampleList typedef.

Public Member Functions
	PyViz ()
	~PyViz ()
LastPacketsSample	GetLastPackets (uint32_t nodeId) const
	Get last packets function.
std::vector< NodeStatistics >	GetNodesStatistics () const
	Get node statistics.
PacketDropSampleList	GetPacketDropSamples () const
	Get packet drop samples.
std::vector< std::string >	GetPauseMessages () const
	Get pause message function.
Time	GetSimulatorStopTime ()
	Get the stop time of the underlying visual simulator implementation.
TransmissionSampleList	GetTransmissionSamples () const
	Get transmission samples.
void	RegisterCsmaLikeDevice (const std::string &deviceTypeName)
	Register CSMA like device function.
void	RegisterDropTracePath (const std::string &tracePath)
	Register drop trace path function.
void	RegisterPointToPointLikeDevice (const std::string &deviceTypeName)
	Register point to point like device function.
void	RegisterWifiLikeDevice (const std::string &deviceTypeName)
	Register WIFI like device function.
void	SetNodesOfInterest (std::set< uint32_t > nodes)
	Set nodes of interest function.
void	SetPacketCaptureOptions (uint32_t nodeId, PacketCaptureOptions options)
	Set packet capture options function.
void	SimulatorRunUntil (Time time)
	Run simulation until a given (simulated, absolute) time is reached.

Static Public Member Functions
static void	LineClipping (double boundsX1, double boundsY1, double boundsX2, double boundsY2, double &lineX1, double &lineY1, double &lineX2, double &lineY2)
	Utility function - clips a line to a bounding box.
static void	Pause (const std::string &message)
	Pause function.

Private Types
typedef std::pair< Ptr< Channel >, uint32_t >	TxRecordKey
	TxRecordKey typedef.

Private Member Functions
void	CallbackStopSimulation ()
	Stop simulation callback function.
void	DoPause (const std::string &message)
	Do pause function.
NetDeviceStatistics &	FindNetDeviceStatistics (int node, int interface)
	Find net device statistics function.
bool	GetPacketCaptureOptions (uint32_t nodeId, const PacketCaptureOptions **outOptions) const
	Get packet capture options function.
void	TraceDevQueueDrop (std::string context, Ptr< const Packet > packet)
	Queue drop trace callback function.
void	TraceIpv4Drop (std::string context, const ns3::Ipv4Header &hdr, Ptr< const Packet > packet, ns3::Ipv4L3Protocol::DropReason reason, Ptr< Ipv4 > dummy_ipv4, uint32_t interface)
	Ipv4 drop trace callback function.
void	TraceNetDevPromiscRxCsma (std::string context, Ptr< const Packet > packet)
	CSMA promiscuous receive function.
void	TraceNetDevRxCommon (const std::string &context, Ptr< const Packet > packet, const std::variant< Mac16Address, Mac48Address, Mac64Address > &source)
	Network receive common trace callback function.
void	TraceNetDevRxCsma (std::string context, Ptr< const Packet > packet)
	CSMA receive trace callback function.
void	TraceNetDevRxLrWpan (std::string context, Ptr< const Packet > packet)
	Lr-Wpan receive trace callback function.
void	TraceNetDevRxLte (std::string context, Ptr< const Packet > packet, const Mac48Address &source)
	LTE receive trace callback function.
void	TraceNetDevRxPointToPoint (std::string context, Ptr< const Packet > packet)
	Point to point receive trace callback function.
void	TraceNetDevRxWifi (std::string context, Ptr< const Packet > packet)
	Wi-Fi receive trace callback function.
void	TraceNetDevTxCommon (const std::string &context, Ptr< const Packet > packet, const std::variant< Mac16Address, Mac48Address, Mac64Address > &destination)
	Network transmit common trace callback function.
void	TraceNetDevTxCsma (std::string context, Ptr< const Packet > packet)
	CSMA transmit trace callback function.
void	TraceNetDevTxLrWpan (std::string context, Ptr< const Packet > packet)
	Lr-Wpan transmit trace callback function.
void	TraceNetDevTxLte (std::string context, Ptr< const Packet > packet, const Mac48Address &destination)
	LTE transmit trace callback function.
void	TraceNetDevTxPointToPoint (std::string context, Ptr< const Packet > packet)
	Point to point transmit trace callback function.
void	TraceNetDevTxWifi (std::string context, Ptr< const Packet > packet)
	Wi-Fi transmit trace callback function.

Static Private Member Functions
static bool	FilterPacket (Ptr< const Packet > packet, const PacketCaptureOptions &options)
	Filter packet function.

Private Attributes
std::map< uint32_t, LastPacketsSample >	m_lastPackets
	last packets
std::set< uint32_t >	m_nodesOfInterest
	list of node IDs whose transmissions will be monitored
std::map< uint32_t, std::vector< NetDeviceStatistics > >	m_nodesStatistics
	node statistics
std::map< uint32_t, PacketCaptureOptions >	m_packetCaptureOptions
	packet capture options
std::map< Ptr< Node >, uint32_t >	m_packetDrops
	packet drops
std::map< uint32_t, Time >	m_packetsOfInterest
	list of packet UIDs that will be monitored
std::vector< std::string >	m_pauseMessages
	pause message
Time	m_runUntil
	run until time
bool	m_stop
	stop?
std::map< TransmissionSampleKey, TransmissionSampleValue >	m_transmissionSamples
	transmission samples
std::map< TxRecordKey, TxRecordValue >	m_txRecords
	transmit records

Detailed Description

helper class to be used by the visualizer

Internal:

This class is not meant to be used by simulations. It is only meant to be used by the visualizer tool (PyViz). The only reason it is public is because Python bindings for it are needed, otherwise it should be considered private.

Definition at line 43 of file pyviz.h.

Member Typedef Documentation

◆ PacketDropSampleList

typedef std::vector<PacketDropSample> ns3::PyViz::PacketDropSampleList

PacketDropSampleList typedef.

Definition at line 118 of file pyviz.h.

◆ TransmissionSampleList

typedef std::vector<TransmissionSample> ns3::PyViz::TransmissionSampleList

TransmissionSampleList typedef.

Definition at line 104 of file pyviz.h.

◆ TxRecordKey

typedef std::pair<Ptr<Channel>, uint32_t> ns3::PyViz::TxRecordKey

private

TxRecordKey typedef.

Definition at line 285 of file pyviz.h.

Member Enumeration Documentation

◆ MacAddressMode

enum class ns3::PyViz::MacAddressMode : std::uint8_t

strong

The MAC address mode used by a NetDevice transmissions.

Enumerator

MAC16ADDRESS

The mode is a Mac 16 bit address (A.K.A.

Short address)

MAC48ADDRESS

The mode is a Mac 48 bit address.

MAC64ADDRESS

The mode is a Mac 48 bit address (A.K.A Extended address).

Definition at line 128 of file pyviz.h.

◆ PacketCaptureMode

enum ns3::PyViz::PacketCaptureMode

PacketCaptureMode enumeration.

Enumerator
PACKET_CAPTURE_DISABLED
PACKET_CAPTURE_FILTER_HEADERS_OR
PACKET_CAPTURE_FILTER_HEADERS_AND

Definition at line 217 of file pyviz.h.

Constructor & Destructor Documentation

◆ PyViz()

ns3::PyViz::PyViz ( )

Definition at line 123 of file pyviz.cc.

References ns3::Config::ConnectFailSafe(), ns3::g_visualizer, ns3::MakeCallback(), NS_ASSERT, NS_LOG_FUNCTION_NOARGS, TraceDevQueueDrop(), TraceIpv4Drop(), TraceNetDevPromiscRxCsma(), TraceNetDevRxCsma(), TraceNetDevRxLrWpan(), TraceNetDevRxLte(), TraceNetDevRxPointToPoint(), TraceNetDevRxWifi(), TraceNetDevTxCsma(), TraceNetDevTxLrWpan(), TraceNetDevTxLte(), TraceNetDevTxPointToPoint(), and TraceNetDevTxWifi().

Here is the call graph for this function:

◆ ~PyViz()

ns3::PyViz::~PyViz ( )

Definition at line 236 of file pyviz.cc.

References ns3::g_visualizer, NS_ASSERT, and NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

◆ CallbackStopSimulation()

void ns3::PyViz::CallbackStopSimulation ( )

private

Stop simulation callback function.

Definition at line 270 of file pyviz.cc.

References m_runUntil, m_stop, ns3::Simulator::Now(), NS_LOG_FUNCTION_NOARGS, and ns3::Simulator::Stop().

Referenced by SimulatorRunUntil().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoPause()

void ns3::PyViz::DoPause ( const std::string & message )

private

Do pause function.

Parameters

message the pause message

Definition at line 245 of file pyviz.cc.

References ns3::g_visualizer, m_pauseMessages, m_stop, ns3::Simulator::Now(), NS_LOG_LOGIC, and ns3::Time::S.

Here is the call graph for this function:

◆ FilterPacket()

bool ns3::PyViz::FilterPacket	(	Ptr< const Packet >	packet,
		const PacketCaptureOptions &	options )

staticprivate

Filter packet function.

Parameters

packet	the packet
options	the capture options

Returns: true if successful

Definition at line 417 of file pyviz.cc.

References ns3::PacketMetadata::ItemIterator::HasNext(), ns3::PyViz::PacketCaptureOptions::headers, ns3::PyViz::PacketCaptureOptions::mode, ns3::PacketMetadata::ItemIterator::Next(), NS_FATAL_ERROR, PACKET_CAPTURE_DISABLED, PACKET_CAPTURE_FILTER_HEADERS_AND, PACKET_CAPTURE_FILTER_HEADERS_OR, and ns3::PacketMetadata::Item::tid.

Referenced by TraceDevQueueDrop(), TraceNetDevRxCommon(), and TraceNetDevTxCommon().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FindNetDeviceStatistics()

PyViz::NetDeviceStatistics & ns3::PyViz::FindNetDeviceStatistics	(	int	node,
		int	interface )

inlineprivate

Find net device statistics function.

Parameters

node	the node
interface	the interface number

Returns: the device statistics

Definition at line 384 of file pyviz.cc.

References ns3::NodeList::GetNode(), and m_nodesStatistics.

Referenced by TraceNetDevRxCommon(), and TraceNetDevTxCommon().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetLastPackets()

PyViz::LastPacketsSample ns3::PyViz::GetLastPackets ( uint32_t nodeId ) const

Get last packets function.

Parameters

nodeId the node ID

Returns: the last packets

Definition at line 962 of file pyviz.cc.

References m_lastPackets, and NS_LOG_DEBUG.

◆ GetNodesStatistics()

std::vector< PyViz::NodeStatistics > ns3::PyViz::GetNodesStatistics ( ) const

Get node statistics.

Returns: the node statistics

Definition at line 950 of file pyviz.cc.

References m_nodesStatistics.

◆ GetPacketCaptureOptions()

bool ns3::PyViz::GetPacketCaptureOptions	(	uint32_t	nodeId,
		const PacketCaptureOptions **	outOptions ) const

private

Get packet capture options function.

Parameters

nodeId	the node ID
outOptions	the packet capture options

Returns: true if successful

Definition at line 402 of file pyviz.cc.

References m_packetCaptureOptions.

Referenced by TraceDevQueueDrop(), TraceNetDevRxCommon(), and TraceNetDevTxCommon().

Here is the caller graph for this function:

◆ GetPacketDropSamples()

PyViz::PacketDropSampleList ns3::PyViz::GetPacketDropSamples ( ) const

Get packet drop samples.

Returns: the packet drop sample list

Definition at line 926 of file pyviz.cc.

References ns3::PyViz::PacketDropSample::bytes, ns3::Node::GetId(), m_packetDrops, NS_LOG_DEBUG, and ns3::PyViz::PacketDropSample::transmitter.

Here is the call graph for this function:

◆ GetPauseMessages()

std::vector< std::string > ns3::PyViz::GetPauseMessages ( ) const

Get pause message function.

Returns: the pause message

Definition at line 261 of file pyviz.cc.

References ns3::g_visualizer, m_pauseMessages, ns3::Simulator::Now(), NS_LOG_LOGIC, and ns3::Time::S.

Here is the call graph for this function:

◆ GetSimulatorStopTime()

Time ns3::PyViz::GetSimulatorStopTime ( )

Get the stop time of the underlying visual simulator implementation.

Returns: The stop time of the visual simulator implementation.

Definition at line 346 of file pyviz.cc.

References ns3::DynamicCast(), and ns3::Simulator::GetImplementation().

Here is the call graph for this function:

◆ GetTransmissionSamples()

PyViz::TransmissionSampleList ns3::PyViz::GetTransmissionSamples ( ) const

Get transmission samples.

Returns: the transmission sample list

Definition at line 906 of file pyviz.cc.

References ns3::PyViz::TransmissionSample::bytes, ns3::PyViz::TransmissionSample::channel, ns3::Node::GetId(), m_transmissionSamples, NS_LOG_DEBUG, ns3::PyViz::TransmissionSample::receiver, and ns3::PyViz::TransmissionSample::transmitter.

Here is the call graph for this function:

◆ LineClipping()

void ns3::PyViz::LineClipping	(	double	boundsX1,
		double	boundsY1,
		double	boundsX2,
		double	boundsY2,
		double &	lineX1,
		double &	lineY1,
		double &	lineX2,
		double &	lineY2 )

static

Utility function - clips a line to a bounding box.

Parameters

[in]	boundsX1	Bounding box, minimum X coord
[in]	boundsY1	Bounding box, minimum Y coord
[in]	boundsX2	Bounding box, maximum X coord
[in]	boundsY2	Bounding box, maximum Y coord
[in,out]	lineX1	Line, minimum X coord (any on input, clipped to the bounding box on output)
[in,out]	lineY1	Line, minimum Y coord (any on input, clipped to the bounding box on output)
[in,out]	lineX2	Line, maximum X coord (any on input, clipped to the bounding box on output)
[in,out]	lineY2	Line, maximum Y coord (any on input, clipped to the bounding box on output)

Definition at line 978 of file pyviz.cc.

References ns3::FastClipping::ClipLine(), ns3::FastClipping::Line::end, ns3::FastClipping::Line::start, ns3::FastClipping::Vector2::x, and ns3::FastClipping::Vector2::y.

Here is the call graph for this function:

◆ Pause()

void ns3::PyViz::Pause ( const std::string & message )

static

Pause function.

Parameters

message the pause message

Definition at line 254 of file pyviz.cc.

References ns3::g_visualizer, and NS_ASSERT.

◆ RegisterCsmaLikeDevice()

void ns3::PyViz::RegisterCsmaLikeDevice ( const std::string & deviceTypeName )

Register CSMA like device function.

Parameters

deviceTypeName the device type name

Definition at line 175 of file pyviz.cc.

References ns3::Config::Connect(), ns3::TypeId::LookupByName(), ns3::MakeCallback(), TraceNetDevPromiscRxCsma(), TraceNetDevRxCsma(), and TraceNetDevTxCsma().

Here is the call graph for this function:

◆ RegisterDropTracePath()

void ns3::PyViz::RegisterDropTracePath ( const std::string & tracePath )

Register drop trace path function.

Parameters

tracePath the path to trace

Definition at line 231 of file pyviz.cc.

References ns3::Config::Connect(), ns3::MakeCallback(), and TraceDevQueueDrop().

Here is the call graph for this function:

◆ RegisterPointToPointLikeDevice()

void ns3::PyViz::RegisterPointToPointLikeDevice ( const std::string & deviceTypeName )

Register point to point like device function.

Parameters

deviceTypeName the device type name

Definition at line 207 of file pyviz.cc.

References ns3::Config::Connect(), ns3::TypeId::LookupByName(), ns3::MakeCallback(), TraceNetDevRxPointToPoint(), and TraceNetDevTxPointToPoint().

Here is the call graph for this function:

◆ RegisterWifiLikeDevice()

void ns3::PyViz::RegisterWifiLikeDevice ( const std::string & deviceTypeName )

Register WIFI like device function.

Parameters

deviceTypeName the device type name

Definition at line 193 of file pyviz.cc.

References ns3::Config::Connect(), ns3::TypeId::LookupByName(), ns3::MakeCallback(), TraceNetDevRxWifi(), and TraceNetDevTxWifi().

Here is the call graph for this function:

◆ SetNodesOfInterest()

void ns3::PyViz::SetNodesOfInterest ( std::set< uint32_t > nodes )

Set nodes of interest function.

Parameters

nodes the collection of nodes

Definition at line 944 of file pyviz.cc.

References m_nodesOfInterest, and nodes.

◆ SetPacketCaptureOptions()

void ns3::PyViz::SetPacketCaptureOptions	(	uint32_t	nodeId,
		PacketCaptureOptions	options )

Set packet capture options function.

Parameters

nodeId	the node ID
options	the capture options

Definition at line 221 of file pyviz.cc.

References ns3::PyViz::PacketCaptureOptions::headers, m_packetCaptureOptions, ns3::PyViz::PacketCaptureOptions::mode, NS_LOG_DEBUG, and ns3::PyViz::PacketCaptureOptions::numLastPackets.

◆ SimulatorRunUntil()

void ns3::PyViz::SimulatorRunUntil ( Time time )

Run simulation until a given (simulated, absolute) time is reached.

Parameters

time	the run time

Definition at line 281 of file pyviz.cc.

References CallbackStopSimulation(), ns3::DynamicCast(), ns3::Simulator::GetImplementation(), m_packetDrops, m_packetsOfInterest, m_pauseMessages, m_runUntil, m_stop, m_transmissionSamples, m_txRecords, ns3::Simulator::NO_CONTEXT, ns3::Simulator::Now(), NS_LOG_LOGIC, ns3::Simulator::ScheduleWithContext(), and ns3::Seconds().

Here is the call graph for this function:

◆ TraceDevQueueDrop()

void ns3::PyViz::TraceDevQueueDrop	(	std::string	context,
		Ptr< const Packet >	packet )

private

Queue drop trace callback function.

Parameters

context	the context
packet	the packet

Definition at line 459 of file pyviz.cc.

References ns3::PyViz::PacketSample::device, FilterPacket(), ns3::NodeList::GetNode(), GetPacketCaptureOptions(), ns3::PyViz::LastPacketsSample::lastDroppedPackets, m_lastPackets, m_nodesOfInterest, m_packetDrops, m_packetsOfInterest, ns3::Simulator::Now(), NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::PyViz::PacketCaptureOptions::numLastPackets, ns3::PyViz::PacketSample::packet, PathSplit(), and ns3::PyViz::PacketSample::time.

Referenced by PyViz(), RegisterDropTracePath(), and TraceIpv4Drop().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TraceIpv4Drop()

void ns3::PyViz::TraceIpv4Drop	(	std::string	context,
		const ns3::Ipv4Header &	hdr,
		Ptr< const Packet >	packet,
		ns3::Ipv4L3Protocol::DropReason	reason,
		Ptr< Ipv4 >	dummy_ipv4,
		uint32_t	interface )

private

Ipv4 drop trace callback function.

Parameters

context	the context
hdr	the header
packet	the packet
reason	the drop reason
dummy_ipv4	the dummy Ipv4
interface	the interface

Definition at line 506 of file pyviz.cc.

References TraceDevQueueDrop().

Referenced by PyViz().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TraceNetDevPromiscRxCsma()

void ns3::PyViz::TraceNetDevPromiscRxCsma	(	std::string	context,
		Ptr< const Packet >	packet )

private

CSMA promiscuous receive function.

Parameters

context	the context
packet	the packet

Definition at line 866 of file pyviz.cc.

References ns3::EthernetHeader::GetDestination(), NS_ABORT_IF, ns3::NetDevice::PACKET_OTHERHOST, and TraceNetDevRxCommon().

Referenced by PyViz(), and RegisterCsmaLikeDevice().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TraceNetDevRxCommon()

void ns3::PyViz::TraceNetDevRxCommon	(	const std::string &	context,
		Ptr< const Packet >	packet,
		const std::variant< Mac16Address, Mac48Address, Mac64Address > &	source )

private

Network receive common trace callback function.

Parameters

context	the context
packet	the packet
source	the source MAC address

Definition at line 679 of file pyviz.cc.

References ns3::PyViz::TransmissionSampleValue::bytes, ns3::PyViz::PacketSample::device, FilterPacket(), FindNetDeviceStatistics(), ns3::PyViz::RxPacketSample::from, ns3::Node::GetId(), ns3::NodeList::GetNode(), GetPacketCaptureOptions(), ns3::PyViz::LastPacketsSample::lastReceivedPackets, ns3::LOG_DEBUG, m_lastPackets, ns3::PyVizPacketTag::m_packetId, m_packetsOfInterest, m_transmissionSamples, m_txRecords, ns3::Simulator::Now(), NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_WARN, ns3::PyViz::PacketCaptureOptions::numLastPackets, ns3::PyViz::PacketSample::packet, PathSplit(), ns3::PyViz::NetDeviceStatistics::receivedBytes, ns3::PyViz::NetDeviceStatistics::receivedPackets, ns3::PyViz::TransmissionSampleKey::receiver, ns3::PyViz::TxRecordValue::srcNode, ns3::PyViz::PacketSample::time, and ns3::PyViz::TransmissionSampleKey::transmitter.

Referenced by TraceNetDevPromiscRxCsma(), TraceNetDevRxCsma(), TraceNetDevRxLrWpan(), TraceNetDevRxLte(), TraceNetDevRxPointToPoint(), and TraceNetDevRxWifi().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TraceNetDevRxCsma()

void ns3::PyViz::TraceNetDevRxCsma	(	std::string	context,
		Ptr< const Packet >	packet )

private

CSMA receive trace callback function.

Parameters

context	the context
packet	the packet

Definition at line 848 of file pyviz.cc.

References ns3::EthernetHeader::GetSource(), NS_ABORT_IF, and TraceNetDevRxCommon().

Referenced by PyViz(), and RegisterCsmaLikeDevice().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TraceNetDevRxLrWpan()

void ns3::PyViz::TraceNetDevRxLrWpan	(	std::string	context,
		Ptr< const Packet >	packet )

private

Lr-Wpan receive trace callback function.

Parameters

context	the context
packet	the packet

Definition at line 829 of file pyviz.cc.

References ns3::lrwpan::EXT_ADDR, ns3::lrwpan::LrWpanMacHeader::GetExtSrcAddr(), ns3::lrwpan::LrWpanMacHeader::GetShortSrcAddr(), ns3::lrwpan::LrWpanMacHeader::GetSrcAddrMode(), NS_ABORT_IF, and TraceNetDevRxCommon().

Referenced by PyViz().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TraceNetDevRxLte()

void ns3::PyViz::TraceNetDevRxLte	(	std::string	context,
		Ptr< const Packet >	packet,
		const Mac48Address &	source )

private

LTE receive trace callback function.

Parameters

context	the context
packet	the packet
source	the MAC address of the source

Definition at line 895 of file pyviz.cc.

References NS_LOG_FUNCTION, and TraceNetDevRxCommon().

Referenced by PyViz().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TraceNetDevRxPointToPoint()

void ns3::PyViz::TraceNetDevRxPointToPoint	(	std::string	context,
		Ptr< const Packet >	packet )

private

Point to point receive trace callback function.

Parameters

context	the context
packet	the packet

Definition at line 858 of file pyviz.cc.

References TraceNetDevRxCommon().

Referenced by PyViz(), and RegisterPointToPointLikeDevice().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TraceNetDevRxWifi()

void ns3::PyViz::TraceNetDevRxWifi	(	std::string	context,
		Ptr< const Packet >	packet )

private

Wi-Fi receive trace callback function.

Parameters

context	the context
packet	the packet

Definition at line 797 of file pyviz.cc.

References ns3::WifiMacHeader::GetAddr2(), ns3::WifiMacHeader::GetAddr3(), ns3::WifiMacHeader::GetAddr4(), ns3::WifiMacHeader::IsFromDs(), ns3::WifiMacHeader::IsToDs(), NS_ABORT_IF, NS_LOG_FUNCTION, and TraceNetDevRxCommon().

Referenced by PyViz(), and RegisterWifiLikeDevice().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TraceNetDevTxCommon()

void ns3::PyViz::TraceNetDevTxCommon	(	const std::string &	context,
		Ptr< const Packet >	packet,
		const std::variant< Mac16Address, Mac48Address, Mac64Address > &	destination )

private

Network transmit common trace callback function.

Parameters

context	the context
packet	the packet
destination	the destination MAC address

Definition at line 521 of file pyviz.cc.

References ns3::PyViz::PacketSample::device, FilterPacket(), FindNetDeviceStatistics(), ns3::NodeList::GetNode(), GetPacketCaptureOptions(), ns3::PyViz::TxRecordValue::isBroadcast, ns3::PyViz::LastPacketsSample::lastTransmittedPackets, m_lastPackets, m_nodesOfInterest, ns3::PyVizPacketTag::m_packetId, m_packetsOfInterest, m_txRecords, ns3::Simulator::Now(), NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::PyViz::PacketCaptureOptions::numLastPackets, ns3::PyViz::PacketSample::packet, PathSplit(), ns3::PyViz::PacketSample::time, ns3::PyViz::TxPacketSample::to, ns3::PyViz::NetDeviceStatistics::transmittedBytes, and ns3::PyViz::NetDeviceStatistics::transmittedPackets.

Referenced by TraceNetDevTxCsma(), TraceNetDevTxLrWpan(), TraceNetDevTxLte(), TraceNetDevTxPointToPoint(), and TraceNetDevTxWifi().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TraceNetDevTxCsma()

void ns3::PyViz::TraceNetDevTxCsma	(	std::string	context,
		Ptr< const Packet >	packet )

private

CSMA transmit trace callback function.

Parameters

context	the context
packet	the packet

Definition at line 659 of file pyviz.cc.

References ns3::EthernetHeader::GetDestination(), NS_ABORT_IF, and TraceNetDevTxCommon().

Referenced by PyViz(), and RegisterCsmaLikeDevice().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TraceNetDevTxLrWpan()

void ns3::PyViz::TraceNetDevTxLrWpan	(	std::string	context,
		Ptr< const Packet >	packet )

private

Lr-Wpan transmit trace callback function.

Parameters

context	the context
packet	the packet

Definition at line 639 of file pyviz.cc.

References ns3::lrwpan::EXT_ADDR, ns3::lrwpan::LrWpanMacHeader::GetDstAddrMode(), ns3::lrwpan::LrWpanMacHeader::GetExtDstAddr(), ns3::lrwpan::LrWpanMacHeader::GetShortDstAddr(), NS_ABORT_IF, and TraceNetDevTxCommon().

Referenced by PyViz().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TraceNetDevTxLte()

void ns3::PyViz::TraceNetDevTxLte	(	std::string	context,
		Ptr< const Packet >	packet,
		const Mac48Address &	destination )

private

LTE transmit trace callback function.

Parameters

context	the context
packet	the packet
destination	the destination MAC address

Definition at line 884 of file pyviz.cc.

References NS_LOG_FUNCTION, and TraceNetDevTxCommon().

Referenced by PyViz().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TraceNetDevTxPointToPoint()

void ns3::PyViz::TraceNetDevTxPointToPoint	(	std::string	context,
		Ptr< const Packet >	packet )

private

Point to point transmit trace callback function.

Parameters

context	the context
packet	the packet

Definition at line 669 of file pyviz.cc.

References TraceNetDevTxCommon().

Referenced by PyViz(), and RegisterPointToPointLikeDevice().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TraceNetDevTxWifi()

void ns3::PyViz::TraceNetDevTxWifi	(	std::string	context,
		Ptr< const Packet >	packet )

private

Wi-Fi transmit trace callback function.

Parameters

context	the context
packet	the packet

Definition at line 611 of file pyviz.cc.

References ns3::WifiMacHeader::GetAddr1(), ns3::WifiMacHeader::GetAddr3(), ns3::WifiMacHeader::IsToDs(), NS_ABORT_IF, NS_LOG_FUNCTION, and TraceNetDevTxCommon().

Referenced by PyViz(), and RegisterWifiLikeDevice().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_lastPackets

std::map<uint32_t, LastPacketsSample> ns3::PyViz::m_lastPackets

private

last packets

Definition at line 333 of file pyviz.h.

Referenced by GetLastPackets(), TraceDevQueueDrop(), TraceNetDevRxCommon(), and TraceNetDevTxCommon().

◆ m_nodesOfInterest

std::set<uint32_t> ns3::PyViz::m_nodesOfInterest

private

list of node IDs whose transmissions will be monitored

Definition at line 331 of file pyviz.h.

Referenced by SetNodesOfInterest(), TraceDevQueueDrop(), and TraceNetDevTxCommon().

◆ m_nodesStatistics

std::map<uint32_t, std::vector<NetDeviceStatistics> > ns3::PyViz::m_nodesStatistics

private

node statistics

Definition at line 334 of file pyviz.h.

Referenced by FindNetDeviceStatistics(), and GetNodesStatistics().

◆ m_packetCaptureOptions

std::map<uint32_t, PacketCaptureOptions> ns3::PyViz::m_packetCaptureOptions

private

packet capture options

Definition at line 324 of file pyviz.h.

Referenced by GetPacketCaptureOptions(), and SetPacketCaptureOptions().

◆ m_packetDrops

std::map<Ptr<Node>, uint32_t> ns3::PyViz::m_packetDrops

private

packet drops

Definition at line 329 of file pyviz.h.

Referenced by GetPacketDropSamples(), SimulatorRunUntil(), and TraceDevQueueDrop().

◆ m_packetsOfInterest

std::map<uint32_t, Time> ns3::PyViz::m_packetsOfInterest

private

list of packet UIDs that will be monitored

Definition at line 332 of file pyviz.h.

Referenced by SimulatorRunUntil(), TraceDevQueueDrop(), TraceNetDevRxCommon(), and TraceNetDevTxCommon().

◆ m_pauseMessages

std::vector<std::string> ns3::PyViz::m_pauseMessages

private

pause message

Definition at line 325 of file pyviz.h.

Referenced by DoPause(), GetPauseMessages(), and SimulatorRunUntil().

◆ m_runUntil

Time ns3::PyViz::m_runUntil

private

run until time

Definition at line 478 of file pyviz.h.

Referenced by CallbackStopSimulation(), and SimulatorRunUntil().

◆ m_stop

bool ns3::PyViz::m_stop

private

stop?

Definition at line 477 of file pyviz.h.

Referenced by CallbackStopSimulation(), DoPause(), and SimulatorRunUntil().

◆ m_transmissionSamples

std::map<TransmissionSampleKey, TransmissionSampleValue> ns3::PyViz::m_transmissionSamples

private

transmission samples

Definition at line 328 of file pyviz.h.

Referenced by GetTransmissionSamples(), SimulatorRunUntil(), and TraceNetDevRxCommon().

◆ m_txRecords

std::map<TxRecordKey, TxRecordValue> ns3::PyViz::m_txRecords

private

transmit records

Definition at line 326 of file pyviz.h.

Referenced by SimulatorRunUntil(), TraceNetDevRxCommon(), and TraceNetDevTxCommon().

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

src/visualizer/model/pyviz.h
src/visualizer/model/pyviz.cc

Classes

Public Types

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ PacketDropSampleList

◆ TransmissionSampleList

◆ TxRecordKey

Member Enumeration Documentation

◆ MacAddressMode

◆ PacketCaptureMode

Constructor & Destructor Documentation

◆ PyViz()

◆ ~PyViz()

Member Function Documentation

◆ CallbackStopSimulation()

◆ DoPause()

◆ FilterPacket()

◆ FindNetDeviceStatistics()

◆ GetLastPackets()

◆ GetNodesStatistics()

◆ GetPacketCaptureOptions()

◆ GetPacketDropSamples()

◆ GetPauseMessages()

◆ GetSimulatorStopTime()

◆ GetTransmissionSamples()

◆ LineClipping()

◆ Pause()

◆ RegisterCsmaLikeDevice()

◆ RegisterDropTracePath()

◆ RegisterPointToPointLikeDevice()

◆ RegisterWifiLikeDevice()

◆ SetNodesOfInterest()

◆ SetPacketCaptureOptions()

◆ SimulatorRunUntil()

◆ TraceDevQueueDrop()

◆ TraceIpv4Drop()

◆ TraceNetDevPromiscRxCsma()

◆ TraceNetDevRxCommon()

◆ TraceNetDevRxCsma()

◆ TraceNetDevRxLrWpan()

◆ TraceNetDevRxLte()

◆ TraceNetDevRxPointToPoint()

◆ TraceNetDevRxWifi()

◆ TraceNetDevTxCommon()

◆ TraceNetDevTxCsma()

◆ TraceNetDevTxLrWpan()

◆ TraceNetDevTxLte()

◆ TraceNetDevTxPointToPoint()

◆ TraceNetDevTxWifi()

Member Data Documentation

◆ m_lastPackets

◆ m_nodesOfInterest

◆ m_nodesStatistics

◆ m_packetCaptureOptions

◆ m_packetDrops

◆ m_packetsOfInterest

◆ m_pauseMessages

◆ m_runUntil

◆ m_stop

◆ m_transmissionSamples

◆ m_txRecords