Interface IntrinsicLoggable

All Known Implementing Classes:
BaseHardwareLogger, HighLevelLogger, PID

public interface IntrinsicLoggable
Interface for classes which can auto-generate Loggers for internal fields.
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    autoGenerateLogs(edu.wpi.first.util.datalog.DataLog log, String name, String subdirName, boolean publishToNT, boolean recordInLog)
    Auto-generates Loggers for important internal values.
    default void
    autoGenerateLogs(String name, String subdirName)
    Auto-generates Loggers for important and notable internal values, using the default DataLog, and both publishing to NT and logging on-robot.
    void
    Updates the internally generated Loggers.
  • Method Details

    • autoGenerateLogs

      void autoGenerateLogs(edu.wpi.first.util.datalog.DataLog log, String name, String subdirName, boolean publishToNT, boolean recordInLog)
      Auto-generates Loggers for important internal values.
      Parameters:
      log - The DataLog to log values inside of, most likely from HighLevelLogger.getLog() or whatever log is being used program-wide.
      name - The name to associate with this object's logged data.
      subdirName - The string name of the existing or new NetworkTables sub-table to write to.
      publishToNT - Whether this should push logged values to NetworkTables.
      recordInLog - Whether this should store logged values in an on-robot log file.
    • autoGenerateLogs

      default void autoGenerateLogs(String name, String subdirName)
      Auto-generates Loggers for important and notable internal values, using the default DataLog, and both publishing to NT and logging on-robot.
      Parameters:
      name - The name to associate with this object's logged data.
      subdirName - The string name of the existing or new NetworkTables sub-table to write to.
    • updateLogs

      void updateLogs()
      Updates the internally generated Loggers.