IMobility

Package: inet.mobility.contract

module interface IMobility

The module interface for mobility models.

Usage diagram

Inheritance diagram

Implemented by

Name

Type

Description

MobilityBase

simple module

Abstract base module for mobility models.

MovingMobilityBase

simple module

Abstract base module for mobility models.

MoBanCoordinator

simple module

This is the coordinator module of the MoBAN mobility model. It should be instantiated in the top level simulation network in MiXiM, once per WBAN. The coordinator module is the main module that provides the group mobility and correlation between nodes in a WBAN. In the initialization phase, it reads three user-defined input files which are the posture specification file, a configuration file which includes all required parameters for specific distributions, and the previously logged mobility pattern if it is requested to use a logged pattern. Note that all WBAN instances may use the same input files if they are exactly in the same situation.

MoBanLocal

simple module

This is the local mobility module of MoBAN. It should be instantiated in each node that belongs to a WBAN. The NED parameter coordinatorIndex determines to which WBAN (MoBanCoordinator) it belongs. The current implementation uses the Random Walk Mobility Model (RWMM) for individual (local) movement with a sphere around the node, with given speed and sphere radius of the current posture. The reference point of the node is the current posture, the sphere radius, and the speed is given by the corresponding coordinator. RWMM determines the location of a node at any time relative to the given reference point.

AnsimMobility

simple module

Uses the <position_change> elements of the ANSim tool’s trace file.

AttachedMobility

simple module

Provides a mobility that is attached to another mobility at a given offset. The position, velocity, and acceleration are all affected by the respective quantities and the orientation of the mobility where this one is attached.

BonnMotionMobility

simple module

Uses the native file format of the BonnMotion tool.

ChiangMobility

simple module

Uses a probabilistic transition matrix to change the state of motion. In this model, the state of the mobile node in each direction (x and y) can be:

CircleMobility

simple module

Moves the node around a circle.

FacingMobility

simple module

Provides orientation towards the target mobility model as seen from the source mobility model.

GaussMarkovMobility

simple module

Uses a Gauss-Markov model to control the randomness in the movement. Totally random walk (Brownian motion) is obtained by setting alpha=0, while alpha=1 results in linear motion.

GnssTrackMobility

simple module

Mobility model that follows a recorded GNSS (WGS84) track read from a CSV, GPX, or GeoJSON LineString source, mapping geographic positions into the scene through the coordinateSystemModule. Waypoints are interpolated along the great circle, so the path stays on the Earth’s surface even between far-apart points, which works for both cars and aircraft.

LinearMobility

simple module

This is a linear mobility model with speed and angle parameters. Angle only changes when the mobile node hits a wall: then it reflects off the wall at the same angle.

MassMobility

simple module

This is a random mobility model for a mobile host with mass. It is the one used in “Optimized Smooth Handoffs in Mobile IP” by Perkins & Wang.

Ns2MotionMobility

simple module

RandomWaypointMobility

simple module

Implements the Random Waypoint mobility model.

RectangleMobility

simple module

Moves the node around a rectangle.

SatelliteMobility

simple module

Mobility model that propagates a satellite orbit from a TLE (two-line element) set using the embedded SGP4 implementation, and reports the position in the simulation scene through the geographic coordinate system referenced by coordinateSystemModule (typically a Wgs84EcefGeographicCoordinateSystem); when coordinateSystemModule is empty, the position is reported in raw geocentric ECEF coordinates.

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.

TractorMobility

simple module

Moves a tractor through a field with a certain number of rows. Since the tractor also moves around the field, the tractor travels the number of rows PLUS one row. Consider the following piece of ascii-art for rows=2.

TurtleMobility

simple module

A LOGO-style movement model, with the script coming from XML. It can be useful for describing random as well as deterministic scenarios.

VehicleMobility

simple module

Mobility model for ground vehicles that follow waypoints with realistic turning behavior. Reads waypoints from a file and moves the vehicle along them at a specified speed, calculating appropriate angular velocity for turns. Supports terrain following by projecting positions onto the ground and orienting the vehicle according to the ground normal.

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 a separationX, separationY size). Hosts are placed in the middle of each cell. By default, the number of columns and rows follows the aspect ratio of the usable area. By default, stepX and stepY are calculated based on the number of columns and rows.

StaticLinearMobility

simple module

Mobility model which places all hosts at constant distances in a line with an orientation

StationaryMobility

simple module

Mobility module for stationary nodes.

Used in compound modules

Name

Type

Description

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.

NodeBase

compound module

The fundamental infrastructure for all network nodes focusing on non-communication aspects of network nodes.

AntennaBase

compound module

Serves as the base module for antenna models.

Properties

Name

Value

Description

display

i=block/cogwheel

Signals

Name

Type

Unit

Description

mobilityStateChanged

Source code

//
// The module interface for mobility models.
//
moduleinterface IMobility
{
    parameters:
        @display("i=block/cogwheel");
        @signal[mobilityStateChanged];
}

File: src/inet/mobility/contract/IMobility.ned