RadioCanvasVisualizer¶

Package: inet.visualizer.canvas.physicallayer

simple module RadioCanvasVisualizer

Visualizes radios on a 2D canvas.

Usage diagram¶

Inheritance diagram¶

Used in compound modules¶

Name	Type	Description
IntegratedCanvasVisualizer	compound module	Integrates all canvas visualizers into a single module. It supports disabling any submodule visualizer by providing an empty string as its type.
IntegratedMultiCanvasVisualizer	compound module	Integrates all canvas visualizers into a single module. It supports disabling any submodule visualizer by providing an empty string as its type.
RadioVisualizer	compound module	Integrates canvas and osg radio visualizers into a single module.

Extends¶

Name	Type	Description
RadioVisualizerBase	simple module	Base module for radio visualizer simple modules.

Parameters¶

Name	Type	Default value	Description
displayStringTextFormat	string	“”	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
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
zIndex	double	10	Determines the drawing order of figures relative to other visualizers

Properties¶

Name	Value	Description
class	RadioCanvasVisualizer
display	i=block/app

Source code¶

//
// Visualizes radios on a 2D canvas.
//
// @see ~RadioOsgVisualizer, ~RadioVisualizer, ~RadioVisualizerBase, ~IRadioVisualizer
//
simple RadioCanvasVisualizer extends RadioVisualizerBase like IRadioVisualizer
{
    parameters:
        double zIndex = default(10); // Determines the drawing order of figures relative to other visualizers
        @class(RadioCanvasVisualizer);
}

File: src/inet/visualizer/canvas/physicallayer/RadioCanvasVisualizer.ned