RadioVisualizer¶

compound module RadioVisualizer

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

Source code¶

//
// Integrates canvas and osg radio visualizers into a single module.
//
// @see ~RadioCanvasVisualizer, ~RadioOsgVisualizer, ~RadioVisualizerBase, ~IRadioVisualizer
//
module RadioVisualizer like IRadioVisualizer
{
    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("RadioCanvasVisualizer"))> like IRadioVisualizer if typename != "" {
            parameters:
                @display("p=100,100");
        }
        osgVisualizer: <default(firstAvailableOrEmpty("RadioOsgVisualizer"))> like IRadioVisualizer if typename != "" {
            parameters:
                @display("p=100,200");
        }
}

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