TracingObstacleLossVisualizerBase

Package: inet.visualizer.base

TracingObstacleLossVisualizerBase

simple module

This is a base module for tracing obstacle loss visualizer simple modules. It subscribes on the obstacle loss module for physical object penetrated signals. The actual visualization of obstacle loss is done in derived modules.

See also: TracingObstacleLossCanvasVisualizer, TracingObstacleLossOsgVisualizer, ITracingObstacleLossVisualizer, VisualizerBase

Inheritance diagram

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

Known subclasses

Name Type Description
TracingObstacleLossCanvasVisualizer simple module

This module visualizes obstacle loss on a 2D canvas. It displays a line at the intersections of signal propagation paths with physical objects, and normal vectors of physical object faces at intersection points.

TracingObstacleLossOsgVisualizer simple module

This module visualizes obstacle loss on a 3D osg scene. It displays a line at the intersections of signal propagation paths with physical objects, and normal vectors of physical object faces at intersection points.

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.

Parameters

Name Type Default value Description
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

displayIntersections bool false

display instersections of transmissions and physical objects, disabled by default

intersectionLineColor string "red"
intersectionLineStyle string "solid"
intersectionLineWidth double 1
displayFaceNormalVectors bool false

display face normal vectors of instersections, disabled by default

faceNormalLineColor string "grey"
faceNormalLineStyle string "solid"
faceNormalLineWidth double 1
fadeOutMode string "realTime"

specifies how inactive obstacle losses fade out

fadeOutTime double 1s

how quickly link breaks fade away, 1 second by default

fadeOutAnimationSpeed double 0

animation speed while there are obstacle losses, value must be in the range (0, +inf)

Properties

Name Value Description
class TracingObstacleLossVisualizerBase
display i=block/app

Source code

//
// This is a base module for tracing obstacle loss visualizer simple modules. It
// subscribes on the obstacle loss module for physical object penetrated signals.
// The actual visualization of obstacle loss is done in derived modules.
//
// @see ~TracingObstacleLossCanvasVisualizer, ~TracingObstacleLossOsgVisualizer, ~ITracingObstacleLossVisualizer, ~VisualizerBase
//
simple TracingObstacleLossVisualizerBase extends VisualizerBase
{
    parameters:
        bool displayIntersections = default(false); // display instersections of transmissions and physical objects, disabled by default
        string intersectionLineColor = default("red");
        string intersectionLineStyle = default("solid");
        double intersectionLineWidth = default(1);

        bool displayFaceNormalVectors = default(false); // display face normal vectors of instersections, disabled by default
        string faceNormalLineColor = default("grey");
        string faceNormalLineStyle = default("solid");
        double faceNormalLineWidth = default(1);

        string fadeOutMode @enum("realTime","animationTime","simulationTime") = default("realTime"); // specifies how inactive obstacle losses fade out
        double fadeOutTime @unit(s) = default(1s); // how quickly link breaks fade away, 1 second by default
        double fadeOutAnimationSpeed = default(0); // animation speed while there are obstacle losses, value must be in the range (0, +inf)

        @class(TracingObstacleLossVisualizerBase);
}

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