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.

This module subscribes for packetDropped on the module determined by the visualizationSubjectModule parameter. If the visualizer receives a packet dropped signal, then it stores the dropped packet and starts the visualization.

The format string can contain the following directives:

%n packet name
%c packet class
%r drop reason number
%s drop reason string

Inheritance diagram

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

Known subclasses

Name	Type	Description
PacketDropCanvasVisualizer	simple module	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.
PacketDropOsgVisualizer	simple module	This module visualizes packet drops on a 3D osg scene. It displays an icon for each packet drop in the network. See the documentation of the base module for what constitutes a packet drop.

Extends

Name	Type	Description
VisualizerBase	simple module	This is a base module for visualizer simple modules. It simply provides the visualization target module for derived modules.

Parameters

Name	Type	Default value	Description
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	""	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

Properties

Name	Value	Description
class	PacketDropVisualizerBase
display	i=block/app

Source code

//
// 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.
//
// This module subscribes for packetDropped on the module determined by the
// visualizationSubjectModule parameter. If the visualizer receives a packet dropped
// signal, then it stores the dropped packet and starts the visualization.
//
// The format string can contain the following directives:
//  - %n packet name
//  - %c packet class
//  - %r drop reason number
//  - %s drop reason string
//
// @see ~PacketDropCanvasVisualizer, ~PacketDropOsgVisualizer, ~IPacketDropVisualizer, ~VisualizerBase
//
simple PacketDropVisualizerBase extends VisualizerBase
{
    parameters:
        bool displayPacketDrops = default(false); // display packet drops, disabled by default

        string nodeFilter @mutable = default("*"); // which network nodes are considered, matches all network nodes by default
        string interfaceFilter @mutable = default("*"); // which network interfaces are considered, matches all network interfaces by default
        object packetFilter @mutable = default("*"); // which packets are considered, matches all packets by default
        string detailsFilter @mutable = default("*"); // which packet drops are considered, matches all packet drops by default

        string icon = default("msg/packet_s"); // packet drop visualization icon
        double iconTintAmount = default(1); // colorization amount between 0 and 1, enabled by default
        string iconTintColor = default("dark"); // icon tint color is a list of colors, a set of dark colors by default

        string labelFormat @mutable = default("%n"); // determines what data is displayed in the label, packet name by default
        string labelFont = default("<default>"); // label font, automatic by default
        string labelColor = default("black"); // label color, black by default

        string fadeOutMode @enum("realTime","animationTime","simulationTime") = default("realTime"); // specifies how inactive packet drops fade out, real time by default
        double fadeOutTime @unit(s) = default(1s); // how quickly packet drops fade away, 1 second by default
        double fadeOutAnimationSpeed = default(0); // animation speed while there are packet drops, value must be in the range (0, +inf), disabled by default

        @class(PacketDropVisualizerBase);
}

File: src/inet/visualizer/base/PacketDropVisualizerBase.ned