Simple Module Ns2MotionMobility

Package: inet.mobility.single
File: src/inet/mobility/single/Ns2MotionMobility.ned

C++ definition

TODO: why does this comment refer to BonnMotion instead of NS2?

Author: Andras Varga

Ns2MotionMobility

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

Abstract base module for mobility models.

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)

updateInterval double 0.1s

the simulation time interval used to regularly signal mobility state changes and update the display

traceFile string

the BonnMotion trace file

nodeId int

selects line in trace file; -1 gets substituted to parent module's index

scrollX double 0m
scrollY double 0m

Properties:

Name Value Description
display i=block/cogwheel
class Ns2MotionMobility

Signals:

Name Type Unit
mobilityStateChanged MobilityBase

Source code:

// TODO: why does this comment refer to BonnMotion instead of NS2?
//
// @author Andras Varga
//
simple Ns2MotionMobility extends MovingMobilityBase
{
    parameters:
        string traceFile; // the BonnMotion trace file
        int nodeId; // selects line in trace file; -1 gets substituted to parent module's index
        double scrollX @unit(m) = default(0m);
        double scrollY @unit(m) = default(0m);
        @class(Ns2MotionMobility);
}