Record Class DogLogOptions

java.lang.Object
java.lang.Record
dev.doglog.DogLogOptions
public record DogLogOptions(BooleanSupplier ntPublish, boolean captureNt, boolean captureDs, boolean logExtras, boolean captureConsole, int logEntryQueueCapacity, BooleanSupplier ntTunables, boolean useLogThread) extends Record
Options for configuring DogLog.

See https://doglog.dev/reference/logger-options/ for more information.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final double
    LOOP_PERIOD_SECONDS
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    DogLogOptions()
    Create a new options object using the default options.
    DogLogOptions(BooleanSupplier ntPublish, boolean captureNt, boolean captureDs, boolean logExtras, boolean captureConsole, int logEntryQueueCapacity, BooleanSupplier ntTunables, boolean useLogThread)
    Creates an instance of a DogLogOptions record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    captureConsole()
    Returns the value of the captureConsole record component.
    boolean
    captureDs()
    Returns the value of the captureDs record component.
    boolean
    captureNt()
    Returns the value of the captureNt record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    logEntryQueueCapacity()
    Returns the value of the logEntryQueueCapacity record component.
    boolean
    logExtras()
    Returns the value of the logExtras record component.
    BooleanSupplier
    ntPublish()
    Returns the value of the ntPublish record component.
    BooleanSupplier
    ntTunables()
    Returns the value of the ntTunables record component.
    final String
    toString()
    Returns a string representation of this record class.
    boolean
    useLogThread()
    Returns the value of the useLogThread record component.
    DogLogOptions
    withCaptureConsole(boolean captureConsole)
    Create a new options object, inheriting the configuration from this one, with captureConsole set to the provided value.
    DogLogOptions
    withCaptureDs(boolean captureDs)
    Create a new options object, inheriting the configuration from this one, with captureDs set to the provided value.
    DogLogOptions
    withCaptureNt(boolean captureNt)
    Create a new options object, inheriting the configuration from this one, with captureNt set to the provided value.
    DogLogOptions
    withLogEntryQueueCapacity(int logEntryQueueCapacity)
    Create a new options object, inheriting the configuration from this one, with logEntryQueueCapacity set to the provided value.
    DogLogOptions
    withLogExtras(boolean logExtras)
    Create a new options object, inheriting the configuration from this one, with logExtras set to the provided value.
    DogLogOptions
    withNtPublish(boolean ntPublish)
    Create a new options object, inheriting the configuration from this one, with ntPublish set to the provided value.
    DogLogOptions
    withNtPublish(BooleanSupplier ntPublish)
    Create a new options object, inheriting the configuration from this one, with ntPublish set to the provided value.
    DogLogOptions
    withNtTunables(boolean ntTunables)
    Create a new options object, inheriting the configuration from this one, with ntTunables set to the provided value.
    DogLogOptions
    withNtTunables(BooleanSupplier ntTunables)
    Create a new options object, inheriting the configuration from this one, with ntTunables set to the provided value.
    DogLogOptions
    withUseLogThread(boolean useLogThread)
    Create a new options object, inheriting the configuration from this one, with useLogThread set to the provided value.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

  • Constructor Details

    • DogLogOptions

      public DogLogOptions()
      Create a new options object using the default options. The default options are safe for a competition environment, but you may want to tweak them to improve your development experience at home.

      See https://doglog.dev/getting-started/usage/#configuring For instructions on how to customize these options.

    • DogLogOptions

      public DogLogOptions(BooleanSupplier ntPublish, boolean captureNt, boolean captureDs, boolean logExtras, boolean captureConsole, int logEntryQueueCapacity, BooleanSupplier ntTunables, boolean useLogThread)
      Creates an instance of a DogLogOptions record class.
      Parameters:
      ntPublish - the value for the ntPublish record component
      captureNt - the value for the captureNt record component
      captureDs - the value for the captureDs record component
      logExtras - the value for the logExtras record component
      captureConsole - the value for the captureConsole record component
      logEntryQueueCapacity - the value for the logEntryQueueCapacity record component
      ntTunables - the value for the ntTunables record component
      useLogThread - the value for the useLogThread record component

  • Method Details

    • withNtPublish

      public DogLogOptions withNtPublish(boolean ntPublish)
      Create a new options object, inheriting the configuration from this one, with ntPublish set to the provided value.

      Example: 

      DogLog.setOptions(new DogLogOptions().withNtPublish(true));
      Parameters:
      ntPublish - Whether logged values should be published to NetworkTables.
      Returns:
      A new options object with ntPublish set to the provided value.

    • withNtPublish

      public DogLogOptions withNtPublish(BooleanSupplier ntPublish)
      Create a new options object, inheriting the configuration from this one, with ntPublish set to the provided value.

      Example: 

      DogLog.setOptions(new DogLogOptions().withNtPublish(() -> true));
      Parameters:
      ntPublish - A function that returns whether logged values should be published to NetworkTables.
      Returns:
      A new options object with ntPublish set to the provided value.

    • withCaptureNt

      public DogLogOptions withCaptureNt(boolean captureNt)
      Create a new options object, inheriting the configuration from this one, with captureNt set to the provided value.

      Example: 

      DogLog.setOptions(new DogLogOptions().withCaptureNt(true));
      Parameters:
      captureNt - Whether all NetworkTables fields should be saved to the log file.
      Returns:
      A new options object with captureNt set to the provided value.

    • withCaptureDs

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

      Example: 

      DogLog.setOptions(new DogLogOptions().withCaptureDs(true));
      Parameters:
      captureDs - Whether driver station data (robot enable state and joystick inputs) should be
      Returns:
      A new options object with captureDs set to the provided value.

    • withLogExtras

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

      Example: 

      DogLog.setOptions(new DogLogOptions().withLogExtras(false));
      Parameters:
      logExtras - Whether to log extra data, like PDH currents, CAN usage, radio connection status, etc.
      Returns:
      A new options object with logExtras set to the provided value.

    • withLogEntryQueueCapacity

      public DogLogOptions withLogEntryQueueCapacity(int logEntryQueueCapacity)
      Create a new options object, inheriting the configuration from this one, with logEntryQueueCapacity set to the provided value.

      Example: 

      DogLog.setOptions(new DogLogOptions().withLogEntryQueueCapacity(1000));
      Parameters:
      logEntryQueueCapacity - The size of the log message queue to use.
      Returns:
      A new options object with logEntryQueueCapacity set to the provided value.

    • withCaptureConsole

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

      Example: 

      DogLog.setOptions(new DogLogOptions().withCaptureConsole(false));
      Parameters:
      captureConsole - Whether console output should be saved to the log file.
      Returns:
      A new options object with captureConsole set to the provided value.

    • withNtTunables

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

      Example: 

      DogLog.setOptions(new DogLogOptions().withUseTunableValues(true));
      Parameters:
      ntTunables - Whether tunable values should be read from NetworkTables.
      Returns:
      A new options object with ntTunables set to the provided value.

    • withNtTunables

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

      Example: 

      DogLog.setOptions(new DogLogOptions().withUseTunableValues(() -> true));
      Parameters:
      ntTunables - A function that returns whether tunable values should be read from NetworkTables.
      Returns:
      A new options object with ntTunables set to the provided value.

    • withUseLogThread

      public DogLogOptions withUseLogThread(boolean useLogThread)
      Create a new options object, inheriting the configuration from this one, with useLogThread set to the provided value.
      Parameters:
      useLogThread - Whether to use a separate thread to handle log entries.
      Returns:
      A new options object with useLogThread set to the provided value.

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • ntPublish

      public BooleanSupplier ntPublish()
      Returns the value of the ntPublish record component.
      Returns:
      the value of the ntPublish record component

    • captureNt

      public boolean captureNt()
      Returns the value of the captureNt record component.
      Returns:
      the value of the captureNt record component

    • captureDs

      public boolean captureDs()
      Returns the value of the captureDs record component.
      Returns:
      the value of the captureDs record component

    • logExtras

      public boolean logExtras()
      Returns the value of the logExtras record component.
      Returns:
      the value of the logExtras record component

    • captureConsole

      public boolean captureConsole()
      Returns the value of the captureConsole record component.
      Returns:
      the value of the captureConsole record component

    • logEntryQueueCapacity

      public int logEntryQueueCapacity()
      Returns the value of the logEntryQueueCapacity record component.
      Returns:
      the value of the logEntryQueueCapacity record component

    • ntTunables

      public BooleanSupplier ntTunables()
      Returns the value of the ntTunables record component.
      Returns:
      the value of the ntTunables record component

    • useLogThread

      public boolean useLogThread()
      Returns the value of the useLogThread record component.
      Returns:
      the value of the useLogThread record component