InterfaceTableVisualizerBase

simple module

This is a base module for interface table visualizer simple modules. It displays information of network interfaces at network nodes. Network interfaces are not displayed by default, see module parameters for how to enable the visualization.

This module subscribes for NF_INTERFACE_CREATED, NF_INTERFACE_DELETED, NF_INTERFACE_CONFIG_CHANGED, and NF_INTERFACE_IPv4CONFIG_CHANGED on the module determined by the subscriptionModule parameter.

The format string can contain the following directives:

%N interface name
%m MAC address
%4 IPv4 address
%6 IPv6 address
%a IPv4 or IPv6 address
%l IPv4 or IPv6 netmask length
%g generic address
%n network address
%i InterfaceEntry::info()
%s InterfaceEntry::str()
%\ conditional newline for wired interfaces

Inheritance diagram

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

Known subclasses

Name	Type	Description
InterfaceTableCanvasVisualizer	simple module	This module visualizes interface tables on a 2D canvas. It displays a label for each selected network interface at the owner network node.
InterfaceTableOsgVisualizer	simple module	This module visualizes interface tables on a 3D osg scene. It displays a label for each selected network interface at the owner network node.

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
displayInterfaceTables	bool	false	display interface table data, disabled by default
displayWiredInterfacesAtConnections	bool	true	specifies where wired interfaces are displayed
displayBackground	bool	false	specifies whether the text should have a background or not
nodeFilter	string	"*"	which nodes are considered, matches all nodes by default
interfaceFilter	string	"not(lo*)"	which interfaces are considered, matches all non-local interfaces by default
format	string	"%N %\\%a/%l"	determines what interface data is displayed
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
font	string	""	interface text font, automatic by default
textColor	string	"#005030"	interface text font color
backgroundColor	string	"white"	interface text background color
opacity	double	1.0	opacity of the visualization

Properties

Name	Value	Description
class	InterfaceTableVisualizerBase
display	i=block/app_s

Source code

//
// This is a base module for interface table visualizer simple modules.
// It displays information of network interfaces at network nodes. Network
// interfaces are not displayed by default, see module parameters for how to
// enable the visualization.
//
// This module subscribes for NF_INTERFACE_CREATED, NF_INTERFACE_DELETED, 
// NF_INTERFACE_CONFIG_CHANGED, and NF_INTERFACE_IPv4CONFIG_CHANGED on the
// module determined by the subscriptionModule parameter.
//
// The format string can contain the following directives:
//  - %N interface name
//  - %m MAC address
//  - %4 IPv4 address
//  - %6 IPv6 address
//  - %a IPv4 or IPv6 address
//  - %l IPv4 or IPv6 netmask length
//  - %g generic address
//  - %n network address
//  - %i InterfaceEntry::info()
//  - %s InterfaceEntry::str()
//  - %\ conditional newline for wired interfaces
//
// @see ~InterfaceTableCanvasVisualizer, ~InterfaceTableOsgVisualizer, ~IInterfaceTableVisualizer, ~VisualizerBase
//
simple InterfaceTableVisualizerBase 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 displayInterfaceTables = default(false); // display interface table data, disabled by default
        bool displayWiredInterfacesAtConnections = default(true); // specifies where wired interfaces are displayed
        bool displayBackground = default(false); // specifies whether the text should have a background or not

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

        string format @mutable = default("%N %\\%a/%l"); // determines what interface data is displayed
        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

        string font = default("<default>"); // interface text font, automatic by default
        string textColor = default("#005030"); // interface text font color
        string backgroundColor = default("white"); // interface text background color
        double opacity = default(1.0); // opacity of the visualization

        @class(InterfaceTableVisualizerBase);
}

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