Package org.wildstang.framework.subsystems

Interface Subsystem

All Superinterfaces:
InputListener
All Known Implementing Classes:
PathFollowingDrive, SwerveDriveTemplate
public interface Subsystem extends InputListener
Interface describing a subsystem class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getName()
    Returns the name of the subsystem.
    void
    init()
    Initialise the subsystem.
    void
    initSubsystems()
    Initialize references to other subsystems here Called after all subsystems are initialized
    void
    resetState()
    Can be called to reset any state variables.
    void
    selfTest()
    Performs a self test of the subsystem.
    void
    update()
    Called to cause the subsystem to update its state and set new values on outputs.

    Methods inherited from interface org.wildstang.framework.io.InputListener

    inputUpdate

  • Method Details

    • init

      void init()
      Initialise the subsystem. Performs any required setup work.

    • selfTest

      void selfTest()
      Performs a self test of the subsystem.

    • update

      void update()
      Called to cause the subsystem to update its state and set new values on outputs. Sending values to the hardware outputs is done outside of this method by the framework.

    • resetState

      void resetState()
      Can be called to reset any state variables. Can be used when changing modes or reenabling system to reset to a default state without reinitialising connected components.

    • initSubsystems

      void initSubsystems()
      Initialize references to other subsystems here Called after all subsystems are initialized

    • getName

      String getName()
      Returns the name of the subsystem.
      Returns:
      the name of the subsystem