Package com.ctre.phoenix6

Enum Timestamp.TimestampSource

java.lang.Object

java.lang.Enum<Timestamp.TimestampSource>

com.ctre.phoenix6.Timestamp.TimestampSource

All Implemented Interfaces:

Serializable, Comparable<Timestamp.TimestampSource>, java.lang.constant.Constable

Enclosing class:

Timestamp

public static enum Timestamp.TimestampSource
extends Enum<Timestamp.TimestampSource>

Source of the timestamp.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CANivore	Timestamp as reported by the CANivore.
Device	This timestamp source requires Phoenix Pro.
System	Timestamp as reported by the system.

Field Summary

Fields

Modifier and Type	Field	Description
int	value

Method Summary

Modifier and Type	Method	Description
static Timestamp.TimestampSource	valueOf(int value)	Gets TimestampSource from specified value
static Timestamp.TimestampSource	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Timestamp.TimestampSource[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

System

public static final Timestamp.TimestampSource System

Timestamp as reported by the system. This timestamp is captured when the system receives the signal value.

This timestamp is present on all systems and is guaranteed to be monotonic. However, this timestamp is the least accurate due to processing delays within the system.

CANivore

public static final Timestamp.TimestampSource CANivore

Timestamp as reported by the CANivore. This timestamp is captured when the CANivore receives the signal value.

The CANivore is synchronized to the system monotonic clock and benefits from reduced latency over the System timestamp.

On the native roboRIO CAN bus, this timestamp is equivalent to the System timestamp.

When used with CANivore, the only inaccuracy in this measurement is latency from CAN bus arbitration.

Device

public static final Timestamp.TimestampSource Device

This timestamp source requires Phoenix Pro.

Timestamp as reported by the device. This timestamp is captured when the device transmits the signal value. Because it is timestamped in the device, it is the most accurate timestamp source.

This timestamp is synchronized to the CANivore clock, which is itself synchronized to the system monotonic clock. As a result, this timestamp source requires a CANivore.

It can be assumed there is no latency between this timestamp and when the data was taken.

Field Details

value

public final int value

Method Details

values

public static Timestamp.TimestampSource[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Timestamp.TimestampSource valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

valueOf

public static Timestamp.TimestampSource valueOf(int value)

Gets TimestampSource from specified value

Parameters:

value - Value of TimestampSouce

Returns:

TimestampSource of specified value