SuperpositioningMobility

Package: inet.mobility.single

SuperpositioningMobility

compound module

Combines the trajectory of several other mobility modules using superposition. In other words, the position, velocity, and acceleration are the sum of the respective quantities of all submodules.

This module allows forming a group mobility model by using a shared mobility component in the mobility of each group member. It also allows separating the mobility model of initial positioning from positioning during the simulation. It also makes it possible to separate the mobility model of positioning from the mobility model of orientation.

element[numElements] : like IMobility

IMobility: The module interface for mobility models.

Source:
element[numElements]: <> like IMobility {
    parameters:
        @display("p=100,100,row,150");
}

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

Abstract base module for mobility models.

Parameters

Name Type Default value Description
displayStringTextFormat string "p: %p\nv: %v"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information

subjectModule string "^"

The module path that determines the subject module, the motion of which this mobility model describes. The default value is the parent module

coordinateSystemModule string ""

The module path of the geographic coordinate system module

updateDisplayString bool true

Enables continuous update of the subject module's position by modifying its display string

constraintAreaMinX double -inf m

The minimum x position of the constraint area. It is unconstrained by default (negative infinity)

constraintAreaMinY double -inf m

The minimum y position of the constraint area. It is unconstrained by default (negative infinity)

constraintAreaMinZ double -inf m

The minimum z position of the constraint area. It is unconstrained by default (negative infinity)

constraintAreaMaxX double inf m

The maximum x position of the constraint area. It is unconstrained by default (positive infinity)

constraintAreaMaxY double inf m

The maximum y position of the constraint area. It is unconstrained by default (positive infinity)

constraintAreaMaxZ double inf m

The maximum z position of the constraint area. It is unconstrained by default (positive infinity)

numElements int

Number of combined mobility modules

positionComposition string "sum"
orientationComposition string "sum"

Properties

Name Value Description
class SuperpositioningMobility
display i=block/cogwheel

Signals

Name Type Unit Description
mobilityStateChanged inet::MobilityBase

It works in inet, but not in the extended module in another namespace

Source code

//
// Combines the trajectory of several other mobility modules using superposition.
// In other words, the position, velocity, and acceleration
// are the sum of the respective quantities of all submodules.
//
// This module allows forming a group mobility model by using a shared mobility
// component in the mobility of each group member. It also allows separating the
// mobility model of initial positioning from positioning during the simulation.
// It also makes it possible to separate the mobility model of positioning from the
// mobility model of orientation.
//
module SuperpositioningMobility extends MobilityBase
{
    parameters:
        int numElements; // Number of combined mobility modules
        string positionComposition @enum("zero","sum","average") = default("sum");
        string orientationComposition @enum("zero","sum","average","faceForward") = default("sum");
        element[*].subjectModule = default(""); // Disable visual subject module of superposition elements by default
        @class(SuperpositioningMobility);
    submodules:
        element[numElements]: <> like IMobility {
            parameters:
                @display("p=100,100,row,150");
        }
}

File: src/inet/mobility/single/SuperpositioningMobility.ned