Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- acceptDefault() - Method in record class dev.doglog.internal.tunable.on_change.BooleanOnChange
- acceptDefault() - Method in record class dev.doglog.internal.tunable.on_change.DoubleOnChange
- acceptDefault() - Method in record class dev.doglog.internal.tunable.on_change.FloatOnChange
- acceptDefault() - Method in record class dev.doglog.internal.tunable.on_change.LongOnChange
- acceptDefault() - Method in record class dev.doglog.internal.tunable.on_change.OnChange
- addFault(LogQueuer, String) - Static method in class dev.doglog.internal.FaultLogger
- addFault(LogQueuer, String, Alert.AlertType) - Static method in class dev.doglog.internal.FaultLogger
-
Log a fault.
- afterLogThreadStart() - Method in class dev.doglog.internal.log_thread.reporters.CombinedReporter
-
Runs code that may produce logs, and thus must be run once all DogLog init logic has been run.
B
- BaseQueuedLogEntry - Class in dev.doglog.internal.log_thread.entries
- BaseQueuedLogEntry(EntryType, String, long) - Constructor for class dev.doglog.internal.log_thread.entries.BaseQueuedLogEntry
- BOOLEAN - Enum constant in enum class dev.doglog.internal.log_thread.entries.EntryType
- BOOLEAN_ARRAY - Enum constant in enum class dev.doglog.internal.log_thread.entries.EntryType
- BooleanArrayQueuedLogEntry - Class in dev.doglog.internal.log_thread.entries
- BooleanArrayQueuedLogEntry(String, long, boolean[]) - Constructor for class dev.doglog.internal.log_thread.entries.BooleanArrayQueuedLogEntry
- BooleanOnChange - Record Class in dev.doglog.internal.tunable.on_change
- BooleanOnChange(BooleanConsumer, boolean) - Constructor for record class dev.doglog.internal.tunable.on_change.BooleanOnChange
-
Creates an instance of a
BooleanOnChange
record class. - BooleanQueuedLogEntry - Class in dev.doglog.internal.log_thread.entries
- BooleanQueuedLogEntry(String, long, boolean) - Constructor for class dev.doglog.internal.log_thread.entries.BooleanQueuedLogEntry
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. - captureNt() - Method in record class dev.doglog.DogLogOptions
-
Returns the value of the
captureNt
record component. - clearFault(LogQueuer, String) - Static method in class dev.doglog.internal.FaultLogger
- 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.
- close() - Method in class dev.doglog.internal.log_thread.reporters.NetworkTablesReporter
- close() - Method in class dev.doglog.internal.tunable.entry.ToggleableBooleanSubscriber
- close() - Method in class dev.doglog.internal.tunable.entry.ToggleableDoubleSubscriber
- close() - Method in class dev.doglog.internal.tunable.entry.ToggleableFloatSubscriber
- close() - Method in class dev.doglog.internal.tunable.entry.ToggleableIntegerSubscriber
- close() - Method in class dev.doglog.internal.tunable.entry.ToggleableStringSubscriber
- close() - Method in class dev.doglog.internal.tunable.Tunable
- CombinedReporter - Class in dev.doglog.internal.log_thread.reporters
- CombinedReporter(DogLogOptions) - Constructor for class dev.doglog.internal.log_thread.reporters.CombinedReporter
- create(String, boolean, BooleanConsumer) - Method in class dev.doglog.internal.tunable.Tunable
- create(String, double, DoubleConsumer) - Method in class dev.doglog.internal.tunable.Tunable
- create(String, float, FloatConsumer) - Method in class dev.doglog.internal.tunable.Tunable
- create(String, long, LongConsumer) - Method in class dev.doglog.internal.tunable.Tunable
- create(String, String, Consumer<String>) - Method in class dev.doglog.internal.tunable.Tunable
- customTypeString - Variable in class dev.doglog.internal.log_thread.entries.StringCustomTypeQueuedLogEntry
D
- DataLogReporter - Class in dev.doglog.internal.log_thread.reporters
-
Logs to a WPILib
DataLog
. - DataLogReporter(String, DogLogOptions) - Constructor for class dev.doglog.internal.log_thread.reporters.DataLogReporter
- decreaseFault(LogQueuer, String) - Static method in class dev.doglog.internal.FaultLogger
-
Remove the alert associated with a fault.
- 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.
- defaultValue() - Method in record class dev.doglog.internal.tunable.on_change.BooleanOnChange
-
Returns the value of the
defaultValue
record component. - defaultValue() - Method in record class dev.doglog.internal.tunable.on_change.DoubleOnChange
-
Returns the value of the
defaultValue
record component. - defaultValue() - Method in record class dev.doglog.internal.tunable.on_change.FloatOnChange
-
Returns the value of the
defaultValue
record component. - defaultValue() - Method in record class dev.doglog.internal.tunable.on_change.LongOnChange
-
Returns the value of the
defaultValue
record component. - defaultValue() - Method in record class dev.doglog.internal.tunable.on_change.OnChange
-
Returns the value of the
defaultValue
record component. - dev.doglog - package dev.doglog
-
DogLog is a simple, unopinionated logging library 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.log_thread - package dev.doglog.internal.log_thread
-
Code owned by the log thread.
- dev.doglog.internal.log_thread.entries - package dev.doglog.internal.log_thread.entries
-
Log entry classes.
- dev.doglog.internal.log_thread.reporters - package dev.doglog.internal.log_thread.reporters
- dev.doglog.internal.tunable - package dev.doglog.internal.tunable
- dev.doglog.internal.tunable.entry - package dev.doglog.internal.tunable.entry
- dev.doglog.internal.tunable.on_change - package dev.doglog.internal.tunable.on_change
- DogLog - Class in dev.doglog
-
A logger based on WPILib's
DataLogManager
- 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(BooleanSupplier, boolean, boolean, boolean, boolean, int, BooleanSupplier) - Constructor for record class dev.doglog.DogLogOptions
-
Creates an instance of a
DogLogOptions
record class. - DOUBLE - Enum constant in enum class dev.doglog.internal.log_thread.entries.EntryType
- DOUBLE_ARRAY - Enum constant in enum class dev.doglog.internal.log_thread.entries.EntryType
- DoubleArrayQueuedLogEntry - Class in dev.doglog.internal.log_thread.entries
- DoubleArrayQueuedLogEntry(String, long, double[]) - Constructor for class dev.doglog.internal.log_thread.entries.DoubleArrayQueuedLogEntry
- DoubleOnChange - Record Class in dev.doglog.internal.tunable.on_change
- DoubleOnChange(DoubleConsumer, double) - Constructor for record class dev.doglog.internal.tunable.on_change.DoubleOnChange
-
Creates an instance of a
DoubleOnChange
record class. - DoubleQueuedLogEntry - Class in dev.doglog.internal.log_thread.entries
- DoubleQueuedLogEntry(String, long, double) - Constructor for class dev.doglog.internal.log_thread.entries.DoubleQueuedLogEntry
E
- enabled - Static variable in class dev.doglog.DogLog
-
Whether the logger is enabled.
- end(boolean) - Method in class dev.doglog.internal.TimedCommand
- EntryType - Enum Class in dev.doglog.internal.log_thread.entries
-
The type of a queued log entry.
- epochLogger - Static variable in class dev.doglog.DogLog
- EpochLogger - Class in dev.doglog.internal
- EpochLogger(LogQueuer) - 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.tunable.on_change.BooleanOnChange
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.doglog.internal.tunable.on_change.DoubleOnChange
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.doglog.internal.tunable.on_change.FloatOnChange
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.doglog.internal.tunable.on_change.LongOnChange
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.doglog.internal.tunable.on_change.OnChange
-
Indicates whether some other object is "equal to" this one.
- execute() - Method in class dev.doglog.internal.TimedCommand
- exists() - Method in class dev.doglog.internal.tunable.entry.ToggleableBooleanSubscriber
- exists() - Method in class dev.doglog.internal.tunable.entry.ToggleableDoubleSubscriber
- exists() - Method in class dev.doglog.internal.tunable.entry.ToggleableFloatSubscriber
- exists() - Method in class dev.doglog.internal.tunable.entry.ToggleableIntegerSubscriber
- exists() - Method in class dev.doglog.internal.tunable.entry.ToggleableStringSubscriber
- ExtrasLogger - Class in dev.doglog.internal.extras
-
Logs "extra" information.
- ExtrasLogger(LogQueuer, 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
- FLOAT - Enum constant in enum class dev.doglog.internal.log_thread.entries.EntryType
- FLOAT_ARRAY - Enum constant in enum class dev.doglog.internal.log_thread.entries.EntryType
- FloatArrayQueuedLogEntry - Class in dev.doglog.internal.log_thread.entries
- FloatArrayQueuedLogEntry(String, long, float[]) - Constructor for class dev.doglog.internal.log_thread.entries.FloatArrayQueuedLogEntry
- FloatOnChange - Record Class in dev.doglog.internal.tunable.on_change
- FloatOnChange(FloatConsumer, float) - Constructor for record class dev.doglog.internal.tunable.on_change.FloatOnChange
-
Creates an instance of a
FloatOnChange
record class. - FloatQueuedLogEntry - Class in dev.doglog.internal.log_thread.entries
- FloatQueuedLogEntry(String, long, float) - Constructor for class dev.doglog.internal.log_thread.entries.FloatQueuedLogEntry
G
- get() - Method in class dev.doglog.internal.tunable.entry.ToggleableBooleanSubscriber
- get() - Method in class dev.doglog.internal.tunable.entry.ToggleableDoubleSubscriber
- get() - Method in class dev.doglog.internal.tunable.entry.ToggleableFloatSubscriber
- get() - Method in class dev.doglog.internal.tunable.entry.ToggleableIntegerSubscriber
- get() - Method in class dev.doglog.internal.tunable.entry.ToggleableStringSubscriber
- get(boolean) - Method in class dev.doglog.internal.tunable.entry.ToggleableBooleanSubscriber
- get(double) - Method in class dev.doglog.internal.tunable.entry.ToggleableDoubleSubscriber
- get(float) - Method in class dev.doglog.internal.tunable.entry.ToggleableFloatSubscriber
- get(long) - Method in class dev.doglog.internal.tunable.entry.ToggleableIntegerSubscriber
- get(String) - Method in class dev.doglog.internal.tunable.entry.ToggleableStringSubscriber
- getAtomic() - Method in class dev.doglog.internal.tunable.entry.ToggleableBooleanSubscriber
- getAtomic() - Method in class dev.doglog.internal.tunable.entry.ToggleableDoubleSubscriber
- getAtomic() - Method in class dev.doglog.internal.tunable.entry.ToggleableFloatSubscriber
- getAtomic() - Method in class dev.doglog.internal.tunable.entry.ToggleableIntegerSubscriber
- getAtomic() - Method in class dev.doglog.internal.tunable.entry.ToggleableStringSubscriber
- getAtomic(boolean) - Method in class dev.doglog.internal.tunable.entry.ToggleableBooleanSubscriber
- getAtomic(double) - Method in class dev.doglog.internal.tunable.entry.ToggleableDoubleSubscriber
- getAtomic(float) - Method in class dev.doglog.internal.tunable.entry.ToggleableFloatSubscriber
- getAtomic(long) - Method in class dev.doglog.internal.tunable.entry.ToggleableIntegerSubscriber
- getAtomic(String) - Method in class dev.doglog.internal.tunable.entry.ToggleableStringSubscriber
- getHandle() - Method in class dev.doglog.internal.tunable.entry.ToggleableBooleanSubscriber
- getHandle() - Method in class dev.doglog.internal.tunable.entry.ToggleableDoubleSubscriber
- getHandle() - Method in class dev.doglog.internal.tunable.entry.ToggleableFloatSubscriber
- getHandle() - Method in class dev.doglog.internal.tunable.entry.ToggleableIntegerSubscriber
- getHandle() - Method in class dev.doglog.internal.tunable.entry.ToggleableStringSubscriber
- getLastChange() - Method in class dev.doglog.internal.tunable.entry.ToggleableBooleanSubscriber
- getLastChange() - Method in class dev.doglog.internal.tunable.entry.ToggleableDoubleSubscriber
- getLastChange() - Method in class dev.doglog.internal.tunable.entry.ToggleableFloatSubscriber
- getLastChange() - Method in class dev.doglog.internal.tunable.entry.ToggleableIntegerSubscriber
- getLastChange() - Method in class dev.doglog.internal.tunable.entry.ToggleableStringSubscriber
- getOptions() - Static method in class dev.doglog.DogLog
-
Get the options used by the logger.
- getStruct(Class<?>) - Static method in class dev.doglog.internal.log_thread.StructRegistry
- getTopic() - Method in class dev.doglog.internal.tunable.entry.ToggleableBooleanSubscriber
- getTopic() - Method in class dev.doglog.internal.tunable.entry.ToggleableDoubleSubscriber
- getTopic() - Method in class dev.doglog.internal.tunable.entry.ToggleableFloatSubscriber
- getTopic() - Method in class dev.doglog.internal.tunable.entry.ToggleableIntegerSubscriber
- getTopic() - Method in class dev.doglog.internal.tunable.entry.ToggleableStringSubscriber
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.tunable.on_change.BooleanOnChange
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.doglog.internal.tunable.on_change.DoubleOnChange
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.doglog.internal.tunable.on_change.FloatOnChange
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.doglog.internal.tunable.on_change.LongOnChange
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.doglog.internal.tunable.on_change.OnChange
-
Returns a hash code value for this object.
I
- initialize() - Method in class dev.doglog.internal.TimedCommand
- INTEGER - Enum constant in enum class dev.doglog.internal.log_thread.entries.EntryType
- INTEGER_ARRAY - Enum constant in enum class dev.doglog.internal.log_thread.entries.EntryType
- IntegerArrayQueuedLogEntry - Class in dev.doglog.internal.log_thread.entries
- IntegerArrayQueuedLogEntry(String, long, int[]) - Constructor for class dev.doglog.internal.log_thread.entries.IntegerArrayQueuedLogEntry
- IntegerArrayQueuedLogEntry(String, long, long[]) - Constructor for class dev.doglog.internal.log_thread.entries.IntegerArrayQueuedLogEntry
- IntegerQueuedLogEntry - Class in dev.doglog.internal.log_thread.entries
- IntegerQueuedLogEntry(String, long, long) - Constructor for class dev.doglog.internal.log_thread.entries.IntegerQueuedLogEntry
- isConnected - Variable in class dev.doglog.internal.extras.RadioLogResult
- isEnabled() - Static method in class dev.doglog.DogLog
-
Returns whether the logger is enabled.
- isFinished() - Method in class dev.doglog.internal.TimedCommand
- isLogDestinationValid() - Method in class dev.doglog.internal.log_thread.reporters.DataLogReporter
-
This could be a static method, but it's not because this class controls initializing
DataLogManager
, which has to be done before this method can be called. - isValid() - Method in class dev.doglog.internal.tunable.entry.ToggleableBooleanSubscriber
- isValid() - Method in class dev.doglog.internal.tunable.entry.ToggleableDoubleSubscriber
- isValid() - Method in class dev.doglog.internal.tunable.entry.ToggleableFloatSubscriber
- isValid() - Method in class dev.doglog.internal.tunable.entry.ToggleableIntegerSubscriber
- isValid() - Method in class dev.doglog.internal.tunable.entry.ToggleableStringSubscriber
K
- key - Variable in class dev.doglog.internal.log_thread.entries.BaseQueuedLogEntry
L
- log(long, String, boolean) - Method in class dev.doglog.internal.log_thread.reporters.CombinedReporter
- log(long, String, boolean) - Method in class dev.doglog.internal.log_thread.reporters.DataLogReporter
- log(long, String, boolean) - Method in class dev.doglog.internal.log_thread.reporters.NetworkTablesReporter
- log(long, String, boolean) - Method in interface dev.doglog.internal.log_thread.reporters.Reporter
- log(long, String, boolean[]) - Method in class dev.doglog.internal.log_thread.reporters.CombinedReporter
- log(long, String, boolean[]) - Method in class dev.doglog.internal.log_thread.reporters.DataLogReporter
- log(long, String, boolean[]) - Method in class dev.doglog.internal.log_thread.reporters.NetworkTablesReporter
- log(long, String, boolean[]) - Method in interface dev.doglog.internal.log_thread.reporters.Reporter
- log(long, String, double) - Method in class dev.doglog.internal.log_thread.reporters.CombinedReporter
- log(long, String, double) - Method in class dev.doglog.internal.log_thread.reporters.DataLogReporter
- log(long, String, double) - Method in class dev.doglog.internal.log_thread.reporters.NetworkTablesReporter
- log(long, String, double) - Method in interface dev.doglog.internal.log_thread.reporters.Reporter
- log(long, String, double[]) - Method in class dev.doglog.internal.log_thread.reporters.CombinedReporter
- log(long, String, double[]) - Method in class dev.doglog.internal.log_thread.reporters.DataLogReporter
- log(long, String, double[]) - Method in class dev.doglog.internal.log_thread.reporters.NetworkTablesReporter
- log(long, String, double[]) - Method in interface dev.doglog.internal.log_thread.reporters.Reporter
- log(long, String, float) - Method in class dev.doglog.internal.log_thread.reporters.CombinedReporter
- log(long, String, float) - Method in class dev.doglog.internal.log_thread.reporters.DataLogReporter
- log(long, String, float) - Method in class dev.doglog.internal.log_thread.reporters.NetworkTablesReporter
- log(long, String, float) - Method in interface dev.doglog.internal.log_thread.reporters.Reporter
- log(long, String, float[]) - Method in class dev.doglog.internal.log_thread.reporters.CombinedReporter
- log(long, String, float[]) - Method in class dev.doglog.internal.log_thread.reporters.DataLogReporter
- log(long, String, float[]) - Method in class dev.doglog.internal.log_thread.reporters.NetworkTablesReporter
- log(long, String, float[]) - Method in interface dev.doglog.internal.log_thread.reporters.Reporter
- log(long, String, long) - Method in class dev.doglog.internal.log_thread.reporters.CombinedReporter
- log(long, String, long) - Method in class dev.doglog.internal.log_thread.reporters.DataLogReporter
- log(long, String, long) - Method in class dev.doglog.internal.log_thread.reporters.NetworkTablesReporter
- log(long, String, long) - Method in interface dev.doglog.internal.log_thread.reporters.Reporter
- log(long, String, long[]) - Method in class dev.doglog.internal.log_thread.reporters.CombinedReporter
- log(long, String, long[]) - Method in class dev.doglog.internal.log_thread.reporters.DataLogReporter
- log(long, String, long[]) - Method in class dev.doglog.internal.log_thread.reporters.NetworkTablesReporter
- log(long, String, long[]) - Method in interface dev.doglog.internal.log_thread.reporters.Reporter
- log(long, String, Struct<T>, T) - Method in class dev.doglog.internal.log_thread.reporters.DataLogReporter
- log(long, String, Struct<T>, T) - Method in class dev.doglog.internal.log_thread.reporters.NetworkTablesReporter
- log(long, String, Struct<T>, T) - Method in interface dev.doglog.internal.log_thread.reporters.Reporter
- log(long, String, Struct<T>, T[]) - Method in class dev.doglog.internal.log_thread.reporters.DataLogReporter
- log(long, String, Struct<T>, T[]) - Method in class dev.doglog.internal.log_thread.reporters.NetworkTablesReporter
- log(long, String, Struct<T>, T[]) - Method in interface dev.doglog.internal.log_thread.reporters.Reporter
- log(long, String, String) - Method in class dev.doglog.internal.log_thread.reporters.CombinedReporter
- log(long, String, String) - Method in class dev.doglog.internal.log_thread.reporters.DataLogReporter
- log(long, String, String) - Method in class dev.doglog.internal.log_thread.reporters.NetworkTablesReporter
- log(long, String, String) - Method in interface dev.doglog.internal.log_thread.reporters.Reporter
- log(long, String, String[]) - Method in class dev.doglog.internal.log_thread.reporters.CombinedReporter
- log(long, String, String[]) - Method in class dev.doglog.internal.log_thread.reporters.DataLogReporter
- log(long, String, String[]) - Method in class dev.doglog.internal.log_thread.reporters.NetworkTablesReporter
- log(long, String, String[]) - Method in interface dev.doglog.internal.log_thread.reporters.Reporter
- log(long, String, String, String) - Method in class dev.doglog.internal.log_thread.reporters.CombinedReporter
- log(long, String, String, String) - Method in class dev.doglog.internal.log_thread.reporters.DataLogReporter
- log(long, String, String, String) - Method in class dev.doglog.internal.log_thread.reporters.NetworkTablesReporter
- log(long, String, String, String) - Method in interface dev.doglog.internal.log_thread.reporters.Reporter
- log(long, String, T) - Method in class dev.doglog.internal.log_thread.reporters.CombinedReporter
- log(long, String, T[]) - Method in class dev.doglog.internal.log_thread.reporters.CombinedReporter
- 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, 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, 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, Enum<?>) - Static method in class dev.doglog.DogLog
-
Log an enum.
- log(String, Enum<?>[]) - Static method in class dev.doglog.DogLog
-
Log an enum 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.
- log(String, T) - Static method in class dev.doglog.DogLog
-
Log a struct.
- log(String, T[]) - Static method in class dev.doglog.DogLog
-
Log a struct array.
- logEntryQueueCapacity() - Method in record class dev.doglog.DogLogOptions
-
Returns the value of the
logEntryQueueCapacity
record component. - 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.AlertType) - Static method in class dev.doglog.DogLog
-
Log a fault and create an
Alert
for it at the specified level. - logger - Static variable in class dev.doglog.DogLog
- LogQueuer - Class in dev.doglog.internal
-
Provides an interface for queueing logs to be recorded by the log thread.
- LogQueuer(DogLogOptions) - Constructor for class dev.doglog.internal.LogQueuer
- LogThread - Class in dev.doglog.internal.log_thread
-
A thread that processes queued log entries and writes them to the log file.
- LogThread(BlockingQueue<BaseQueuedLogEntry>, DogLogOptions) - Constructor for class dev.doglog.internal.log_thread.LogThread
- LongOnChange - Record Class in dev.doglog.internal.tunable.on_change
- LongOnChange(LongConsumer, long) - Constructor for record class dev.doglog.internal.tunable.on_change.LongOnChange
-
Creates an instance of a
LongOnChange
record class. - LOOP_PERIOD_SECONDS - Static variable in record class dev.doglog.DogLogOptions
N
- NetworkTablesReporter - Class in dev.doglog.internal.log_thread.reporters
-
Logs to NetworkTables.
- NetworkTablesReporter(String) - Constructor for class dev.doglog.internal.log_thread.reporters.NetworkTablesReporter
- ntPublish() - Method in record class dev.doglog.DogLogOptions
-
Returns the value of the
ntPublish
record component. - ntTunables() - Method in record class dev.doglog.DogLogOptions
-
Returns the value of the
ntTunables
record component.
O
- onChange() - Method in record class dev.doglog.internal.tunable.on_change.BooleanOnChange
-
Returns the value of the
onChange
record component. - onChange() - Method in record class dev.doglog.internal.tunable.on_change.DoubleOnChange
-
Returns the value of the
onChange
record component. - onChange() - Method in record class dev.doglog.internal.tunable.on_change.FloatOnChange
-
Returns the value of the
onChange
record component. - onChange() - Method in record class dev.doglog.internal.tunable.on_change.LongOnChange
-
Returns the value of the
onChange
record component. - onChange() - Method in record class dev.doglog.internal.tunable.on_change.OnChange
-
Returns the value of the
onChange
record component. - OnChange<T> - Record Class in dev.doglog.internal.tunable.on_change
- OnChange(Consumer<T>, T) - Constructor for record class dev.doglog.internal.tunable.on_change.OnChange
-
Creates an instance of a
OnChange
record class. - options - Static variable in class dev.doglog.DogLog
-
The options to use for the logger.
Q
- queueLog(long, String, boolean) - Method in class dev.doglog.internal.LogQueuer
- queueLog(long, String, boolean[]) - Method in class dev.doglog.internal.LogQueuer
- queueLog(long, String, double) - Method in class dev.doglog.internal.LogQueuer
- queueLog(long, String, double[]) - Method in class dev.doglog.internal.LogQueuer
- queueLog(long, String, float) - Method in class dev.doglog.internal.LogQueuer
- queueLog(long, String, float[]) - Method in class dev.doglog.internal.LogQueuer
- queueLog(long, String, int[]) - Method in class dev.doglog.internal.LogQueuer
- queueLog(long, String, long) - Method in class dev.doglog.internal.LogQueuer
- queueLog(long, String, long[]) - Method in class dev.doglog.internal.LogQueuer
- queueLog(long, String, String) - Method in class dev.doglog.internal.LogQueuer
- queueLog(long, String, String[]) - Method in class dev.doglog.internal.LogQueuer
- queueLog(long, String, String, String) - Method in class dev.doglog.internal.LogQueuer
- queueLog(long, String, T) - Method in class dev.doglog.internal.LogQueuer
- queueLog(long, String, T[]) - Method in class dev.doglog.internal.LogQueuer
R
- RadioLogResult - Class in dev.doglog.internal.extras
- RadioLogResult() - Constructor for class dev.doglog.internal.extras.RadioLogResult
- readQueue() - Method in class dev.doglog.internal.tunable.entry.ToggleableBooleanSubscriber
- readQueue() - Method in class dev.doglog.internal.tunable.entry.ToggleableDoubleSubscriber
- readQueue() - Method in class dev.doglog.internal.tunable.entry.ToggleableFloatSubscriber
- readQueue() - Method in class dev.doglog.internal.tunable.entry.ToggleableIntegerSubscriber
- readQueue() - Method in class dev.doglog.internal.tunable.entry.ToggleableStringSubscriber
- readQueueValues() - Method in class dev.doglog.internal.tunable.entry.ToggleableBooleanSubscriber
- readQueueValues() - Method in class dev.doglog.internal.tunable.entry.ToggleableDoubleSubscriber
- readQueueValues() - Method in class dev.doglog.internal.tunable.entry.ToggleableFloatSubscriber
- readQueueValues() - Method in class dev.doglog.internal.tunable.entry.ToggleableIntegerSubscriber
- readQueueValues() - Method in class dev.doglog.internal.tunable.entry.ToggleableStringSubscriber
- Reporter - Interface in dev.doglog.internal.log_thread.reporters
- run() - Method in class dev.doglog.internal.log_thread.LogThread
- runsWhenDisabled() - Method in class dev.doglog.internal.TimedCommand
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.log_thread.LogThread
- setOptions(DogLogOptions) - Method in class dev.doglog.internal.log_thread.reporters.CombinedReporter
- setOptions(DogLogOptions) - Method in class dev.doglog.internal.log_thread.reporters.DataLogReporter
- setOptions(DogLogOptions) - Method in class dev.doglog.internal.LogQueuer
- setOptions(DogLogOptions) - Method in class dev.doglog.internal.tunable.Tunable
- 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
- setPdh(PowerDistribution) - Method in class dev.doglog.internal.LogQueuer
- statusJson - Variable in class dev.doglog.internal.extras.RadioLogResult
- STRING - Enum constant in enum class dev.doglog.internal.log_thread.entries.EntryType
- STRING_ARRAY - Enum constant in enum class dev.doglog.internal.log_thread.entries.EntryType
- STRING_CUSTOM_TYPE - Enum constant in enum class dev.doglog.internal.log_thread.entries.EntryType
- StringArrayQueuedLogEntry - Class in dev.doglog.internal.log_thread.entries
- StringArrayQueuedLogEntry(String, long, String[]) - Constructor for class dev.doglog.internal.log_thread.entries.StringArrayQueuedLogEntry
- StringCustomTypeQueuedLogEntry - Class in dev.doglog.internal.log_thread.entries
- StringCustomTypeQueuedLogEntry(String, long, String, String) - Constructor for class dev.doglog.internal.log_thread.entries.StringCustomTypeQueuedLogEntry
- StringQueuedLogEntry - Class in dev.doglog.internal.log_thread.entries
- StringQueuedLogEntry(String, long, String) - Constructor for class dev.doglog.internal.log_thread.entries.StringQueuedLogEntry
- STRUCT - Enum constant in enum class dev.doglog.internal.log_thread.entries.EntryType
- STRUCT_ARRAY - Enum constant in enum class dev.doglog.internal.log_thread.entries.EntryType
- StructArrayQueuedLogEntry<T extends edu.wpi.first.util.struct.StructSerializable> - Class in dev.doglog.internal.log_thread.entries
- StructArrayQueuedLogEntry(String, long, T[]) - Constructor for class dev.doglog.internal.log_thread.entries.StructArrayQueuedLogEntry
- StructQueuedLogEntry<T extends edu.wpi.first.util.struct.StructSerializable> - Class in dev.doglog.internal.log_thread.entries
- StructQueuedLogEntry(String, long, T) - Constructor for class dev.doglog.internal.log_thread.entries.StructQueuedLogEntry
- StructRegistry - Class in dev.doglog.internal.log_thread
-
Used internally for working with WPILib
Struct
s.
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
- time(String, Command) - Static method in class dev.doglog.DogLog
-
Wraps a
Command
with a timer that records how long the command runs. - TimedCommand - Class in dev.doglog.internal
- TimedCommand(Command, String) - Constructor for class dev.doglog.internal.TimedCommand
- 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 - Variable in class dev.doglog.internal.log_thread.entries.BaseQueuedLogEntry
- timestamp(String) - Static method in class dev.doglog.DogLog
-
Log the current FPGA timestamp.
- ToggleableBooleanSubscriber - Class in dev.doglog.internal.tunable.entry
- ToggleableBooleanSubscriber(BooleanSubscriber, boolean, BooleanSupplier) - Constructor for class dev.doglog.internal.tunable.entry.ToggleableBooleanSubscriber
- ToggleableDoubleSubscriber - Class in dev.doglog.internal.tunable.entry
- ToggleableDoubleSubscriber(DoubleSubscriber, double, BooleanSupplier) - Constructor for class dev.doglog.internal.tunable.entry.ToggleableDoubleSubscriber
- ToggleableFloatSubscriber - Class in dev.doglog.internal.tunable.entry
- ToggleableFloatSubscriber(FloatSubscriber, float, BooleanSupplier) - Constructor for class dev.doglog.internal.tunable.entry.ToggleableFloatSubscriber
- ToggleableIntegerSubscriber - Class in dev.doglog.internal.tunable.entry
- ToggleableIntegerSubscriber(IntegerSubscriber, long, BooleanSupplier) - Constructor for class dev.doglog.internal.tunable.entry.ToggleableIntegerSubscriber
- ToggleableStringSubscriber - Class in dev.doglog.internal.tunable.entry
- ToggleableStringSubscriber(StringSubscriber, String, BooleanSupplier) - Constructor for class dev.doglog.internal.tunable.entry.ToggleableStringSubscriber
- toString() - Method in record class dev.doglog.DogLogOptions
-
Returns a string representation of this record class.
- toString() - Method in record class dev.doglog.internal.tunable.on_change.BooleanOnChange
-
Returns a string representation of this record class.
- toString() - Method in record class dev.doglog.internal.tunable.on_change.DoubleOnChange
-
Returns a string representation of this record class.
- toString() - Method in record class dev.doglog.internal.tunable.on_change.FloatOnChange
-
Returns a string representation of this record class.
- toString() - Method in record class dev.doglog.internal.tunable.on_change.LongOnChange
-
Returns a string representation of this record class.
- toString() - Method in record class dev.doglog.internal.tunable.on_change.OnChange
-
Returns a string representation of this record class.
- tunable - Static variable in class dev.doglog.DogLog
- 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, DoubleConsumer) - Static method in class dev.doglog.DogLog
-
Create a tunable double.
- tunable(String, float) - Static method in class dev.doglog.DogLog
-
Create a tunable float.
- 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, LongConsumer) - Static method in class dev.doglog.DogLog
-
Create a tunable integer.
- tunable(String, String) - Static method in class dev.doglog.DogLog
-
Create a tunable string.
- tunable(String, String, Consumer<String>) - Static method in class dev.doglog.DogLog
-
Create a tunable string.
- Tunable - Class in dev.doglog.internal.tunable
- Tunable(DogLogOptions) - Constructor for class dev.doglog.internal.tunable.Tunable
- type - Variable in class dev.doglog.internal.log_thread.entries.BaseQueuedLogEntry
V
- value - Variable in class dev.doglog.internal.log_thread.entries.BooleanArrayQueuedLogEntry
- value - Variable in class dev.doglog.internal.log_thread.entries.BooleanQueuedLogEntry
- value - Variable in class dev.doglog.internal.log_thread.entries.DoubleArrayQueuedLogEntry
- value - Variable in class dev.doglog.internal.log_thread.entries.DoubleQueuedLogEntry
- value - Variable in class dev.doglog.internal.log_thread.entries.FloatArrayQueuedLogEntry
- value - Variable in class dev.doglog.internal.log_thread.entries.FloatQueuedLogEntry
- value - Variable in class dev.doglog.internal.log_thread.entries.IntegerArrayQueuedLogEntry
- value - Variable in class dev.doglog.internal.log_thread.entries.IntegerQueuedLogEntry
- value - Variable in class dev.doglog.internal.log_thread.entries.StringArrayQueuedLogEntry
- value - Variable in class dev.doglog.internal.log_thread.entries.StringCustomTypeQueuedLogEntry
- value - Variable in class dev.doglog.internal.log_thread.entries.StringQueuedLogEntry
- value - Variable in class dev.doglog.internal.log_thread.entries.StructArrayQueuedLogEntry
- value - Variable in class dev.doglog.internal.log_thread.entries.StructQueuedLogEntry
- valueOf(String) - Static method in enum class dev.doglog.internal.log_thread.entries.EntryType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class dev.doglog.internal.log_thread.entries.EntryType
-
Returns an array containing the constants of this enum class, in the order they are declared.
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. - withCaptureNt(boolean) - Method in record class dev.doglog.DogLogOptions
-
Create a new options object, inheriting the configuration from this one, with
DogLogOptions.captureNt
set to the provided value. - withLogEntryQueueCapacity(int) - Method in record class dev.doglog.DogLogOptions
-
Create a new options object, inheriting the configuration from this one, with
DogLogOptions.logEntryQueueCapacity
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. - withNtPublish(boolean) - Method in record class dev.doglog.DogLogOptions
-
Create a new options object, inheriting the configuration from this one, with
DogLogOptions.ntPublish
set to the provided value. - withNtPublish(BooleanSupplier) - Method in record class dev.doglog.DogLogOptions
-
Create a new options object, inheriting the configuration from this one, with
DogLogOptions.ntPublish
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.
All Classes and Interfaces|All Packages|Constant Field Values