TransportConnectionVisualizerBase

simple module

This is a 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.

This module subscribes for tcpConnectionAdded and tcpConnectionRemoved on the module determined by the visualizationSubjectModule parameter.

Inheritance diagram

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

Known subclasses

Name	Type	Description
TransportConnectionCanvasVisualizer	simple module	This module 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.
TransportConnectionOsgVisualizer	simple module	This module visualizes transport layer connections on a 3D osg scene. It displays a pair of colored icons for each connection at the network nodes where the connection starts or ends.

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
networkNodeVisualizerModule	string	"^.networkNodeVisualizer"	the network node visualizer module, refers to a sibling submodule by default
displayTransportConnections	bool	false	display transport connection end points, 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, a set of dark colors by default
labelFont	string	""	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

Properties

Name	Value	Description
class	TransportConnectionVisualizerBase
display	i=block/app

Source code

//
// This is a 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.
//
// This module subscribes for tcpConnectionAdded and tcpConnectionRemoved on the
// module determined by the visualizationSubjectModule parameter.
//
// @see ~TransportConnectionCanvasVisualizer, ~TransportConnectionOsgVisualizer, ~ITransportConnectionVisualizer, ~VisualizerBase
//
simple TransportConnectionVisualizerBase extends VisualizerBase
{
    parameters:
        string networkNodeVisualizerModule = default("^.networkNodeVisualizer"); // the network node visualizer module, refers to a sibling submodule by default

        bool displayTransportConnections = default(false);// display transport connection end points, disabled by default

        string sourceNodeFilter @mutable = default("*"); // which source network nodes are considered to display connections, matches no nodes by default
        string sourcePortFilter @mutable = default("*"); // which source ports are considered to display connections, matches all ports by default
        string destinationNodeFilter @mutable = default("*"); // which destination network nodes are considered to display connections, matches no nodes by default
        string destinationPortFilter @mutable = default("*"); // which destination ports are considered to display connections, matches all ports by default

        string icon = default("misc/marker_s"); // transport connection visualization icon
        string iconColor @enum("light","dark") = default("dark"); // transport connection icon color is a list of colors, a set of dark colors by default
        string labelFont = default("<default>"); // label font, automatic by default
        string labelColor = default("black"); // label color, black by default
        string placementHint = default("top"); // annotation placement hint, space separated list of any, top, bottom, left, right, topLeft, topCenter, topRight, etc.
        double placementPriority = default(0); // determines the order of annotation positioning

        @class(TransportConnectionVisualizerBase);
}

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