A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Classes | Public Types | Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
ns3::PyViz Class Reference
Visualizer

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

#include <pyviz.h>

Classes

struct  LastPacketsSample
 
struct  NetDeviceStatistics
 
struct  NodeStatistics
 
struct  PacketCaptureOptions
 
struct  PacketDropSample
 
struct  PacketSample
 
struct  RxPacketSample
 
struct  TransmissionSample
 
struct  TransmissionSampleKey
 
struct  TransmissionSampleValue
 
struct  TxPacketSample
 
struct  TxRecordValue
 

Public Types

enum  PacketCaptureMode { PACKET_CAPTURE_DISABLED =1, PACKET_CAPTURE_FILTER_HEADERS_OR, PACKET_CAPTURE_FILTER_HEADERS_AND }
 
typedef std::vector
< PacketDropSample > 		PacketDropSampleList
 
typedef std::vector
< TransmissionSample > 		TransmissionSampleList
 

Public Member Functions

LastPacketsSample GetLastPackets (uint32_t nodeId) const
 
std::vector< NodeStatistics > GetNodesStatistics () const
 
PacketDropSampleList GetPacketDropSamples () const
 
std::vector< std::string > GetPauseMessages () const
 
TransmissionSampleList GetTransmissionSamples () const
 
void RegisterCsmaLikeDevice (std::string const &deviceTypeName)
 
void RegisterDropTracePath (std::string const &tracePath)
 
void RegisterPointToPointLikeDevice (std::string const &deviceTypeName)
 
void RegisterWifiLikeDevice (std::string const &deviceTypeName)
 
void SetNodesOfInterest (std::set< uint32_t > nodes)
 
void SetPacketCaptureOptions (uint32_t nodeId, PacketCaptureOptions options)
 
void SimulatorRunUntil (Time time)
 

Static Public Member Functions

static void LineClipping (double boundsX1, double boundsY1, double boundsX2, double boundsY2, double &lineX1, double &lineY1, double &lineX2, double &lineY2)
 
static void Pause (std::string const &message)
 

Private Types

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

Private Member Functions

void CallbackStopSimulation ()
 
void DoPause (std::string const &message)
 
NetDeviceStatistics & FindNetDeviceStatistics (int node, int interface)
 
bool GetPacketCaptureOptions (uint32_t nodeId, const PacketCaptureOptions **outOptions) const
 
void TraceDevQueueDrop (std::string context, Ptr< const Packet > packet)
 
void TraceIpv4Drop (std::string context, ns3::Ipv4Header const &hdr, Ptr< const Packet > packet, ns3::Ipv4L3Protocol::DropReason reason, Ptr< Ipv4 > dummy_ipv4, uint32_t interface)
 
void TraceNetDevPromiscRxCsma (std::string context, Ptr< const Packet > packet)
 
void TraceNetDevRxCommon (std::string const &context, Ptr< const Packet > packet, Mac48Address const &source)
 
void TraceNetDevRxCsma (std::string context, Ptr< const Packet > packet)
 
void TraceNetDevRxLte (std::string context, Ptr< const Packet > packet, Mac48Address const &source)
 
void TraceNetDevRxPointToPoint (std::string context, Ptr< const Packet > packet)
 
void TraceNetDevRxWifi (std::string context, Ptr< const Packet > packet)
 
void TraceNetDevRxWimax (std::string context, Ptr< const Packet > packet, Mac48Address const &source)
 
void TraceNetDevTxCommon (std::string const &context, Ptr< const Packet > packet, Mac48Address const &destination)
 
void TraceNetDevTxCsma (std::string context, Ptr< const Packet > packet)
 
void TraceNetDevTxLte (std::string context, Ptr< const Packet > packet, Mac48Address const &destination)
 
void TraceNetDevTxPointToPoint (std::string context, Ptr< const Packet > packet)
 
void TraceNetDevTxWifi (std::string context, Ptr< const Packet > packet)
 
void TraceNetDevTxWimax (std::string context, Ptr< const Packet > packet, Mac48Address const &destination)
 

Static Private Member Functions

static bool FilterPacket (Ptr< const Packet > packet, const PacketCaptureOptions &options)
 

Private Attributes

std::map< uint32_t,
LastPacketsSample > 		m_lastPackets
 
std::set< uint32_t > m_nodesOfInterest
 
std::map< uint32_t,
std::vector
< NetDeviceStatistics > > 		m_nodesStatistics
 
std::map< uint32_t,
PacketCaptureOptions > 		m_packetCaptureOptions
 
std::map< Ptr< Node >, uint32_t > m_packetDrops
 
std::map< uint32_t, Time > m_packetsOfInterest
 
std::vector< std::string > m_pauseMessages
 
Time m_runUntil
 
bool m_stop
 
std::map
< TransmissionSampleKey,
TransmissionSampleValue > 		m_transmissionSamples
 
std::map< TxRecordKey,
TxRecordValue > 		m_txRecords
 

Detailed Description

helper class to be used by the visualizer

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 51 of file pyviz.h.

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