Package edu.wpi.first.wpilibj.simulation

Class CallbackStore

java.lang.Object
edu.wpi.first.wpilibj.simulation.CallbackStore
All Implemented Interfaces:
AutoCloseable
public class CallbackStore extends Object implements AutoCloseable
Manages simulation callbacks; each object is associated with a callback.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    CallbackStore()
    Constructs an empty CallbackStore.
     
    CallbackStore(int index, int channel, int uid, edu.wpi.first.wpilibj.simulation.CallbackStore.CancelCallbackChannelFunc ccf)
    Note: This constructor is for simulation classes only.
     
    CallbackStore(int index, int uid, edu.wpi.first.wpilibj.simulation.CallbackStore.CancelCallbackFunc ccf)
    Note: This constructor is for simulation classes only.
     
    CallbackStore(int uid, edu.wpi.first.wpilibj.simulation.CallbackStore.CancelCallbackNoIndexFunc ccf)
    Note: This constructor is for simulation classes only.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
    Cancel the callback associated with this object.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • CallbackStore

      protected CallbackStore()
      Constructs an empty CallbackStore. This constructor is to allow 3rd party sim providers (eg vendors) to subclass this class (without needing provide dummy constructing parameters) so that the register methods of their sim classes can return CallbackStores like the builtin sims. Note: It should not be called by teams that are just using sims!

    • CallbackStore

      public CallbackStore(int index, int uid, edu.wpi.first.wpilibj.simulation.CallbackStore.CancelCallbackFunc ccf)
      Note: This constructor is for simulation classes only. It should not be called by teams!
      Parameters:
      index - TODO
      uid - TODO
      ccf - TODO

    • CallbackStore

      public CallbackStore(int index, int channel, int uid, edu.wpi.first.wpilibj.simulation.CallbackStore.CancelCallbackChannelFunc ccf)
      Note: This constructor is for simulation classes only. It should not be called by teams!
      Parameters:
      index - TODO
      channel - TODO
      uid - TODO
      ccf - TODO

    • CallbackStore

      public CallbackStore(int uid, edu.wpi.first.wpilibj.simulation.CallbackStore.CancelCallbackNoIndexFunc ccf)
      Note: This constructor is for simulation classes only. It should not be called by teams!
      Parameters:
      uid - TODO
      ccf - TODO

  • Method Details

    • close

      public void close()
      Cancel the callback associated with this object.
      Specified by:
      close in interface AutoCloseable