Interface BoardTroubleIface

All Superinterfaces:
TroubleIface

public interface BoardTroubleIface extends TroubleIface
Interface for Troubles that implements the board iface. This is a standard way to describe to external systems that the Trouble includes board information in a standard format.

Implementations must call BoardTroubleIface.addIface(trouble) to ensure that external systems know the Trouble implements this interface.

This indicates the board interface is implemented and the following data is available:

  • boardPath : Path to the associated board
Since:
1.0
Version:
2023-09-12
  • Method Summary

    Modifier and Type
    Method
    Description
    static void
    addIface(Trouble trouble)
    Adds the iface to the specified Trouble .
    Returns the board path.
  • Method Details

    • addIface

      static void addIface(Trouble trouble)
      Adds the iface to the specified Trouble . Should be called in the Trouble constructor.
      Parameters:
      trouble - the Trouble to add the iface to
    • getBoardPath

      String getBoardPath()
      Returns the board path.