PacketDropVisualizer¶

compound module PacketDropVisualizer

Integrates canvas and osg packet drop visualizers into a single module.

Usage diagram¶

Inheritance diagram¶

Parameters¶

Name	Type	Default value	Description
visualizationTargetModule	string	“^”
visualizationSubjectModule	string	“^”

Properties¶

Name	Value	Description
display	i=block/app

Unassigned submodule parameters¶

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

Source code¶

//
// Integrates canvas and osg packet drop visualizers into a single module.
//
// @see ~PacketDropCanvasVisualizer, ~PacketDropOsgVisualizer, ~PacketDropVisualizerBase, ~IPacketDropVisualizer
//
module PacketDropVisualizer like IPacketDropVisualizer
{
    parameters:
        @display("i=block/app");
        string visualizationTargetModule = default("^");
        string visualizationSubjectModule = default("^");
        *.visualizationTargetModule = default(absPath(this.visualizationTargetModule));
        *.visualizationSubjectModule = default(absPath(this.visualizationSubjectModule));
    submodules:
        canvasVisualizer: <default(firstAvailableOrEmpty("PacketDropCanvasVisualizer"))> like IPacketDropVisualizer if typename != "" {
            parameters:
                @display("p=100,100");
        }
        osgVisualizer: <default(firstAvailableOrEmpty("PacketDropOsgVisualizer"))> like IPacketDropVisualizer if typename != "" {
            parameters:
                @display("p=100,200");
        }
}

File: src/inet/visualizer/common/PacketDropVisualizer.ned