Index

A C D E F G H I L N O R S T W
All Classes and Interfaces|All Packages|Constant Field Values

A

addFault(String) - Static method in class dev.doglog.internal.FaultLogger

addFault(String, Alert.Level) - Static method in class dev.doglog.internal.FaultLogger

Log a fault.

C

captureConsole() - Method in record class dev.doglog.DogLogOptions

Returns the value of the captureConsole record component.

captureDs() - Method in record class dev.doglog.DogLogOptions

Returns the value of the captureDs record component.

clearFault(Enum) - Static method in class dev.doglog.DogLog

Reset the count of a fault to 0, and set the alert associated with the fault to inactive if possible.

clearFault(String) - Static method in class dev.doglog.DogLog

Reset the count of a fault to 0, and set the alert associated with the fault to inactive if possible.

clearFault(String) - Static method in class dev.doglog.internal.FaultLogger

close() - Method in class dev.doglog.internal.extras.ExtrasLogger

create(String, boolean, BooleanConsumer) - Method in class dev.doglog.internal.tunable.TunableManager

create(String, double[], String, Consumer) - Method in class dev.doglog.internal.tunable.TunableManager

create(String, double, String, DoubleConsumer) - Method in class dev.doglog.internal.tunable.TunableManager

create(String, float, String, FloatConsumer) - Method in class dev.doglog.internal.tunable.TunableManager

create(String, long, String, LongConsumer) - Method in class dev.doglog.internal.tunable.TunableManager

create(String, String, Consumer) - Method in class dev.doglog.internal.tunable.TunableManager

create(String, M, Consumer) - Method in class dev.doglog.internal.tunable.TunableManager

D

decreaseFault(Enum) - Static method in class dev.doglog.DogLog

Lower the count of a fault by 1, unless it is already at 0.

decreaseFault(String) - Static method in class dev.doglog.DogLog

Lower the count of a fault by 1, unless it is already at 0.

decreaseFault(String) - Static method in class dev.doglog.internal.FaultLogger

Remove the alert associated with a fault.

dev.doglog - package dev.doglog

DogLog is a thin, opinionated wrapper over WPILib Telemetry and Tunables for FRC.

dev.doglog.internal - package dev.doglog.internal

Internal classes used by DogLog.

dev.doglog.internal.extras - package dev.doglog.internal.extras

dev.doglog.internal.tunable - package dev.doglog.internal.tunable

DISCONNECTED - Static variable in record class dev.doglog.internal.extras.RadioLogResult

DogLog - Class in dev.doglog

A logger based on WPILib's Telemetry API.

DogLog() - Constructor for class dev.doglog.DogLog

DogLogOptions - Record Class in dev.doglog

Options for configuring DogLog.

DogLogOptions() - Constructor for record class dev.doglog.DogLogOptions

Create a new options object using the default options.

DogLogOptions(boolean, boolean, boolean, BooleanSupplier) - Constructor for record class dev.doglog.DogLogOptions

Creates an instance of a DogLogOptions record class.

E

enabled - Static variable in class dev.doglog.DogLog

Whether the logger is enabled.

epochLogger - Static variable in class dev.doglog.DogLog

EpochLogger - Class in dev.doglog.internal

EpochLogger() - Constructor for class dev.doglog.internal.EpochLogger

equals(Object) - Method in record class dev.doglog.DogLogOptions

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class dev.doglog.internal.extras.RadioLogResult

Indicates whether some other object is "equal to" this one.

ExtrasLogger - Class in dev.doglog.internal.extras

Logs "extra" information.

ExtrasLogger(DogLogOptions) - Constructor for class dev.doglog.internal.extras.ExtrasLogger

F

FaultLogger - Class in dev.doglog.internal

Provides the interface for logging faults.

faultsActive() - Static method in class dev.doglog.DogLog

Check if any faults logged using logged using DogLog.logFault(String) are currently active.

faultsActive() - Static method in class dev.doglog.internal.FaultLogger

faultsLogged() - Static method in class dev.doglog.DogLog

Check if faults have been logged using DogLog.logFault(String).

faultsLogged() - Static method in class dev.doglog.internal.FaultLogger

G

getEnumStruct(Class) - Method in class dev.doglog.internal.StructRegistry

getOptions() - Static method in class dev.doglog.DogLog

Get the options used by the logger.

getRecordStruct(Class) - Method in class dev.doglog.internal.StructRegistry

H

hashCode() - Method in record class dev.doglog.DogLogOptions

Returns a hash code value for this object.

hashCode() - Method in record class dev.doglog.internal.extras.RadioLogResult

Returns a hash code value for this object.

I

isConnected() - Method in record class dev.doglog.internal.extras.RadioLogResult

Returns the value of the isConnected record component.

isEnabled() - Static method in class dev.doglog.DogLog

