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);
-
Nested Class Summary
Nested classes/interfaces inherited from interface com.reduxrobotics.sensors.canandcolor.digout.DigoutMode
DigoutMode.DigoutSlot, DigoutMode.Disabled, DigoutMode.DutyCycle
-
Constructor Summary
ConstructorDescriptionConstructor assuming normally open (the generally most useful behavior)DigoutSlot
(boolean normallyClosed) Creates an instance of aDigoutSlot
record class. -
Method Summary
Modifier and TypeMethodDescriptionfinal boolean
Indicates whether some other object is "equal to" this one.final int
hashCode()
Returns a hash code value for this object.boolean
Returns the value of thenormallyClosed
record component.long
Serializes the digout config into a value writeable to device settings.final String
toString()
Returns a string representation of this record class.
-
Constructor Details
-
DigoutSlot
public DigoutSlot()Constructor assuming normally open (the generally most useful behavior) -
DigoutSlot
public DigoutSlot(boolean normallyClosed) Creates an instance of aDigoutSlot
record class.- Parameters:
normallyClosed
- the value for thenormallyClosed
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 interfaceDigoutMode
- Returns:
- 48-bit long
-
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. -
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. -
equals
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 '=='. -
normallyClosed
public boolean normallyClosed()Returns the value of thenormallyClosed
record component.- Returns:
- the value of the
normallyClosed
record component
-