MobilityBase

simple module

Abstract base module for mobility models.

Author: Andras Varga

Inheritance diagram

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

Known subclasses

Name	Type	Description
MovingMobilityBase	simple module	Abstract base module for mobility models.
StaticConcentricMobility	simple module	Places all hosts on concentric circles
StaticGridMobility	simple module	Places all hosts in a rectangular grid. The usable area (constraint area minus margins on each side) is split into smaller cells (with separationX,separationY size). Hosts are placed in the middle of each cell. By default, the number of columns and rows follow the aspect ratio of the usable area. By default stepX and stepY are calculated based on the number of columns and rows.
StationaryMobility	simple module	This mobility module does nothing; it can be used for stationary nodes.

Parameters

Name	Type	Default value	Description
coordinateSystemModule	string	""	module path of the geographic coordinate system module
visualizeMobility	bool	true	false means this mobility module does no visualization
visualRepresentation	string	"^"	determines the module that is moved by this mobility
constraintAreaMinX	double	-1m/0	min x position of the constraint area, unconstrained by default (negative infinity)
constraintAreaMinY	double	-1m/0	min y position of the constraint area, unconstrained by default (negative infinity)
constraintAreaMinZ	double	-1m/0	min z position of the constraint area, unconstrained by default (negative infinity)
constraintAreaMaxX	double	1m/0	max x position of the constraint area, unconstrained by default (positive infinity)
constraintAreaMaxY	double	1m/0	max y position of the constraint area, unconstrained by default (positive infinity)
constraintAreaMaxZ	double	1m/0	max z position of the constraint area, unconstrained by default (positive infinity)

Properties

Name	Value	Description
display	i=block/cogwheel

Signals

Name	Type	Unit
mobilityStateChanged	inet::MobilityBase

Source code

//
// Abstract base module for mobility models.
//
// @author Andras Varga
//
simple MobilityBase like IMobility
{
    parameters:
        @signal[mobilityStateChanged](type=inet::MobilityBase);
        @display("i=block/cogwheel");
        string coordinateSystemModule = default(""); // module path of the geographic coordinate system module
        bool visualizeMobility = default(true); // false means this mobility module does no visualization
        string visualRepresentation = default("^"); // determines the module that is moved by this mobility
        double constraintAreaMinX @unit(m) = default(-1m/0); // min x position of the constraint area, unconstrained by default (negative infinity)
        double constraintAreaMinY @unit(m) = default(-1m/0); // min y position of the constraint area, unconstrained by default (negative infinity)
        double constraintAreaMinZ @unit(m) = default(-1m/0); // min z position of the constraint area, unconstrained by default (negative infinity)
        double constraintAreaMaxX @unit(m) = default(1m/0); // max x position of the constraint area, unconstrained by default (positive infinity)
        double constraintAreaMaxY @unit(m) = default(1m/0); // max y position of the constraint area, unconstrained by default (positive infinity)
        double constraintAreaMaxZ @unit(m) = default(1m/0); // max z position of the constraint area, unconstrained by default (positive infinity)
}

File: src/inet/mobility/base/MobilityBase.ned