Ieee80211VisualizerBase

simple module

This is a base module for IEEE 802.11 association visualizer simple modules. It keeps track of wireless interface associations by subscribing to a number of signals at the provided subscription module.

This module subscribes for NF_L2_ASSOCIATED, NF_L2_DISASSOCIATED, NF_L2_AP_ASSOCIATED,NF_L2_AP_DISASSOCIATED on the module determined by the subscriptionModule parameter.

Inheritance diagram

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

Known subclasses

Name	Type	Description
Ieee80211CanvasVisualizer	simple module	This module visualizes IEEE 802.11 associations on a 2D canvas. It displays an icon labelled with the SSID for each associated wireless interface.
Ieee80211OsgVisualizer	simple module	This module visualizes IEEE 802.11 associations on a 3D osg scene. It displays an icon labelled with the SSID for each associated wireless interface.

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
visualizerTargetModule	string	""	module path relative to the visualizer where the visualization should appear in the user interface, root module by default
tags	string	""	tag added to each visualization for disambiguation in the runtime environment
networkNodeVisualizerModule	string	"^.networkNodeVisualizer"	module path to the network node visualizer module, refers to a sibling submodule by default
subscriptionModule	string	""	module where the visualizer subscribes for interface changed signals, root module by default
displayAssociations	bool	false	display association icon and SSID, disabled by default
nodeFilter	string	"*"	which nodes are considered, matches all nodes by default
interfaceFilter	string	"*"	which interfaces are considered, matches all interfaces by default
icon	string	"misc/signal_s"	wireless network visualization icon
iconColor	string	"dark"	wireless network 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	Ieee80211VisualizerBase
display	i=block/app_s

Source code

//
// This is a base module for IEEE 802.11 association visualizer simple modules.
// It keeps track of wireless interface associations by subscribing to a number
// of signals at the provided subscription module.
//
// This module subscribes for NF_L2_ASSOCIATED, NF_L2_DISASSOCIATED,
// NF_L2_AP_ASSOCIATED,NF_L2_AP_DISASSOCIATED on the module determined by the
// subscriptionModule parameter.
//
// @see ~Ieee80211CanvasVisualizer, ~Ieee80211OsgVisualizer, ~IIeee80211Visualizer, ~VisualizerBase
//
simple Ieee80211VisualizerBase extends VisualizerBase
{
    parameters:
        string networkNodeVisualizerModule = default("^.networkNodeVisualizer"); // module path to the network node visualizer module, refers to a sibling submodule by default
        string subscriptionModule = default("<root>"); // module where the visualizer subscribes for interface changed signals, root module by default

        bool displayAssociations = default(false); // display association icon and SSID, disabled by default

        string nodeFilter @mutable = default("*"); // which nodes are considered, matches all nodes by default
        string interfaceFilter @mutable = default("*"); // which interfaces are considered, matches all interfaces by default

        string icon = default("misc/signal_s"); // wireless network visualization icon
        string iconColor @enum("light","dark") = default("dark"); // wireless network 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(Ieee80211VisualizerBase);
}

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