Package 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	Description
static class	LXDatagram.BufferException
protected static class	LXDatagram.ErrorState

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

LXBufferOutput.ByteEncoder, LXBufferOutput.ByteOrder

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

LXOutput.GammaMode, LXOutput.GammaTable, LXOutput.InetOutput

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

LXComponent.Hidden, LXComponent.Placeholder, LXComponent.Renamable

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

LXSerializable.Utils

Field Summary

Fields

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

Fields inherited from class heronarts.lx.output.LXBufferOutput

indexBuffer

Fields inherited from class heronarts.lx.output.LXOutput

brightness, enabled, framesPerSecond, gamma, gammaMode, MAX_FRAMES_PER_SECOND, whitePointBlue, whitePointGreen, whitePointRed, whitePointWhite

Fields inherited from class heronarts.lx.LXComponent

children, internalParameters, KEY_CHILDREN, KEY_CLASS, KEY_COMPONENT_ID, KEY_ID, KEY_INTERNAL, KEY_PARAMETER_PATH, KEY_PARAMETERS, KEY_PATH, KEY_RESET, label, legacyInternalParameters, legacyParameters, lx, modulationColor, modulationControlsExpanded, modulationsExpanded, parameters, presetFile

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

NO_PORT

Fields inherited from interface heronarts.lx.LXPath

ROOT, ROOT_PREFIX, ROOT_SLASH

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LXDatagram(LX lx, IndexBuffer indexBuffer, int datagramSize)

Method Summary

Modifier and Type	Method	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, LXOutput.GammaTable glut, double brightness)	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, updateDataBuffer

Methods inherited from class heronarts.lx.output.LXOutput

error, error, load, log, onParameterChanged, send, send, setGammaDelegate, setGammaTable, setGammaTable, setGroup

Methods inherited from class heronarts.lx.LXComponent

addArray, addChild, addInternalParameter, addLegacyInternalParameter, addLegacyParameter, addParameter, addParameter, addParameters, contains, copyParameters, getCategory, getChild, getComponentName, getComponentName, getComponentName, getDescription, getId, getLabel, getLX, getOscAddress, getOscLabel, getOscPath, getParameter, getParameters, getParent, getPath, handleOscMessage, hasParameter, isValidOscParameter, loadParameters, loadPreset, removeParameter, removeParameter, removeParameter, removeParameter, save, savePreset, setDescription, setParent, toOscQuery, toOscQuery, toOscQuery, 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

getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, isDescendant

Field Details

buffer

protected final byte[] buffer

error

public final BooleanParameter error

Whether this datagram is in an error state

Constructor Details

LXDatagram

protected LXDatagram(LX lx,
 IndexBuffer indexBuffer,
 int datagramSize)

Method Details

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,
 LXOutput.GammaTable glut,
 double brightness)

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 curves for 0-255 levels

brightness - Brightness level to send at

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