Package com.reduxrobotics.frames

Class ShortArrayFrame<T>

java.lang.Object

com.reduxrobotics.frames.Frame<T>

com.reduxrobotics.frames.ShortArrayFrame<T>

public class ShortArrayFrame<T>
extends Frame<T>

Implements an object-holding Frame backed by a byte array. This avoids creation of new objects by only converting to objects when the value is requested.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ShortArrayFrame.ShortArrayToType<T>	Functional interface for a function mapping a double data value to the final frame type.

Nested classes/interfaces inherited from class com.reduxrobotics.frames.Frame

Frame.FrameCallback<FC>

Constructor Summary

Constructors

Constructor	Description
ShortArrayFrame(int capacity, double timestamp, T defaultData, ShortArrayFrame.ShortArrayToType<T> conversion)	Instantiates a new ShortArrayFrame.

Method Summary

Modifier and Type	Method	Description
void	clearData()	Flag that this frame's data is not valid.
short[]	getData()	Gets the underlying short array data.
T	getValue()	Returns the value of the data frame.
boolean	hasData()	Returns if this frame has data.
void	updateData(byte[] data, double timestamp)	Update the ShortArrayFrame with new short array data.

Methods inherited from class com.reduxrobotics.frames.Frame

addCallback, getFrameData, getTimestamp, maxTimestamp, removeCallback, update, waitForFrames

Methods inherited from class java.lang.Object

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

Constructor Details

ShortArrayFrame

public ShortArrayFrame(int capacity,
 double timestamp,
 T defaultData,
 ShortArrayFrame.ShortArrayToType<T> conversion)

Instantiates a new ShortArrayFrame.

Parameters:

capacity - The capacity of the short array value held.

timestamp - The timestamp the update happened at.

defaultData - An instance of the object to return before the first update happens.

conversion - A function that takes in a double and converts it to the final datatype.

Method Details

getValue

public T getValue()

Description copied from class: Frame

Returns the value of the data frame.

Specified by:

getValue in class Frame<T>

Returns:

the value the data frame holds.

hasData

public boolean hasData()

Returns if this frame has data.

Specified by:

hasData in class Frame<T>

Returns:

if this frame's data can be considered valid

clearData

public void clearData()

Flag that this frame's data is not valid.

getData

public short[] getData()

Gets the underlying short array data.

Returns:

the short array data as a type.

updateData

public void updateData(byte[] data,
 double timestamp)

Update the ShortArrayFrame with new short array data.

Parameters:

data - the new data to update with

timestamp - the timestamp at which it occured