Returns whether the logger is enabled.

L

log(String, boolean) - Static method in class dev.doglog.DogLog

Log a boolean.

log(String, boolean[]) - Static method in class dev.doglog.DogLog

Log a boolean array.

log(String, double) - Static method in class dev.doglog.DogLog

Log a double.

log(String, double[]) - Static method in class dev.doglog.DogLog

Log a double array.

log(String, double[], String) - Static method in class dev.doglog.DogLog

Log a double array with unit metadata.

log(String, double[], Unit) - Static method in class dev.doglog.DogLog

Log a double array with unit metadata.

log(String, double, String) - Static method in class dev.doglog.DogLog

Log a double with unit metadata.

log(String, double, Unit) - Static method in class dev.doglog.DogLog

Log a double with unit metadata.

log(String, float) - Static method in class dev.doglog.DogLog

Log a float.

log(String, float[]) - Static method in class dev.doglog.DogLog

Log a float array.

log(String, float[], String) - Static method in class dev.doglog.DogLog

Log a float array with unit metadata.

log(String, float, String) - Static method in class dev.doglog.DogLog

Log a float with unit metadata.

log(String, int[]) - Static method in class dev.doglog.DogLog

Log an int array.

log(String, long) - Static method in class dev.doglog.DogLog

Log a long.

log(String, long[]) - Static method in class dev.doglog.DogLog

Log a long array.

log(String, long[], String) - Static method in class dev.doglog.DogLog

Log a long array with unit metadata.

log(String, long, String) - Static method in class dev.doglog.DogLog

Log a long with unit metadata.

log(String, E) - Static method in class dev.doglog.DogLog

Log an enum.

log(String, E[]) - Static method in class dev.doglog.DogLog

Log an enum array.

log(String, T) - Static method in class dev.doglog.DogLog

Log a struct or protobuf.

log(String, T[]) - Static method in class dev.doglog.DogLog

Log a struct array.

log(String, Record) - Static method in class dev.doglog.DogLog

Log a record.

log(String, Record[]) - Static method in class dev.doglog.DogLog

Log a record array.

log(String, String) - Static method in class dev.doglog.DogLog

Log a string.

log(String, String[]) - Static method in class dev.doglog.DogLog

Log a string array.

log(String, String, String) - Static method in class dev.doglog.DogLog

Log a string with a custom type string.

logExtras() - Method in record class dev.doglog.DogLogOptions

Returns the value of the logExtras record component.

logFault(Enum) - Static method in class dev.doglog.DogLog

Log a fault and create an error type Alert for it.

logFault(String) - Static method in class dev.doglog.DogLog

Log a fault and create an error type Alert for it.

logFault(String, Alert.Level) - Static method in class dev.doglog.DogLog

Log a fault and create an Alert for it at the specified level.

LOOP_PERIOD_SECONDS - Static variable in record class dev.doglog.DogLogOptions

N

ntTunables() - Method in record class dev.doglog.DogLogOptions

Returns the value of the ntTunables record component.

O

options - Static variable in class dev.doglog.DogLog

The options to use for the logger.

R

RadioLogResult - Record Class in dev.doglog.internal.extras

RadioLogResult(boolean, String) - Constructor for record class dev.doglog.internal.extras.RadioLogResult

Creates an instance of a RadioLogResult record class.

S

setEnabled(boolean) - Static method in class dev.doglog.DogLog

Set whether the logger is enabled.

setOptions(DogLogOptions) - Static method in class dev.doglog.DogLog

Update the options used by the logger.

setOptions(DogLogOptions) - Method in class dev.doglog.internal.extras.ExtrasLogger

setOptions(DogLogOptions) - Method in class dev.doglog.internal.tunable.TunableManager

setPdh(PowerDistribution) - Static method in class dev.doglog.DogLog

Set the PowerDistribution instance to use for logging PDH/PDP data when logging extras is enabled.

setPdh(PowerDistribution) - Method in class dev.doglog.internal.extras.ExtrasLogger

statusJson() - Method in record class dev.doglog.internal.extras.RadioLogResult

Returns the value of the statusJson record component.

StructRegistry - Class in dev.doglog.internal

Used internally for working with WPILib Structs.

StructRegistry() - Constructor for class dev.doglog.internal.StructRegistry

T

time(String) - Static method in class dev.doglog.DogLog

Start a timer to track how long an operation takes to execute.

time(String, long) - Method in class dev.doglog.internal.EpochLogger

timeEnd(String) - Static method in class dev.doglog.DogLog

Stop a timer started with DogLog.time(String) and log the duration in seconds to the specified key.

timeEnd(String, long) - Method in class dev.doglog.internal.EpochLogger

timestamp(String) - Static method in class dev.doglog.DogLog

Log the current FPGA timestamp.

toString() - Method in record class dev.doglog.DogLogOptions

