SuperpositioningMobility

Package: inet.mobility.single

SuperpositioningMobility

compound module

This mobility module combines the trajectory of several other mobility modules using superposition. In other words, the position, velocity and acceleration is the sum of the respective quantities of all submodules.

This module allows to form a group mobility model by using a shared mobility component in the mobility of each group member. It also allows to seprate the mobility model of initial positioning from positioning during the simulation. It also makes 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
subjectModule string "^"

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

coordinateSystemModule string ""

module path of the geographic coordinate system module

displayStringTextFormat string "p: %p\nv: %v"

format string for the mobility module's display string text

updateDisplayString bool true

enables continuous update of the subject module's position via modifying its display string

constraintAreaMinX double -inf m

min x position of the constraint area, unconstrained by default (negative infinity)

constraintAreaMinY double -inf m

min y position of the constraint area, unconstrained by default (negative infinity)

constraintAreaMinZ double -inf m

min z position of the constraint area, unconstrained by default (negative infinity)

constraintAreaMaxX double inf m

max x position of the constraint area, unconstrained by default (positive infinity)

constraintAreaMaxY double inf m

max y position of the constraint area, unconstrained by default (positive infinity)

constraintAreaMaxZ double inf m

max z position of the constraint area, unconstrained by default (positive infinity)

numElements int

number of combined mobility modules

positionComposition string "sum"
orientationComposition string "sum"

Properties

Name Value Description
display i=block/cogwheel
class SuperpositioningMobility

Signals

Name Type Unit
mobilityStateChanged inet::MobilityBase

Direct method calls (observed)

call tofunctioninfo
AttachedMobilityinet::AttachedMobility::receiveSignalmobilityStateChanged
SuperpositioningMobilityinet::SuperpositioningMobility::receiveSignalmobilityStateChanged

Called methods (observed)

functioninfocall from
inet::SuperpositioningMobility::receiveSignalmobilityStateChangedAttachedMobility, CircleMobility, FacingMobility, GaussMarkovMobility, LinearMobility, MassMobility, SuperpositioningMobility, StaticConcentricMobility

Source code

//
// This mobility module combines the trajectory of several other mobility modules
// using superposition. In other words, the position, velocity and acceleration
// is the sum of the respective quantities of all submodules.
//
// This module allows to form a group mobility model by using a shared mobility
// component in the mobility of each group member. It also allows to seprate the
// mobility model of initial positioning from positioning during the simulation.
// It also makes 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