Simple Module StationaryMobility

Package: inet.mobility.static
File: src/inet/mobility/static/StationaryMobility.ned

C++ definition

This mobility module does nothing; it can be used for stationary nodes.

Author: Andras Varga

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.

Known subclasses:

Name	Type	Description
LinearNodeDistributionMobility	simple module	Mobility model which places all hosts at constant distances in a line with an orientation

Used in compound modules:

Name	Type	Description
Node	compound module	(no description)
SinkClient	compound module	(no description)
SinkNode	compound module	(no description)
ThroughputClient	compound module	(no description)
ThroughputClient	compound module	(no description)
ThroughputServer	compound module	(no description)
ThroughputServer	compound module	(no description)
WirelessAPWithSink	compound module	(no description)
WirelessAPWithSink	compound module	Well, this models a 802.11 Access Point with a Sink.

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)
initialX	double	uniform(this.constraintAreaMinX, this.constraintAreaMaxX)
initialY	double	uniform(this.constraintAreaMinY, this.constraintAreaMaxY)
initialZ	double	nanToZero(uniform(this.constraintAreaMinZ, this.constraintAreaMaxZ))
initialLatitude	double	0deg/0
initialLongitude	double	0deg/0
initialAltitude	double	0m
initFromDisplayString	bool	true

Properties:

Name	Value	Description
display	i=block/cogwheel
class	StationaryMobility

Signals:

Name	Type	Unit
mobilityStateChanged	MobilityBase

Source code:

//
// This mobility module does nothing; it can be used for stationary nodes.
//
// @author Andras Varga
//
simple StationaryMobility extends MobilityBase
{
    parameters:
        double initialX @unit(m) = default(uniform(this.constraintAreaMinX, this.constraintAreaMaxX));
        double initialY @unit(m) = default(uniform(this.constraintAreaMinY, this.constraintAreaMaxY));
        double initialZ @unit(m) = default(nanToZero(uniform(this.constraintAreaMinZ, this.constraintAreaMaxZ)));
        double initialLatitude @unit(deg) = default(0deg/0);
        double initialLongitude @unit(deg) = default(0deg/0);
        double initialAltitude @unit(m) = default(0m);
        bool initFromDisplayString = default(true);
        @class(StationaryMobility);
}