Returns a string representation of this record class.

toString() - Method in record class dev.doglog.internal.extras.RadioLogResult

Returns a string representation of this record class.

tunable(String, boolean) - Static method in class dev.doglog.DogLog

Create a tunable boolean.

tunable(String, boolean, BooleanConsumer) - Static method in class dev.doglog.DogLog

Create a tunable boolean.

tunable(String, double) - Static method in class dev.doglog.DogLog

Create a tunable double.

tunable(String, double[]) - Static method in class dev.doglog.DogLog

Create a tunable double array.

tunable(String, double[], String) - Static method in class dev.doglog.DogLog

Create a tunable double array with unit metadata.

tunable(String, double[], String, Consumer) - Static method in class dev.doglog.DogLog

Create a tunable double array with unit metadata.

tunable(String, double[], Consumer) - Static method in class dev.doglog.DogLog

Create a tunable double array.

tunable(String, double[], Unit) - Static method in class dev.doglog.DogLog

Create a tunable double array with unit metadata.

tunable(String, double[], Unit, Consumer) - Static method in class dev.doglog.DogLog

Create a tunable double array with unit metadata.

tunable(String, double, String) - Static method in class dev.doglog.DogLog

Create a tunable double with unit metadata.

tunable(String, double, String, DoubleConsumer) - Static method in class dev.doglog.DogLog

Create a tunable double with unit metadata.

tunable(String, double, DoubleConsumer) - Static method in class dev.doglog.DogLog

Create a tunable double.

tunable(String, double, Unit) - Static method in class dev.doglog.DogLog

Create a tunable double with unit metadata.

tunable(String, double, Unit, DoubleConsumer) - Static method in class dev.doglog.DogLog

Create a tunable double with unit metadata.

tunable(String, float) - Static method in class dev.doglog.DogLog

Create a tunable float.

tunable(String, float, String) - Static method in class dev.doglog.DogLog

Create a tunable float with unit metadata.

tunable(String, float, String, FloatConsumer) - Static method in class dev.doglog.DogLog

Create a tunable float with unit metadata.

tunable(String, float, Unit) - Static method in class dev.doglog.DogLog

Create a tunable float with unit metadata.

tunable(String, float, Unit, FloatConsumer) - Static method in class dev.doglog.DogLog

Create a tunable float with unit metadata.

tunable(String, float, FloatConsumer) - Static method in class dev.doglog.DogLog

Create a tunable float.

tunable(String, long) - Static method in class dev.doglog.DogLog

Create a tunable integer.

tunable(String, long, String) - Static method in class dev.doglog.DogLog

Create a tunable integer with unit metadata.

tunable(String, long, String, LongConsumer) - Static method in class dev.doglog.DogLog

Create a tunable integer with unit metadata.

tunable(String, long, LongConsumer) - Static method in class dev.doglog.DogLog

Create a tunable integer.

tunable(String, long, Unit) - Static method in class dev.doglog.DogLog

Create a tunable integer with unit metadata.

tunable(String, long, Unit, LongConsumer) - Static method in class dev.doglog.DogLog

Create a tunable integer with unit metadata.

tunable(String, String) - Static method in class dev.doglog.DogLog

Create a tunable string.

tunable(String, String, Consumer) - Static method in class dev.doglog.DogLog

Create a tunable string.

tunable(String, M) - Static method in class dev.doglog.DogLog

Create a tunable from a measure, preserving the user-specified unit.

tunable(String, M, Consumer) - Static method in class dev.doglog.DogLog

Create a tunable from a measure, preserving the user-specified unit.

TunableManager - Class in dev.doglog.internal.tunable

Applies DogLog's enable policy to WPILib tunables.

TunableManager(DogLogOptions) - Constructor for class dev.doglog.internal.tunable.TunableManager

W

withCaptureConsole(boolean) - Method in record class dev.doglog.DogLogOptions

Create a new options object, inheriting the configuration from this one, with DogLogOptions.captureConsole set to the provided value.

withCaptureDs(boolean) - Method in record class dev.doglog.DogLogOptions

Create a new options object, inheriting the configuration from this one, with DogLogOptions.captureDs set to the provided value.

withLogExtras(boolean) - Method in record class dev.doglog.DogLogOptions

Create a new options object, inheriting the configuration from this one, with DogLogOptions.logExtras set to the provided value.

withNtTunables(boolean) - Method in record class dev.doglog.DogLogOptions

Create a new options object, inheriting the configuration from this one, with DogLogOptions.ntTunables set to the provided value.

withNtTunables(BooleanSupplier) - Method in record class dev.doglog.DogLogOptions

Create a new options object, inheriting the configuration from this one, with DogLogOptions.ntTunables set to the provided value.

A C D E F G H I L N O R S T W
All Classes and Interfaces|All Packages|Constant Field Values