Package edu.wpi.first.util.datalog

Class StructLogEntry<T>

java.lang.Object

edu.wpi.first.util.datalog.DataLogEntry

edu.wpi.first.util.datalog.StructLogEntry<T>

Type Parameters:

T - value class

public final class StructLogEntry<T>
extends DataLogEntry

Log struct-encoded values.

Field Summary

Fields inherited from class edu.wpi.first.util.datalog.DataLogEntry

m_entry, m_log

Method Summary

Modifier and Type	Method	Description
void	append(T value)	Appends a record to the log.
void	append(T value, long timestamp)	Appends a record to the log.
static <T> StructLogEntry<T>	create(DataLog log, String name, Struct<T> struct)	Creates a struct-encoded log entry.
static <T> StructLogEntry<T>	create(DataLog log, String name, Struct<T> struct, long timestamp)	Creates a struct-encoded log entry.
static <T> StructLogEntry<T>	create(DataLog log, String name, Struct<T> struct, String metadata)	Creates a struct-encoded log entry.
static <T> StructLogEntry<T>	create(DataLog log, String name, Struct<T> struct, String metadata, long timestamp)	Creates a struct-encoded log entry.
T	getLastValue()	Gets the last value.
boolean	hasLastValue()	Gets whether there is a last value.
void	update(T value)	Updates the last value and appends a record to the log if it has changed.
void	update(T value, long timestamp)	Updates the last value and appends a record to the log if it has changed.

Methods inherited from class edu.wpi.first.util.datalog.DataLogEntry

finish, finish, setMetadata, setMetadata

Methods inherited from class java.lang.Object

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

Method Details

create

public static <T> StructLogEntry<T> create(DataLog log,
 String name,
 Struct<T> struct,
 String metadata,
 long timestamp)

Creates a struct-encoded log entry.

Type Parameters:

T - value class (inferred from struct)

Parameters:

log - datalog

name - name of the entry

struct - struct serialization implementation

metadata - metadata

timestamp - entry creation timestamp (0=now)

Returns:

StructLogEntry

create

public static <T> StructLogEntry<T> create(DataLog log,
 String name,
 Struct<T> struct,
 String metadata)

Creates a struct-encoded log entry.

Type Parameters:

T - value class (inferred from struct)

Parameters:

log - datalog

name - name of the entry

struct - struct serialization implementation

metadata - metadata

Returns:

StructLogEntry

create

public static <T> StructLogEntry<T> create(DataLog log,
 String name,
 Struct<T> struct,
 long timestamp)

Creates a struct-encoded log entry.

Type Parameters:

T - value class (inferred from struct)

Parameters:

log - datalog

name - name of the entry

struct - struct serialization implementation

timestamp - entry creation timestamp (0=now)

Returns:

StructLogEntry

create

public static <T> StructLogEntry<T> create(DataLog log,
 String name,
 Struct<T> struct)

Creates a struct-encoded log entry.

Type Parameters:

T - value class (inferred from struct)

Parameters:

log - datalog

name - name of the entry

struct - struct serialization implementation

Returns:

StructLogEntry

append

public void append(T value,
 long timestamp)

Appends a record to the log.

Parameters:

value - Value to record

timestamp - Time stamp (0 to indicate now)

append

public void append(T value)

Appends a record to the log.

Parameters:

value - Value to record

update

public void update(T value,
 long timestamp)

Updates the last value and appends a record to the log if it has changed.

Note: the last value is local to this class instance; using update() with two instances pointing to the same underlying log entry name will likely result in unexpected results.

Parameters:

value - Value to record

timestamp - Time stamp (0 to indicate now)

update

public void update(T value)

Updates the last value and appends a record to the log if it has changed.

Note: the last value is local to this class instance; using update() with two instances pointing to the same underlying log entry name will likely result in unexpected results.

Parameters:

value - Value to record

hasLastValue

public boolean hasLastValue()

Gets whether there is a last value.

Note: the last value is local to this class instance and updated only with update(), not append().

Returns:

True if last value exists, false otherwise.

getLastValue

public T getLastValue()

Gets the last value.

Note: the last value is local to this class instance and updated only with update(), not append().

Returns:

Last value, or null if none.