Simple Module StaticGridMobility

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

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.

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
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)
marginX	int	0m
marginY	int	0m
numHosts	int
columns	int	ceil(sqrt(numHosts * (this.constraintAreaMaxX - this.constraintAreaMinX - 2 * marginX) / (this.constraintAreaMaxY - this.constraintAreaMinY - 2 * marginY)))
rows	int	(numHosts + columns - 1) / columns
initialZ	double	0m
separationX	double	(this.constraintAreaMaxX - this.constraintAreaMinX - 2 * marginX) / columns
separationY	double	(this.constraintAreaMaxY - this.constraintAreaMinY - 2 * marginY) / rows

Properties:

Name	Value	Description
display	i=block/cogwheel
class	StaticGridMobility

Signals:

Name	Type	Unit
mobilityStateChanged	MobilityBase

Source code:

//
// 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.
//
simple StaticGridMobility extends MobilityBase
{
    parameters:
        int marginX @unit(m) = default(0m);
        int marginY @unit(m) = default(0m);
        int numHosts;
        int columns = default(ceil(sqrt(numHosts * (this.constraintAreaMaxX - this.constraintAreaMinX - 2 * marginX) / (this.constraintAreaMaxY - this.constraintAreaMinY - 2 * marginY))));
        int rows = default((numHosts + columns - 1) / columns);
        double initialZ @unit(m) = default(0m);
        double separationX @unit(m) = default((this.constraintAreaMaxX - this.constraintAreaMinX - 2 * marginX) / columns);
        double separationY @unit(m) = default((this.constraintAreaMaxY - this.constraintAreaMinY - 2 * marginY) / rows);
        @class(StaticGridMobility);
}