Package clickDetector.ClickClassifiers

Interface ClickTypeProvider

All Known Subinterfaces:
ClickIdentifier
All Known Implementing Classes:
BasicClickIdentifier, ClickTypeMasterManager, MTClassifierControl, NullClassifier, SweepClassifier
public interface ClickTypeProvider
An object which provides info on and can change click types. This provides the possible click types which is used by data map etc to figure out what click types might be available. The class which implements this will be responsible for changing the click type flag in a ClickDetection.

Any process which changes clikc types should implement this.

Any child of the click control which changes click types should implments ClickTypeProvider.

Author:
Jamie Macaulay

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    codeToListIndex(int code)
    Returns the index in the list for the click type.
    int[]
    getCodeList()
    Returns a list of the currently-defined click types / species codes.
    String[]
    getSpeciesList()
    Get a list of species names.
    SymbolData[]
    getSymbolsData()
    Get a list of symbols for each species corresponding to getSpeciesList.

  • Method Details

    • getSpeciesList

      String[] getSpeciesList()
      Get a list of species names.
      Returns:
      list speces names.

    • getSymbolsData

      SymbolData[] getSymbolsData()
      Get a list of symbols for each species corresponding to getSpeciesList.
      Returns:
      list of species symbols.

    • getCodeList

      int[] getCodeList()
      Returns a list of the currently-defined click types / species codes.
      Returns:
      int array with the codes

    • codeToListIndex

      int codeToListIndex(int code)
      Returns the index in the list for the click type.
      Parameters:
      code - - the click type code
      Returns:
      the index.