Simple Module PacketDropCanvasVisualizer

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

This module 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:

The following diagram shows usage relationships between types. Unresolved types are missing from the diagram.

Inheritance diagram:

The following diagram shows inheritance relationships for this type. Unresolved types are missing from the diagram.

Extends:

Name	Type	Description
PacketDropVisualizerBase	simple module	This is a 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
visualizerTargetModule	string	""	module path relative to the visualizer where the visualization should appear in the user interface, root module by default
tags	string	""	tag added to each visualization for disambiguation in the runtime environment
subscriptionModule	string	""	module where the visualizer subscribes for packet drop signals, root module by default
displayPacketDrops	bool	false	display icons for packet drops, disabled by default
nodeFilter	string	"*"	which network nodes are considered, matches all nodes by default
interfaceFilter	string	"*"	which interfaces are considered, matches all interfaces by default
packetFilter	string	"*"	which packets are considered, matches all packets by default
icon	string	"msg/packet_s"	packet drop visualization icon
iconTintAmount	double	0	colorization amount between 0 and 1, disabled by default
iconTintColor	string	""	color for icon tinting, disabled by default
labelFont	string	""	label font, automatic by default
labelColor	string	"black"	label color, black by default
fadeOutMode	string	"realTime"	specifies how inactive packet drops fade out
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)
zIndex	double	10	determines the drawing order of figures relative to other visualizers

Properties:

Name	Value	Description
class	PacketDropCanvasVisualizer	TODO: double dx = default(10); // specifies where the packet drop animation crosses the X axis TODO: double dy = default(10); // specifies where the packet drop animation turns over along the Y axis
display	i=block/app_s

Source code:

//
// This module 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
        // TODO: double dx = default(10); // specifies where the packet drop animation crosses the X axis
        // TODO: double dy = default(10); // specifies where the packet drop animation turns over along the Y axis 
        @class(PacketDropCanvasVisualizer);
}