RadioVisualizerBase

simple module

This is a base module for radio visualizer simple modules.

Inheritance diagram

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

Known subclasses

Name	Type	Description
RadioCanvasVisualizer	simple module	This module visualizes radios on a 2D canvas.
RadioOsgVisualizer	simple module	This module visualizes radios on a 3D osg scene.

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"	module path to the network node visualizer module, refers to a sibling submodule by default
displayRadios	bool	false
displayRadioMode	bool	true
displayReceptionState	bool	true
displayTransmissionState	bool	true
displayAntennaLobes	bool	false
radioFilter	string	"**"	which radios are considered, matches all radios by default
radioModeImages	string	"block/process_vs block/timer_vs block/wrx_vs block/wtx_vs block/wrxtx_vs block/cogwheel_vs"
receptionStateImages	string	"- - misc/receiving misc/receiving"
transmissionStateImages	string	"- - misc/transmitting"
width	double	16
height	double	16
placementHint	string	"bottomRight"	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
antennaLobeNormalize	bool	false	true means maximum gain, false means 0dB is displayed at the given antennaLobeRadius
antennaLobeRelativeLabels	bool	false	determines whether gain labels are relative or absolute (if true, maximum gain label is 0dB)
antennaLobePlaneGlobal	bool	true	compute antenna lobe relative to the global or antenna local coordinate systems, global by default
antennaLobePlane	string	"view"	compute antenna lobe in this plane, view by default
antennaLobeMode	string	"logarithmic"
antennaLobeLogarithmicBase	double	10
antennaLobeLogarithmicScale	double	100	distance change in pixels for 10dB
antennaLobeRadius	double	100	distance in pixels for 0dB (1 gain) or maximum gain depending on antennaLobeNormalize parameter
antennaLobeStep	double	10deg
antennaLobeOpacity	double	0.25	opacity of the antenna lobe
antennaLobeLineSmooth	bool	true
antennaLobeLineColor	string	"black"	antenna lobe line color, black by default
antennaLobeLineStyle	string	"solid"	antenna lobe line style (solid, dashed, dotted)
antennaLobeLineWidth	double	1	antenna lobe line width
antennaLobeFillColor	string	"white"	antenna lobe fill color, white by default

Properties

Name	Value	Description
class	RadioVisualizerBase
display	i=block/app

Source code

//
// This is a base module for radio visualizer simple modules.
//
// @see ~RadioCanvasVisualizer, ~RadioOsgVisualizer, ~IRadioVisualizer, ~VisualizerBase
//
simple RadioVisualizerBase extends VisualizerBase
{
    parameters:
        string networkNodeVisualizerModule = default("^.networkNodeVisualizer"); // module path to the network node visualizer module, refers to a sibling submodule by default

        bool displayRadios = default(false);
        bool displayRadioMode = default(true);
        bool displayReceptionState = default(true);
        bool displayTransmissionState = default(true);
        bool displayAntennaLobes = default(false);

        string radioFilter @mutable = default("**"); // which radios are considered, matches all radios by default

        string radioModeImages = default("block/process_vs block/timer_vs block/wrx_vs block/wtx_vs block/wrxtx_vs block/cogwheel_vs");
        string receptionStateImages = default("- - misc/receiving misc/receiving");
        string transmissionStateImages = default("- - misc/transmitting");
        double width = default(16);
        double height = default(16);
        string placementHint = default("bottomRight"); // 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

        bool antennaLobeNormalize = default(false); // true means maximum gain, false means 0dB is displayed at the given antennaLobeRadius
        bool antennaLobeRelativeLabels = default(false); // determines whether gain labels are relative or absolute (if true, maximum gain label is 0dB)
        bool antennaLobePlaneGlobal = default(true); // compute antenna lobe relative to the global or antenna local coordinate systems, global by default
        string antennaLobePlane @enum("view","xy","xz","yz") = default("view"); // compute antenna lobe in this plane, view by default
        string antennaLobeMode @enum("logarithmic","linear") = default("logarithmic");
        double antennaLobeLogarithmicBase = default(10);
        double antennaLobeLogarithmicScale = default(100); // distance change in pixels for 10dB
        double antennaLobeRadius = default(100); // distance in pixels for 0dB (1 gain) or maximum gain depending on antennaLobeNormalize parameter
        double antennaLobeStep @unit(deg) = default(10deg);
        double antennaLobeOpacity = default(0.25); // opacity of the antenna lobe
        bool antennaLobeLineSmooth = default(true);
        string antennaLobeLineColor = default("black"); // antenna lobe line color, black by default
        string antennaLobeLineStyle = default("solid"); // antenna lobe line style (solid, dashed, dotted)
        double antennaLobeLineWidth = default(1); // antenna lobe line width
        string antennaLobeFillColor = default("white"); // antenna lobe fill color, white by default

        @class(RadioVisualizerBase);
}

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