CircleMobility¶
Package: inet.mobility.single
simple module CircleMobility
Moves the node around a circle.
Inheritance diagram¶
Extends¶
Name |
Type |
Description |
|---|---|---|
simple module |
Abstract base module for mobility models. |
Parameters¶
Name |
Type |
Default value |
Description |
|---|---|---|---|
displayStringTextFormat |
string |
“p: {position}\nv: {velocity}” |
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; optional, empty disables geographic conversion (and the {geo_position} directive) |
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) |
updateInterval |
double |
0.1s |
The simulation time interval used to regularly signal mobility state changes and update the display |
faceForward |
bool |
true |
|
cx |
double |
X coordinate of the center of the circle |
|
cy |
double |
Y coordinate of the center of the circle |
|
cz |
double |
0m |
Z coordinate of the center of the circle |
r |
double |
Radius of the circle |
|
speed |
double |
0mps |
Speed of the host |
startAngle |
double |
uniform(0deg, 360deg) |
Starting angle |
Properties¶
Name |
Value |
Description |
|---|---|---|
class |
CircleMobility |
|
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¶
//
// Moves the node around a circle.
//
simple CircleMobility extends MovingMobilityBase
{
parameters:
double cx @unit(m); // X coordinate of the center of the circle
double cy @unit(m); // Y coordinate of the center of the circle
double cz @unit(m) = default(0m); // Z coordinate of the center of the circle
double r @unit(m); // Radius of the circle
double speed @unit(mps) = default(0mps); // Speed of the host
double startAngle @unit(deg) = default(uniform(0deg, 360deg)); // Starting angle
@class(CircleMobility);
}