wnet.Node Class

R2026b

Namespace: wnet

Implement custom wireless node

Since R2026a

Description

Use the wnet.Node base class to implement a custom wireless node in a subclass.

The wnet.Node class is a handle class.

Class Attributes

Abstract

true

For information on class attributes, see Class Attributes.

Note

You can invoke the wnet.Node constructor from the constructor of its subclass to set the Position and Name properties using name-value arguments. For example, when you pass Position=[100 100 0; 5000 100 0] and Name=["wnode1","wnode2"], the constructor creates two subclass objects, one with the name "wnode1" positioned at [100 100 0], and the other with the name "wnode2" positioned at [5000 100 0]. The number of rows in the Position argument determines the number of subclass objects created. If you create N nodes but supply M names, where M is greater than N, the constructor uses only the first N names. If M is less than N, the constructor uses default names for the remaining (N–M) nodes.

Properties

Position — Current node position

[0 0 0] (default) | three-element numeric row vector | N-by-3 matrix

Current node position in 3-D Cartesian coordinates, specified as a three-element numeric row vector or an N-by-3 matrix. The units are in meters.

Note

Starting in R2026b, the Position property accepts an N-by-3 matrix to create multiple nodes simultaneously, and the Name property accepts a vector of strings or cell array of character vectors to assign names to multiple nodes. In R2026a, the Position property accepts only a three-element numeric row vector for creating a single node, and the Name property accepts only a string scalar or character vector.

Attributes:

GetAccess	public
SetAccess	public

Data Types: double

ID — Node identifier

positive integer

Node identifier, represented as a positive integer. The class assigns ID values incrementally, starting from 1.

Attributes:

GetAccess	public
SetAccess	private

Data Types: double

Name — Name of wireless node

string scalar | character vector | string array | cell array of character vectors

Name of the wireless node, specified as a character vector, string scalar, cell array of character vectors, or string array. You can set the value of this property only within the subclasses of wnet.Node. The default value of this property is of the form NodeID, where ID refers to the value of the ID property. For example, if the value of ID is 3, the default value of Name is Node3.

Note

Starting in R2026b, the Position property accepts an N-by-3 matrix to create multiple nodes simultaneously, and the Name property accepts a vector of strings or cell array of character vectors to assign names to multiple nodes. In R2026a, the Position property accepts only a three-element numeric row vector for creating a single node, and the Name property accepts only a string scalar or character vector.

Attributes:

GetAccess	public
SetAccess	protected

Data Types: string | char

Mobility — Node mobility model

object of subclass of wnet.Mobility

Node mobility model, represented as an object of a subclass of wnet.Mobility class. You can set the value of this property only within the subclasses of wnet.Node.

Attributes:

GetAccess	public
SetAccess	protected

Velocity — Node velocity

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

Node velocity in 3-D Cartesian coordinates, represented as a three-element numeric row vector. The units are in meters per second. You can set the value of this property only within the subclasses of wnet.Node.

Attributes:

GetAccess	public
SetAccess	protected

Data Types: double

Methods

Public Methods

pullTransmittedPacket	Read packets scheduled for transmission by node
pushReceivedPacket	Push received packets to reception buffer of node
isPacketRelevant	Determine if the packet is relevant to node
run	Run the node at the current time and return the next invocation time
addMobility	Add mobility to wireless node
statistics	Obtain statistics of node
registerEventCallback	Register callback for event notification from node

More About

How to Use wnet.Node Base Class

To create a custom node using the wnet.Node base class, follow these steps.

1. Implement the custom node subclass:

   • Inherit from the wnet.Node base class. The class definition must have this format, where customNode is the name of your custom node subclass.

     classdef customNode < wnet.Node
         ...
     end

   • Override any of the base class public methods.

   Save the class definition in a .m file.

2. In a simulation script, create an object of the customNode.

Version History

Introduced in R2026a

R2026b: Support for vectorized node creation

Starting in R2026b, the Position property accepts an N-by-3 matrix to create multiple nodes simultaneously, and the Name property accepts a vector of strings or cell array of character vectors to assign names to multiple nodes. In R2026a, the Position property accepts only a three-element numeric row vector for creating a single node, and the Name property accepts only a string scalar or character vector.