TransportConnectionVisualizer¶

compound module TransportConnectionVisualizer

Integrates canvas and osg transport connection 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.networkNodeVisualizerModule	string	“^.networkNodeVisualizer”	The network node visualizer module, refers to a sibling submodule by default
canvasVisualizer.displayTransportConnections	bool	false	display transport connection endpoints, disabled by default
canvasVisualizer.sourceNodeFilter	string	“*”	Which source network nodes are considered to display connections, matches no nodes by default
canvasVisualizer.sourcePortFilter	string	“*”	Which source ports are considered to display connections, matches all ports by default
canvasVisualizer.destinationNodeFilter	string	“*”	Which destination network nodes are considered to display connections, matches no nodes by default
canvasVisualizer.destinationPortFilter	string	“*”	Which destination ports are considered to display connections, matches all ports by default
canvasVisualizer.icon	string	“misc/marker_s”	Transport connection visualization icon
canvasVisualizer.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
canvasVisualizer.labelFont	string	“<default>”	Label font, automatic by default
canvasVisualizer.labelColor	string	“black”	Label color, black by default
canvasVisualizer.placementHint	string	“top”	Annotation placement hint, space separated list of any, top, bottom, left, right, topLeft, topCenter, topRight, etc.
canvasVisualizer.placementPriority	double	0	Determines the order of annotation positioning
canvasVisualizer.zIndex	double	4	Determines the drawing order of figures relative to other visualizers
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.networkNodeVisualizerModule	string	“^.networkNodeVisualizer”	The network node visualizer module, refers to a sibling submodule by default
osgVisualizer.displayTransportConnections	bool	false	display transport connection endpoints, disabled by default
osgVisualizer.sourceNodeFilter	string	“*”	Which source network nodes are considered to display connections, matches no nodes by default
osgVisualizer.sourcePortFilter	string	“*”	Which source ports are considered to display connections, matches all ports by default
osgVisualizer.destinationNodeFilter	string	“*”	Which destination network nodes are considered to display connections, matches no nodes by default
osgVisualizer.destinationPortFilter	string	“*”	Which destination ports are considered to display connections, matches all ports by default
osgVisualizer.icon	string	“misc/marker_s”	Transport connection visualization icon
osgVisualizer.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
osgVisualizer.labelFont	string	“<default>”	Label font, automatic by default
osgVisualizer.labelColor	string	“black”	Label color, black by default
osgVisualizer.placementHint	string	“top”	Annotation placement hint, space separated list of any, top, bottom, left, right, topLeft, topCenter, topRight, etc.
osgVisualizer.placementPriority	double	0	Determines the order of annotation positioning

Source code¶

//
// Integrates canvas and osg transport connection visualizers into a single module.
//
// @see ~TransportConnectionCanvasVisualizer, ~TransportConnectionOsgVisualizer, ~TransportConnectionVisualizerBase, ~ITransportConnectionVisualizer
//
module TransportConnectionVisualizer like ITransportConnectionVisualizer
{
    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("TransportConnectionCanvasVisualizer"))> like ITransportConnectionVisualizer if typename != "" {
            parameters:
                @display("p=100,100");
        }
        osgVisualizer: <default(firstAvailableOrEmpty("TransportConnectionOsgVisualizer"))> like ITransportConnectionVisualizer if typename != "" {
            parameters:
                @display("p=100,200");
        }
}

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