IEEE802154Message (JMRI API)

java.lang.Object
- jmri.jmrix.AbstractMessage
- - jmri.jmrix.AbstractMRMessage
  - - jmri.jmrix.ieee802154.IEEE802154Message

All Implemented Interfaces:

Message

Direct Known Subclasses:

XBeeMessage
```
public class IEEE802154Message
extends AbstractMRMessage
```
Contains the data payload of an IEEE 802.15.4 packet.

Field Summary

Fields
Modifier and Type Field Description

(package private) int responseLength
- Fields inherited from class jmri.jmrix.AbstractMRMessage
  LONG_TIMEOUT, SHORT_TIMEOUT
- Fields inherited from class jmri.jmrix.AbstractMessage
  _dataChars, _nDataChars

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`IEEE802154Message()`	Suppress the default ctor, as the length must always be specified
	`IEEE802154Message(byte[] a, int l)`	Deprecated, for removal: This API element is subject to removal in a future version. 5.13.5, unused, requires further development.
	`IEEE802154Message(int l)`
	`IEEE802154Message(java.lang.String m, int l)`	This ctor interprets the String as the exact sequence to send, byte-for-byte.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`checkParity()`	Check whether the message has a valid parity IEEE 802.15.4 messages have a two byte parity.
`int`	`getResponseLength()`
`void`	`setParity()`
`void`	`setResponseLength(int l)`

Methods inherited from class jmri.jmrix.AbstractMRMessage
addIntAsFourHex, addIntAsThree, addIntAsThreeHex, addIntAsTwoHex, getNeededMode, getOpCode, getOpCodeHex, getRetries, getTimeout, isBinary, replyExpected, setBinary, setNeededMode, setOpCode, setRetries, setTimeout, toString

Methods inherited from class jmri.jmrix.AbstractMessage
equals, getElement, getNumDataElements, hashCode, setElement

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface jmri.jmrix.Message
toMonitorString

- Field Detail
  - responseLength
```
int responseLength
```
- Constructor Detail
  - IEEE802154Message
```
protected IEEE802154Message()
```
    Suppress the default ctor, as the length must always be specified
  - IEEE802154Message
```
public IEEE802154Message(int l)
```
  - IEEE802154Message
```
public IEEE802154Message(java.lang.String m,
                         int l)
```
    This ctor interprets the String as the exact sequence to send, byte-for-byte.
    
    Parameters:
    
    m - msg to send
    
    l - length of expected response (not used)
  - IEEE802154Message
```
@Deprecated(since="5.13.5",
            forRemoval=true)
public IEEE802154Message(byte[] a,
                         int l)
```
    Deprecated, for removal: This API element is subject to removal in a future version.
    5.13.5, unused, requires further development.
    
    This ctor interprets the byte array as a sequence of characters to send.
    
    Parameters:
    
    a - Array of bytes to send
    
    l - length of expected response
- Method Detail
  - checkParity
```
public boolean checkParity()
```
    Check whether the message has a valid parity IEEE 802.15.4 messages have a two byte parity.
    
    Returns:
    
    true if parity is valid
  - setParity
```
public void setParity()
```
  - setResponseLength
```
public void setResponseLength(int l)
```
  - getResponseLength
```
public int getResponseLength()
```