Package com.reduxrobotics.sensors.canandcolor.digout

Record Class DigoutMode.DigoutSlot

java.lang.Object
java.lang.Record
com.reduxrobotics.sensors.canandcolor.digout.DigoutMode.DigoutSlot
Record Components:
normallyClosed - true if normally closed (output high on false) false if normally open (output high on true, the default)
All Implemented Interfaces:
DigoutMode
Enclosing interface:
DigoutMode
public static record DigoutMode.DigoutSlot(boolean normallyClosed) extends Record implements DigoutMode
A config that sets the digital output to use digout slot logic. 
 // Example usage:
 Canandcolor canandcolor = new Canandcolor(0);
 // ...
 // enable digital output on digout1
 Canandcolor.Settings stg = new Canandcolor.Settings(); 
 stg.setDigoutOutputMode(Canandcolor.Digout.kDigout1, new DigoutMode.DigoutSlot(false));
 canandcolor.setSettings(stg);
See Also:

  • Constructor Details

    • DigoutSlot

      public DigoutSlot()
      Constructor assuming normally open (the generally most useful behavior)

    • DigoutSlot

      public DigoutSlot(boolean normallyClosed)
      Creates an instance of a DigoutSlot record class.
      Parameters:
      normallyClosed - the value for the normallyClosed record component

  • Method Details

    • toSettingData

      public long toSettingData()
      Description copied from interface: DigoutMode
      Serializes the digout config into a value writeable to device settings.
      Specified by:
      toSettingData in interface DigoutMode
      Returns:
      48-bit long

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • normallyClosed

      public boolean normallyClosed()
      Returns the value of the normallyClosed record component.
      Returns:
      the value of the normallyClosed record component