Simple Module QueueVisualizerBase

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

C++ definition

This is a base module for queue visualizer simple modules.

See also: QueueCanvasVisualizer, QueueOsgVisualizer, IQueueVisualizer, VisualizerBase

QueueVisualizerBase

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
QueueCanvasVisualizer simple module

This module visualizes queues on a 2D canvas.

QueueOsgVisualizer simple module

This module visualizes queues 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

displayQueues bool false
queueFilter string "**"

which queues are considered, matches all queues by default

color string "blue"
width double 8
height double 24
spacing double 2
displacementHint string "right"

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 QueueVisualizerBase
display i=block/app_s

Source code:

//
// This is a base module for queue visualizer simple modules.
//
// @see ~QueueCanvasVisualizer, ~QueueOsgVisualizer, ~IQueueVisualizer, ~VisualizerBase
//
simple QueueVisualizerBase extends VisualizerBase
{
    parameters:
        string networkNodeVisualizerModule = default("^.networkNodeVisualizer"); // module path to the network node visualizer module, refers to a sibling submodule by default

        bool displayQueues = default(false);

        string queueFilter = default("**"); // which queues are considered, matches all queues by default

        string color = default("blue");
        double width = default(8);
        double height = default(24);
        double spacing = default(2);
        string displacementHint = default("right"); // 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(QueueVisualizerBase);
}