Record Class DigoutMode.DutyCycle
java.lang.Object
java.lang.Record
com.reduxrobotics.sensors.canandcolor.digout.DigoutMode.DutyCycle
- Record Components:
dataSource
- the data source to output on the digital output pad
- All Implemented Interfaces:
DigoutMode
- Enclosing interface:
- DigoutMode
public static record DigoutMode.DutyCycle(Canandcolor.DataSource dataSource)
extends Record
implements DigoutMode
A config that sets the digital output to output a duty cycle or PWM signal.
// Example usage: // object declaration Canandcolor canandcolor = new Canandcolor(0); // ... // enable duty cycle output on digout1 of the red reading, and digout2 of the blue reading Canandcolor.Settings stg = new Canandcolor.Settings(); stg.setDigoutOutputMode(Canandcolor.Digout.kDigout1, new DigoutMode.DutyCycle(Canandcolor.DataSource.kRed)); stg.setDigoutOutputMode(Canandcolor.Digout.kDigout2, new DigoutMode.DutyCycle(Canandcolor.DataSource.kBlue)); 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
ConstructorDescriptionDutyCycle
(Canandcolor.DataSource dataSource) Creates an instance of aDutyCycle
record class. -
Method Summary
Modifier and TypeMethodDescriptionReturns the value of thedataSource
record component.final boolean
Indicates whether some other object is "equal to" this one.final int
hashCode()
Returns a hash code value for this object.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
-
DutyCycle
Creates an instance of aDutyCycle
record class.- Parameters:
dataSource
- the value for thedataSource
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 withObjects::equals(Object,Object)
. -
dataSource
Returns the value of thedataSource
record component.- Returns:
- the value of the
dataSource
record component
-