Package edu.wpi.first.util.datalog

Class FloatLogEntry

java.lang.Object

edu.wpi.first.util.datalog.DataLogEntry

edu.wpi.first.util.datalog.FloatLogEntry

public class FloatLogEntry
extends DataLogEntry

Log float values.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	kDataType	The data type for float values.

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

m_entry, m_log

Constructor Summary

Constructors

Constructor	Description
FloatLogEntry(DataLog log, String name)	Constructs a float log entry.
FloatLogEntry(DataLog log, String name, long timestamp)	Constructs a float log entry.
FloatLogEntry(DataLog log, String name, String metadata)	Constructs a float log entry.
FloatLogEntry(DataLog log, String name, String metadata, long timestamp)	Constructs a float log entry.

Method Summary

Modifier and Type	Method	Description
void	append(float value)	Appends a record to the log.
void	append(float value, long timestamp)	Appends a record to the log.
float	getLastValue()	Gets the last value.
boolean	hasLastValue()	Gets whether there is a last value.
void	update(float value)	Updates the last value and appends a record to the log if it has changed.
void	update(float 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

Field Details

kDataType

public static final String kDataType

The data type for float values.

See Also:

• Constant Field Values

Constructor Details

FloatLogEntry

public FloatLogEntry(DataLog log,
 String name,
 String metadata,
 long timestamp)

Constructs a float log entry.

Parameters:

log - datalog

name - name of the entry

metadata - metadata

timestamp - entry creation timestamp (0=now)

FloatLogEntry

public FloatLogEntry(DataLog log,
 String name,
 String metadata)

Constructs a float log entry.

Parameters:

log - datalog

name - name of the entry

metadata - metadata

FloatLogEntry

public FloatLogEntry(DataLog log,
 String name,
 long timestamp)

Constructs a float log entry.

Parameters:

log - datalog

name - name of the entry

timestamp - entry creation timestamp (0=now)

FloatLogEntry

public FloatLogEntry(DataLog log,
 String name)

Constructs a float log entry.

Parameters:

log - datalog

name - name of the entry

Method Details

append

public void append(float 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(float value)

Appends a record to the log.

Parameters:

value - Value to record

update

public void update(float 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(float 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 float 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 0 if none.