Class UserDataRelayOutputPacket

This class represents a User Data Relay Output packet.

Inheritance
System.Object
XBeePacket
XBeeAPIPacket
UserDataRelayOutputPacket
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: XBeeLibrary.Core.Packet.Relay
Assembly: XBeeLibrary.Core.dll
Syntax
public class UserDataRelayOutputPacket : XBeeAPIPacket
Remarks

The User Data Relay Output packet can be received from any relay interface.

The source interface must be one of the interfaces found in the corresponding enumerator.

Constructors

UserDataRelayOutputPacket(XBeeLocalInterface, Byte[])

Class constructor. Instantiates a new UserDataRelayOutputPacket object with the given parameters.

Declaration
public UserDataRelayOutputPacket(XBeeLocalInterface sourceInterface, byte[] data)
Parameters
Type Name Description
XBeeLocalInterface sourceInterface

The source interface.
System.Byte[] data

The data that is received from the source interface.
Exceptions
Type Condition
System.ArgumentException

If sourceInterface == UNKNOWN.
See Also

Properties

APIPacketParameters

Gets a map with the XBee packet parameters and their values.

Declaration
protected override LinkedDictionary<string, string> APIPacketParameters { get; }
Property Value
Type Description
LinkedDictionary<System.String, System.String>

A sorted map containing the XBee packet parameters with their values.
Overrides

APIPacketSpecificData

Gets the XBee API packet specific data.

Declaration
protected override byte[] APIPacketSpecificData { get; }
Property Value
Type Description
System.Byte[]
Overrides
Remarks

This does not include the frame ID if it is needed.

Data

The data that is received from the source interface.

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

IsBroadcast

Indicates whether the packet is a broadcast packet.

Declaration
public override bool IsBroadcast { get; }
Property Value
Type Description
System.Boolean
Overrides

NeedsAPIFrameID

Indicates whether the API packet needs API Frame ID or not.

Declaration
public override bool NeedsAPIFrameID { get; }
Property Value
Type Description
System.Boolean
Overrides

SourceInterface

The source XBee local interface.

Declaration
public XBeeLocalInterface SourceInterface { get; }
Property Value
Type Description
XBeeLocalInterface
See Also

Methods

CreatePacket(Byte[])

Creates a new UserDataRelayOutputPacket object from the given payload.

Declaration
public static UserDataRelayOutputPacket CreatePacket(byte[] payload)
Parameters
Type Name Description
System.Byte[] payload

The API frame payload. It must start with the frame type corresponding to a User Data Relay Output packet (0xAD). The byte array must be in API mode.
Returns
Type Description
UserDataRelayOutputPacket

Parsed User Data Relay Output packet.
Exceptions
Type Condition
System.ArgumentException

If payload[0] != APIFrameType.USER_DATA_RELAY_OUTPUT.GetValue() or if payload.length < XBeeLibrary.Core.Packet.Relay.UserDataRelayOutputPacket.MIN_API_PAYLOAD_LENGTH.
System.ArgumentNullException

If payload == null.

See Also