QueueVisualizerBase

Package: inet.visualizer.base

simple module QueueVisualizerBase

Base module for queue visualizer simple modules.

See also: QueueCanvasVisualizer, QueueOsgVisualizer, IQueueVisualizer, VisualizerBase

inet.visualizer.base.QueueVisualizerBaseQueueVisualizerBasesimple

Inheritance diagram

Known subclasses

Name

Type

Description

QueueCanvasVisualizer

simple module

Visualizes queues on a 2D canvas.

QueueOsgVisualizer

simple module

Visualizes queues on a 3D osg scene.

Extends

Name

Type

Description

VisualizerBase

simple module

Base module for visualizer simple modules. It simply provides the visualization target module for derived 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

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

placementHint

string

“right”

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

Properties

Name

Value

Description

class

QueueVisualizerBase

display

i=block/app

Source code

//
// 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 placementHint = default("right"); // 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

        @class(QueueVisualizerBase);
}

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