com.digi.xbee.api.models

Class ExplicitXBeeMessage

java.lang.Object

com.digi.xbee.api.models.XBeeMessage

com.digi.xbee.api.models.ExplicitXBeeMessage

public class ExplicitXBeeMessage
extends XBeeMessage

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.

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

Constructor Summary

Constructors

Constructor and Description
ExplicitXBeeMessage(RemoteXBeeDevice remoteXBeeDevice, int sourceEndpoint, int destEndpoint, int clusterID, int profileID, byte[] data) Class constructor.
ExplicitXBeeMessage(RemoteXBeeDevice remoteXBeeDevice, int sourceEndpoint, int destEndpoint, int clusterID, int profileID, byte[] data, boolean isBroadcast) Class constructor.

Method Summary

Methods

Modifier and Type	Method and Description
int	getClusterID() Returns the cluster ID the packet was addressed to.
int	getDestinationEndpoint() Returns the endpoint of the destination the message was addressed to.
int	getProfileID() Returns the profile ID the packet was addressed to.
int	getSourceEndpoint() Returns the endpoint of the source that initiated the transmission.

Methods inherited from class com.digi.xbee.api.models.XBeeMessage

getData, getDataString, getDevice, isBroadcast

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExplicitXBeeMessage

public ExplicitXBeeMessage(RemoteXBeeDevice remoteXBeeDevice,
                   int sourceEndpoint,
                   int destEndpoint,
                   int clusterID,
                   int profileID,
                   byte[] data)

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

Parameters:

remoteXBeeDevice - The remote XBee device the message belongs to. (device that sent the message)

sourceEndpoint - Endpoint of the source that initiated the transmission.

destEndpoint - Endpoint of the destination the message was addressed to.

clusterID - Cluster ID the packet was addressed to.

profileID - Profile ID the packet was addressed to.

data - Byte array containing the data of the message.

Throws:

IllegalArgumentException - if sourceEndpoint < 0 or if sourceEndpoint > 0xFF or if destEndpoint < 0 or if destEndpoint > 0xFF or if clusterID < 0 or if clusterID > 0xFFFF or if profileID < 0 or if profileID > 0xFFFF.

NullPointerException - if remoteXBeeDevice == null or if data == null.

See Also:

RemoteXBeeDevice

ExplicitXBeeMessage

public ExplicitXBeeMessage(RemoteXBeeDevice remoteXBeeDevice,
                   int sourceEndpoint,
                   int destEndpoint,
                   int clusterID,
                   int profileID,
                   byte[] data,
                   boolean isBroadcast)

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

Parameters:

remoteXBeeDevice - The remote XBee device the message belongs to. (device that sent the message)

sourceEndpoint - Endpoint of the source that initiated the transmission.

destEndpoint - Endpoint of the destination the message was addressed to.

clusterID - Cluster ID the packet was addressed to.

profileID - Profile ID the packet was addressed to.

data - Byte array containing the data of the message.

isBroadcast - Indicates if the message was received via broadcast.

Throws:

IllegalArgumentException - if sourceEndpoint < 0 or if sourceEndpoint > 0xFF or if destEndpoint < 0 or if destEndpoint > 0xFF or if clusterID < 0 or if clusterID > 0xFFFF or if profileID < 0 or if profileID > 0xFFFF.

NullPointerException - if remoteXBeeDevice == null or if data == null.

See Also:

RemoteXBeeDevice

Method Detail

getClusterID

public int getClusterID()

Returns the cluster ID the packet was addressed to.

Returns:

The cluster ID the packet was addressed to.

getDestinationEndpoint

public int getDestinationEndpoint()

Returns the endpoint of the destination the message was addressed to.

Returns:

The endpoint of the destination the message was addressed to.

getProfileID

public int getProfileID()

Returns the profile ID the packet was addressed to.

Returns:

The profile ID the packet was addressed to.

getSourceEndpoint

public int getSourceEndpoint()

Returns the endpoint of the source that initiated the transmission.

Returns:

The endpoint of the source that initiated the transmission.