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.

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
displayStringTextFormat	string	"p: %p\nv: %v"	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
subjectModule	string	"^"	The module path that determines the subject module, the motion of which this mobility model describes. The default value is the parent module
coordinateSystemModule	string	""	The module path of the geographic coordinate system module
updateDisplayString	bool	true	Enables continuous update of the subject module's position by modifying its display string
constraintAreaMinX	double	-inf m	The minimum x position of the constraint area. It is unconstrained by default (negative infinity)
constraintAreaMinY	double	-inf m	The minimum y position of the constraint area. It is unconstrained by default (negative infinity)
constraintAreaMinZ	double	-inf m	The minimum z position of the constraint area. It is unconstrained by default (negative infinity)
constraintAreaMaxX	double	inf m	The maximum x position of the constraint area. It is unconstrained by default (positive infinity)
constraintAreaMaxY	double	inf m	The maximum y position of the constraint area. It is unconstrained by default (positive infinity)
constraintAreaMaxZ	double	inf m	The maximum z position of the constraint area. It is unconstrained by default (positive infinity)
marginX	double	0m
marginY	double	0m
numHosts	int
columns	int	int(ceil(sqrt(numHosts * (this.constraintAreaMaxX - this.constraintAreaMinX - 2 * marginX) / (this.constraintAreaMaxY - this.constraintAreaMinY - 2 * marginY))))
rows	int	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
class	StaticGridMobility
display	i=block/cogwheel

Signals

Name	Type	Unit	Description
mobilityStateChanged	inet::MobilityBase		It works in inet, but not in the extended module in another namespace

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

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