heronarts.lx.output

Class LXDatagram

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.output.LXOutput

heronarts.lx.output.LXBufferOutput

heronarts.lx.output.LXDatagram

All Implemented Interfaces:

LXPath, LXSerializable, LXOutput.InetOutput, LXParameterListener

Direct Known Subclasses:

ArtNetDatagram, ArtSyncDatagram, DDPDatagram, KinetDatagram, OPCDatagram, StreamingACNDatagram

public abstract class LXDatagram
extends LXBufferOutput
implements LXOutput.InetOutput

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	LXDatagram.ErrorState

Nested classes/interfaces inherited from class heronarts.lx.output.LXBufferOutput

LXBufferOutput.ByteOrder

Nested classes/interfaces inherited from class heronarts.lx.output.LXOutput

LXOutput.GammaMode, LXOutput.InetOutput

Nested classes/interfaces inherited from class heronarts.lx.LXComponent

LXComponent.Placeholder, LXComponent.Renamable

Nested classes/interfaces inherited from interface heronarts.lx.LXSerializable

LXSerializable.Utils

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	buffer
BooleanParameter	error Whether this datagram is in an error state

Fields inherited from class heronarts.lx.output.LXBufferOutput

byteOrder, byteOrderBuffer, indexBuffer

Fields inherited from class heronarts.lx.output.LXOutput

brightness, enabled, framesPerSecond, gamma, gammaMode

Fields inherited from class heronarts.lx.LXComponent

controlSurfaceSemaphore, KEY_CLASS, KEY_COMPONENT_ID, KEY_ID, KEY_PARAMETER_PATH, KEY_PATH, label, lx, modulationColor

Fields inherited from interface heronarts.lx.output.LXOutput.InetOutput

NO_PORT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LXDatagram(LX lx, int[] indexBuffer, int datagramSize)
protected	LXDatagram(LX lx, int[] indexBuffer, LXBufferOutput.ByteOrder byteOrder, int datagramSize)

Method Summary

Modifier and Type	Method and Description
void	dispose() Invoked when the datagram is no longer needed.
InetAddress	getAddress() Gets the address this datagram sends to
byte[]	getDataBuffer() Returns the data buffer
protected LXDatagram.ErrorState	getErrorState()
int	getPort() Gets the destination port number this datagram is sent to
protected void	onSend(int[] colors, byte[] glut) Invoked by engine to send this packet when new color data is available.
LXDatagram	setAddress(InetAddress address) Sets the destination address of this datagram
LXDatagram	setPort(int port) Sets the destination port number to send this datagram to
LXDatagram	setSocket(DatagramSocket socket)
protected void	updateSequenceNumber() Subclasses may override to update a sequence number in the packet when appropriate as part of the protocol.
protected void	validateBufferSize()

Methods inherited from class heronarts.lx.output.LXBufferOutput

getDataBufferOffset, setByteOrder, setByteOrder, updateDataBuffer, updateIndexBuffer

Methods inherited from class heronarts.lx.output.LXOutput

error, error, getGammaLut, log, onParameterChanged, onSend, send, send, setGammaDelegate, setGroup

Methods inherited from class heronarts.lx.LXComponent

addArray, addChild, addInternalParameter, addParameter, addParameter, contains, copyParameters, getChild, getComponentName, getComponentName, getComponentName, getId, getLabel, getLX, getOscAddress, getOscLabel, getOscPath, getParameter, getParameters, getParent, getPath, handleOscMessage, load, loadParameters, removeParameter, removeParameter, save, saveParameters, setParent, toString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface heronarts.lx.LXPath

get, get, getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, getComponent, getComponent, getParameter, getParameter

Field Detail

buffer

protected final byte[] buffer

error

public final BooleanParameter error

Whether this datagram is in an error state

Constructor Detail

LXDatagram

protected LXDatagram(LX lx,
                     int[] indexBuffer,
                     int datagramSize)

LXDatagram

protected LXDatagram(LX lx,
                     int[] indexBuffer,
                     LXBufferOutput.ByteOrder byteOrder,
                     int datagramSize)

Method Detail

validateBufferSize

protected void validateBufferSize()

setSocket

public LXDatagram setSocket(DatagramSocket socket)

getErrorState

protected LXDatagram.ErrorState getErrorState()

setAddress

public LXDatagram setAddress(InetAddress address)

Sets the destination address of this datagram

Specified by:

setAddress in interface LXOutput.InetOutput

Parameters:

address - Destination address

Returns:

this

getAddress

public InetAddress getAddress()

Gets the address this datagram sends to

Specified by:

getAddress in interface LXOutput.InetOutput

Returns:

Destination address

setPort

public LXDatagram setPort(int port)

Sets the destination port number to send this datagram to

Specified by:

setPort in interface LXOutput.InetOutput

Parameters:

port - Port number

Returns:

this

getPort

public int getPort()

Gets the destination port number this datagram is sent to

Specified by:

getPort in interface LXOutput.InetOutput

Returns:

Destination port number

getDataBuffer

public byte[] getDataBuffer()

Returns the data buffer

Specified by:

getDataBuffer in class LXBufferOutput

Returns:

Raw byte buffer for output data

updateSequenceNumber

protected void updateSequenceNumber()

Subclasses may override to update a sequence number in the packet when appropriate as part of the protocol.

onSend

protected void onSend(int[] colors,
                      byte[] glut)

Invoked by engine to send this packet when new color data is available. The LXDatagram should update the packet object accordingly to contain the appropriate buffer.

Specified by:

onSend in class LXOutput

Parameters:

colors - Color buffer

glut - Look-up table with gamma-adjusted brightness values

dispose

public void dispose()

Invoked when the datagram is no longer needed. Typically a no-op, but subclasses may override if cleanup work is necessary.

Overrides:

dispose in class LXComponent