Simple Module RadioVisualizerBase

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

C++ definition

This is a base module for radio visualizer simple modules.

See also: RadioCanvasVisualizer, RadioOsgVisualizer, IRadioVisualizer, VisualizerBase

RadioVisualizerBase

Usage diagram:

The following diagram shows usage relationships between types. Unresolved types are missing from the diagram.

Inheritance diagram:

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

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.

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.

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 signals, root module by default

displayRadios bool false
displayRadioMode bool true
displayReceptionState bool true
displayTransmissionState bool true
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/reception misc/reception"
transmissionStateImages string "- - misc/transmission"
width double 16
height double 16
displacementHint string "bottomRight"

annotation displacement hint, space separated list of any, top, bottom, left, right, topLeft, topCenter, topRight, etc.

displacementPriority double 0

determines the order of annotation positioning

Properties:

Name Value Description
class RadioVisualizerBase
display i=block/app_s

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
        string subscriptionModule = default("<root>"); // module where the visualizer subscribes for signals, root module by default

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

        string radioFilter = 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/reception misc/reception");
        string transmissionStateImages = default("- - misc/transmission");
        double width = default(16);
        double height = default(16);
        string displacementHint = default("bottomRight"); // annotation displacement hint, space separated list of any, top, bottom, left, right, topLeft, topCenter, topRight, etc.
        double displacementPriority = default(0); // determines the order of annotation positioning

        @class(RadioVisualizerBase);
}