TransportConnectionCanvasVisualizer¶

Package: inet.visualizer.canvas.transportlayer

simple module TransportConnectionCanvasVisualizer

Visualizes transport layer connections on a 2D canvas. It displays a pair of colored icons for each connection at the network nodes where the connection starts or ends.

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.
TransportConnectionVisualizer	compound module	Integrates canvas and osg transport connection visualizers into a single module.

Extends¶

Name	Type	Description
TransportConnectionVisualizerBase	simple module	Base module for transport connection visualizer simple modules. It keeps track of open transport connections in a network. Open connections are not displayed by default, see the module parameters for how to enable the visualization. The actual visualization of transport connections 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
networkNodeVisualizerModule	string	“^.networkNodeVisualizer”	The network node visualizer module, refers to a sibling submodule by default
displayTransportConnections	bool	false	display transport connection endpoints, disabled by default
sourceNodeFilter	string	“*”	Which source network nodes are considered to display connections, matches no nodes by default
sourcePortFilter	string	“*”	Which source ports are considered to display connections, matches all ports by default
destinationNodeFilter	string	“*”	Which destination network nodes are considered to display connections, matches no nodes by default
destinationPortFilter	string	“*”	Which destination ports are considered to display connections, matches all ports by default
icon	string	“misc/marker_s”	Transport connection visualization icon
iconColor	string	“dark”	Transport connection icon color is a list of colors or a color group name (e.g. dark, light), a set of dark colors by default
labelFont	string	“<default>”	Label font, automatic by default
labelColor	string	“black”	Label color, black by default
placementHint	string	“top”	Annotation placement hint, space separated list of any, top, bottom, left, right, topLeft, topCenter, topRight, etc.
placementPriority	double	0	Determines the order of annotation positioning
zIndex	double	4	Determines the drawing order of figures relative to other visualizers

Properties¶

Name	Value	Description
class	TransportConnectionCanvasVisualizer
display	i=block/app

Source code¶

//
// Visualizes transport layer connections on a 2D canvas.
// It displays a pair of colored icons for each connection at the network nodes
// where the connection starts or ends.
//
// @see ~TransportConnectionOsgVisualizer, ~TransportConnectionVisualizer, ~TransportConnectionVisualizerBase, ~ITransportConnectionVisualizer
//
simple TransportConnectionCanvasVisualizer extends TransportConnectionVisualizerBase like ITransportConnectionVisualizer
{
    parameters:
        double zIndex = default(4); // Determines the drawing order of figures relative to other visualizers
        @class(TransportConnectionCanvasVisualizer);
}

File: src/inet/visualizer/canvas/transportlayer/TransportConnectionCanvasVisualizer.ned