isPacketRelevant

R2026b

Class: wnet.Node
Namespace: wnet

Determine if the packet is relevant to node

Since R2026a

Syntax

[flag,receiverNodeInfo] = isPacketRelevant(wirelessNode,packet)

Description

[flag,receiverNodeInfo] = isPacketRelevant(wirelessNode,packet) determines if the packet is relevant to the node wirelessNode and provides information about the node required to apply the channel model to a wireless packet.

Note

Only the wirelessNetworkSimulator calls the isPacketRelevant method.

Input Arguments

wirelessNode — Wireless node

object of subclass of wnet.Node

Wireless node, specified as an object of subclass of wnet.Node.

packet — Packet to check

structure | vector of structures

Packet to check, specified as a structure or a vector of structures. For more information about the structure of a wireless packet, see the wirelessPacket function..

Output Arguments

flag — Acceptance for reception of packet

logical scalar

Acceptance for reception of the packet, returned as a logical 1 (true) or 0 (false). A value of true indicates that the packet is relevant, while a value of false indicates that it is not relevant.

receiverNodeInfo — Receiver node information

[] | structure

Receiver node information, returned as [] or a structure. When the value of flag is false, the value of receiverNodeInfo is []. When the value of flag is logical true, the value of receiverNodeInfo is a structure containing these fields:

• Position — Current node position in Cartesian x-, y-, and z-coordinates, returned as a three-element numeric row vector. Units are in meters.

• Velocity— Current node velocity in Cartesian x-, y-, and z-coordinates, returned 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. Units are in meters per second

• Name (since R2026b) — Name of the receiving node

• NumReceiveAntennas — Number of receiving antennas

• ID — Receiver node identifier

If the packet is relevant, the simulator uses this information to apply the channel to the incoming packet.

Note

The custom channel model functions uses receiverNodeInfo for applying the channel characteristics.

Version History

Introduced in R2026a

R2026b: Name field in receiverNodeInfo output

The receiverNodeInfo structure output by the isPacketRelevant method of wnet.Node now includes the Name field that identifies the name of the receiving node.