PacketDropCanvasVisualizer¶

simple module PacketDropCanvasVisualizer

Visualizes packet drops on a 2D canvas. It displays an icon for each packet drop in the network. See the documentation of the base module for what constitutes a packet drop.

Usage diagram¶

Inheritance diagram¶

Used in compound modules¶

Name	Type	Description
IntegratedCanvasVisualizer	compound module	Integrates all canvas visualizers into a single module. It supports disabling any submodule visualizer by providing an empty string as its type.
IntegratedMultiCanvasVisualizer	compound module	Integrates all canvas visualizers into a single module. It supports disabling any submodule visualizer by providing an empty string as its type.
PacketDropVisualizer	compound module	Integrates canvas and osg packet drop visualizers into a single module.

Extends¶

Name	Type	Description
PacketDropVisualizerBase	simple module	Base module for packet drop visualizer simple modules. It keeps track of dropped packets in a network. Packet drops are not displayed by default, see module parameters for how to enable the visualization. The actual visualization of packet drops is done in derived modules.

Parameters¶

Name	Type	Default value	Description
displayStringTextFormat	string	“”	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
visualizationTargetModule	string	“^”	Module path relative to the visualizer which determines where the visualization should appear in the user interface, parent module by default
visualizationSubjectModule	string	“^”	Module path relative to the visualizer which determines what part of the simulation model the visualizer displays in the user interface, parent module by default
tags	string	“”	Tag added to each visualization for disambiguation in the runtime environment
displayPacketDrops	bool	false	Display packet drops, disabled by default
nodeFilter	string	“*”	Which network nodes are considered, matches all network nodes by default
interfaceFilter	string	“*”	Which network interfaces are considered, matches all network interfaces by default
packetFilter	object	“*”	Which packets are considered, matches all packets by default
detailsFilter	string	“*”	Which packet drops are considered, matches all packet drops by default
icon	string	“msg/packet_s”	Packet drop visualization icon
iconTintAmount	double	1	Colorization amount between 0 and 1, enabled by default
iconTintColor	string	“dark”	Icon tint color is a list of colors, a set of dark colors by default
labelFormat	string	“%n”	Determines what data is displayed in the label, packet name by default
labelFont	string	“<default>”	Label font, automatic by default
labelColor	string	“black”	Label color, black by default
fadeOutMode	string	“realTime”	Specifies how inactive packet drops fade out, real time by default
fadeOutTime	double	1s	How quickly packet drops fade away, 1 second by default
fadeOutAnimationSpeed	double	0	Animation speed while there are packet drops, value must be in the range (0, +inf), disabled by default
zIndex	double	10	Determines the drawing order of figures relative to other visualizers
dx	double	32	Specifies how far the animation turns over along the X axis
dy	double	64	Specifies how far the animation turns over along the Y axis

Properties¶

Name	Value	Description
class	PacketDropCanvasVisualizer
display	i=block/app

Source code¶

//
// Visualizes packet drops on a 2D canvas. It displays an icon for
// each packet drop in the network. See the documentation of the base module for
// what constitutes a packet drop.
//
// @see ~PacketDropOsgVisualizer, ~PacketDropVisualizer, ~PacketDropVisualizerBase, ~IPacketDropVisualizer
//
simple PacketDropCanvasVisualizer extends PacketDropVisualizerBase like IPacketDropVisualizer
{
    parameters:
        double zIndex = default(10); // Determines the drawing order of figures relative to other visualizers
        double dx = default(32); // Specifies how far the animation turns over along the X axis
        double dy = default(64); // Specifies how far the animation turns over along the Y axis
        @class(PacketDropCanvasVisualizer);
}

File: src/inet/visualizer/canvas/common/PacketDropCanvasVisualizer.ned