com.rapplogic.xbee.api.wpan
Class TxStatusResponse

java.lang.Object
  extended by com.rapplogic.xbee.api.XBeeResponse
      extended by com.rapplogic.xbee.api.XBeeFrameIdResponse
          extended by com.rapplogic.xbee.api.wpan.TxStatusResponse
All Implemented Interfaces:
java.io.Serializable

public class TxStatusResponse
extends XBeeFrameIdResponse

Series 1 XBee. This is sent out the UART of the transmitting XBee immediately following a Transmit packet. Indicates if the Transmit (TxRequest16 or TxRequest64) was successful.

API ID: 0x89

Author:
andrew
See Also:
Serialized Form

Nested Class Summary
static class TxStatusResponse.Status
           
 
Constructor Summary
TxStatusResponse()
           
 
Method Summary
 TxStatusResponse.Status getStatus()
           
 boolean isAckError()
           
 boolean isCcaError()
           
 boolean isPurged()
           
 boolean isSuccess()
          Returns true if the delivery status is SUCCESS
 void parse(IPacketParser parser)
          All subclasses must implement to parse the packet from the input stream.
 void setStatus(TxStatusResponse.Status status)
           
 java.lang.String toString()
           
 
Methods inherited from class com.rapplogic.xbee.api.XBeeFrameIdResponse
getFrameId, setFrameId
 
Methods inherited from class com.rapplogic.xbee.api.XBeeResponse
equals, finish, getApiId, getChecksum, getLength, getPacketBytes, getProcessedPacketBytes, getRawPacketBytes, hashCode, isError, setApiId, setChecksum, setError, setLength, setRawPacketBytes
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TxStatusResponse

public TxStatusResponse()
Method Detail

getStatus

public TxStatusResponse.Status getStatus()

setStatus

public void setStatus(TxStatusResponse.Status status)

isSuccess

public boolean isSuccess()
Returns true if the delivery status is SUCCESS


isAckError

public boolean isAckError()

isCcaError

public boolean isCcaError()

isPurged

public boolean isPurged()

parse

public void parse(IPacketParser parser)
           throws java.io.IOException
Description copied from class: XBeeResponse
All subclasses must implement to parse the packet from the input stream. The subclass must parse all bytes in the packet starting after the API_ID, and up to but not including the checksum. Reading either more or less bytes that expected will result in an error.

Specified by:
parse in class XBeeResponse
Throws:
java.io.IOException

toString

public java.lang.String toString()
Overrides:
toString in class XBeeFrameIdResponse