LynxDatagram (FtcRobotController API)

java.lang.Object
- com.qualcomm.hardware.lynx.commands.LynxDatagram

```
public class LynxDatagram
extends java.lang.Object
```
A LynxDatagram represents the quantum of transmission of Lynx data between host and controller module.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`cbFrameBytesAndPacketLength` How much are the frame bytes and packet length accounted for in the overall packet length?
`static byte[]`	`frameBytes` Two particular bytes identify the start of a valid Controller Module data packet
`static java.nio.ByteOrder`	`LYNX_ENDIAN` All integral data is exchanged in 'little endian' format, least significant byte first (at lowest address/offset.

Constructor Summary

Constructors
Constructor and Description

LynxDatagram()

LynxDatagram(LynxMessage command)

Constructors
Constructor and Description
`LynxDatagram()`
`LynxDatagram(LynxMessage command)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`beginsWithFraming(byte[] data)` Does the indicated data begin with the framing bytes?
`static boolean`	`beginsWithFraming(java.nio.ByteBuffer buffer)`
`byte`	`computeChecksum()`
`void`	`fromByteArray(byte[] byteArray)`
`int`	`getChecksum()`
`int`	`getCommandNumber()` Note that we clear the response bit.
`int`	`getDestModuleAddress()`
`static int`	`getFixedPacketLength()`
`int`	`getMessageNumber()`
`int`	`getPacketId()`
`int`	`getPacketLength()`
`byte[]`	`getPayloadData()`
`TimeWindow`	`getPayloadTimeWindow()`
`int`	`getReferenceNumber()`
`int`	`getSourceModuleAddress()`
`boolean`	`isChecksumValid()`
`boolean`	`isResponse()`
`void`	`setChecksum(int value)`
`void`	`setDestModuleAddress(int value)`
`void`	`setMessageNumber(int value)`
`void`	`setPacketId(int value)`
`void`	`setPacketLength(int value)`
`void`	`setPayloadData(byte[] data)`
`void`	`setPayloadTimeWindow(TimeWindow payloadTimeWindow)`
`void`	`setReferenceNumber(int value)`
`void`	`setSourceModuleAddress(int value)`
`byte[]`	`toByteArray()`
`int`	`updatePacketLength()`

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

Field Detail
- LYNX_ENDIAN
```
public static final java.nio.ByteOrder LYNX_ENDIAN
```
  All integral data is exchanged in 'little endian' format, least significant byte first (at lowest address/offset.
- cbFrameBytesAndPacketLength
```
public static final int cbFrameBytesAndPacketLength
```
  How much are the frame bytes and packet length accounted for in the overall packet length?
  
  See Also:
  
  Constant Field Values
- frameBytes
```
public static final byte[] frameBytes
```
  Two particular bytes identify the start of a valid Controller Module data packet

Constructor Detail

LynxDatagram
```
public LynxDatagram()
```

LynxDatagram

public LynxDatagram(LynxMessage command)
             throws LynxUnsupportedCommandException

Throws:: LynxUnsupportedCommandException

Method Detail

beginsWithFraming
```
public static boolean beginsWithFraming(byte[] data)
```
Does the indicated data begin with the framing bytes?

beginsWithFraming

public static boolean beginsWithFraming(java.nio.ByteBuffer buffer)

setPayloadTimeWindow

public void setPayloadTimeWindow(TimeWindow payloadTimeWindow)

getPayloadTimeWindow

public TimeWindow getPayloadTimeWindow()

getPacketLength
```
public int getPacketLength()
```

setPacketLength

public void setPacketLength(int value)

getFixedPacketLength

public static int getFixedPacketLength()

updatePacketLength
```
public int updatePacketLength()
```

getDestModuleAddress
```
public int getDestModuleAddress()
```

setDestModuleAddress

public void setDestModuleAddress(int value)

getSourceModuleAddress
```
public int getSourceModuleAddress()
```

setSourceModuleAddress

public void setSourceModuleAddress(int value)

getMessageNumber
```
public int getMessageNumber()
```

setMessageNumber

public void setMessageNumber(int value)

getReferenceNumber
```
public int getReferenceNumber()
```

setReferenceNumber

public void setReferenceNumber(int value)

getPacketId
```
public int getPacketId()
```

setPacketId
```
public void setPacketId(int value)
```

isResponse
```
public boolean isResponse()
```

getCommandNumber
```
public int getCommandNumber()
```
Note that we clear the response bit.

getPayloadData
```
public byte[] getPayloadData()
```

setPayloadData

public void setPayloadData(byte[] data)

getChecksum
```
public int getChecksum()
```

setChecksum
```
public void setChecksum(int value)
```

computeChecksum
```
public byte computeChecksum()
```

isChecksumValid
```
public boolean isChecksumValid()
```

toByteArray
```
public byte[] toByteArray()
```

fromByteArray

public void fromByteArray(byte[] byteArray)
                   throws RobotCoreException

Throws:: RobotCoreException

Class LynxDatagram

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LYNX_ENDIAN

cbFrameBytesAndPacketLength

frameBytes

Constructor Detail

LynxDatagram

LynxDatagram

Method Detail

beginsWithFraming

beginsWithFraming

setPayloadTimeWindow

getPayloadTimeWindow

getPacketLength

setPacketLength

getFixedPacketLength

updatePacketLength

getDestModuleAddress

setDestModuleAddress

getSourceModuleAddress

setSourceModuleAddress

getMessageNumber

setMessageNumber

getReferenceNumber

setReferenceNumber

getPacketId

setPacketId

isResponse

getCommandNumber

getPayloadData

setPayloadData

getChecksum

setChecksum

computeChecksum

isChecksumValid

toByteArray

fromByteArray