Class ExplicitXBeeMessage

This class represents an Explicit XBee message containing the remote XBee device the message belongs to, the content (data) of the message, a flag indicating if the message is a broadcast message (was received or is being sent via broadcast) and all the application layer fields: source endpoint, destination endpoint, cluster ID and profile ID.

Inheritance
System.Object
XBeeMessage
ExplicitXBeeMessage
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: XBeeLibrary.Core.Models
Assembly: XBeeLibrary.Core.dll
Syntax
public class ExplicitXBeeMessage : XBeeMessage
Remarks

This class is used within the XBee C# Library to read explicit data sent by remote devices.

Constructors

ExplicitXBeeMessage(RemoteXBeeDevice, Byte, Byte, Byte[], Byte[], Byte[])

Class constructor. Instantiates a new object of type ExplicitXBeeMessage with the given parameters.

Declaration
public ExplicitXBeeMessage(RemoteXBeeDevice remoteXBeeDevice, byte sourceEndpoint, byte destEndpoint, byte[] clusterID, byte[] profileID, byte[] data)
Parameters
Type Name Description
RemoteXBeeDevice remoteXBeeDevice

The remote XBee device the message belongs to (device that sent the message).
System.Byte sourceEndpoint

Endpoint of the source that initiated the transmission.
System.Byte destEndpoint

Endpoint of the destination the message was addressed to.
System.Byte[] clusterID

Cluster ID the packet was addressed to.
System.Byte[] profileID

Profile ID the packet was addressed to.
System.Byte[] data

Byte array containing the data of the message.
Exceptions
Type Condition
System.ArgumentException

If sourceEndpoint.Length != 2 or if destEndpoint.Length != 2.
System.ArgumentNullException

If remoteXBeeDevice == null or if data == null.

ExplicitXBeeMessage(RemoteXBeeDevice, Byte, Byte, Byte[], Byte[], Byte[], Boolean)

Class constructor. Instantiates a new object of type ExplicitXBeeMessage with the given parameters.

Declaration
public ExplicitXBeeMessage(RemoteXBeeDevice remoteXBeeDevice, byte sourceEndpoint, byte destEndpoint, byte[] clusterID, byte[] profileID, byte[] data, bool isBroadcast)
Parameters
Type Name Description
RemoteXBeeDevice remoteXBeeDevice

The remote XBee device the message belongs to (device that sent the message).
System.Byte sourceEndpoint

Endpoint of the source that initiated the transmission.
System.Byte destEndpoint

Endpoint of the destination the message was addressed to.
System.Byte[] clusterID

Cluster ID the packet was addressed to.
System.Byte[] profileID

Profile ID the packet was addressed to.
System.Byte[] data

Byte array containing the data of the message.
System.Boolean isBroadcast

Indicates if the message was received via broadcast.
Exceptions
Type Condition
System.ArgumentException

If sourceEndpoint.Length != 2 or if destEndpoint.Length != 2.
System.ArgumentNullException

If remoteXBeeDevice == null or if data == null.

Properties

ClusterID

The cluster ID the packet was addressed to.

Declaration
public byte[] ClusterID { get; }
Property Value
Type Description
System.Byte[]

DestEndpoint

The endpoint of the destination the message was addressed to.

Declaration
public byte DestEndpoint { get; }
Property Value
Type Description
System.Byte

ProfileID

The profile ID the packet was addressed to.

Declaration
public byte[] ProfileID { get; }
Property Value
Type Description
System.Byte[]

SourceEndpoint

The endpoint of the source that initiated the transmission.

Declaration
public byte SourceEndpoint { get; }
Property Value
Type Description
System.Byte