addMobility

Class: wnet.Node
Namespace: wnet

Add mobility to wireless node

Since R2026a

Syntax

addMobility(wirelessNode)

addMobility(wirelessNode,Name=Value)

Description

addMobility(wirelessNode) applies random waypoint mobility to the specified wireless node.

addMobility(wirelessNode,Name=Value) sets mobility configuration parameters using one or more optional name-value arguments. For example, MobilityModel="constant-velocity" sets the mobility model to "constant-velocity".

You can add a mobility model to multiple wireless nodes in a single addMobility call, but the method applies the same mobility parameter values to all the nodes.

Input Arguments

wirelessNode — Wireless node

object of subclass of wnet.Node | vector of objects of subclass of wnet.Node

Wireless node, specified as an object of a subclass of wnet.Node or a vector of objects of a subclass of wnet.Node.

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Example: addMobility(wirelessNode,MobilityModel="constant-velocity") sets the mobility model to "constant-velocity".

MobilityModel — Mobility model

"random-waypoint" (default) | "random-walk" | "constant-velocity" | object of subclass of wnet.Mobility.

Mobility model, specified as "random-waypoint", "random-walk", "constant-velocity", or an object of a subclass of wnet.Mobility. When you provide a custom mobility object, the method generates a copy of the mobility model object and associates it with the node. Consequently, after the method assigns the mobility model to the node, changes you make to the original mobility model object do not affect the node.

If you specify a custom mobility model object, the function ignores any other mobility parameters provided as name-value arguments.

SpeedRange — Speed range

[0.4150 1.6600] (default) | two-element row vector

Speed range, specified as a two-element row vector. The function sets the speed of the wireless node according to a continuous uniform distribution based on this range. The first element of the vector specifies the minimum speed of the node, while the second specifies the maximum speed, in meters per second. Units are in meters per second.

To set the speed to a constant value, specify SpeedRange as a two-element row vector with identical values.

Dependencies

To specify this argument, you must specify the MobilityModel argument as "random-waypoint" or "random-walk".

Data Types: double

PauseDuration — Pause duration of wireless node

0 (default) | nonnegative scalar

Pause duration of the wireless node after reaching a target waypoint, specified as a nonnegative scalar. Units are in seconds.

Dependencies

To specify this argument, you must specify the MobilityModel argument as "random-waypoint".

Data Types: double

BoundaryShape — Shape of node mobility area

"rectangle" (default) | "circle"

Shape of the node mobility area, specified as "rectangle" or "circle".

Dependencies

To specify this argument, you must specify the MobilityModel argument as "random-waypoint" or "random-walk".

Bounds — Center coordinates and dimensions of node mobility area

three-element numeric vector | four-element numeric vector

Center coordinates and dimensions of the node mobility area, specified as a three-element or four-element numeric vector, depending on the value of the BoundaryShape argument. Units are in meters.

• "rectangle" — Specify a four-element numeric vector of the form [x_center y_center length width]. The default value is [x_current y_current 10 10], where the first two elements specify the xy-coordinates of the current node position.

• "circle"— Specify a three-element numeric vector of the form [x_center y_center radius]. The default value is [x_current y_current 10], where the first two elements specify the xy-coordinates of the current node position.

Dependencies

To specify this argument, you must specify the MobilityModel argument as "random-waypoint" or "random-walk".

Data Types: double

WalkMode — Mode of random walk

"time" (default) | "distance"

Mode of random walk, specified as "time" or "distance".

Dependencies

To specify this argument, you must specify the MobilityModel argument as "random-walk".

Time — Time after which speed and direction change

1 (default) | positive scalar

Time after which the speed and direction change, specified as a positive scalar. Units are in seconds.

Dependencies

To specify this argument, you must specify the WalkMode argument as "time" and the MobilityModel argument as "random-walk".

Data Types: double

Distance — Distance after which the speed and direction change

1 (default) | positive scalar

Distance after which the speed and direction change, specified as a positive scalar. Units are in meters.

Dependencies

To specify this argument, you must specify the WalkMode argument as "distance" and the MobilityModel argument as "random-walk".

Data Types: double

Velocity — Current node velocity

[0 0 0] (default) | three-element numeric row vector

Current node velocity in Cartesian x-, y-, and z-coordinates, specified as a numeric vector of the form [v_x v_y v_z]. v_x, v_y, and v_z are velocity components in the x-, y-, and z-directions, respectively. Units are in meters per second.

Dependencies

To specify this argument, you must specify the MobilityModel argument as "constant-velocity".

Data Types: double

RefreshInterval — Refresh Interval

0.1 (default) | nonnegative scalar

Refresh Interval, specified as a nonnegative scalar. This argument specifies how frequently the node updates its position and velocity information. A refresh occurs at each fixed interval, but only when the node requests it. The units are in seconds. If you set RefreshInterval to 0, the function updates position and velocity information immediately whenever you request it.

Data Types: double

Version History

Introduced in R2026a