Record Class CANLightControllerInfo
java.lang.Object
java.lang.Record
xbot.common.injection.electrical_contract.CANLightControllerInfo
- Record Components:
name- device nametype- light-controller typecanBusId- CAN bus identitydeviceId- CAN device numberoutputConfig- output configuration, retained by referencepowerFrom- power-source metadata
public record CANLightControllerInfo(String name, LightControllerType type, CANBusId canBusId, int deviceId, CANLightControllerOutputConfig outputConfig, PowerSource powerFrom)
extends Record
Light-controller configuration. Construction does not validate or reserve hardware.
CANLightControllerInfo lights = CANLightControllerInfo.builder("Lights").withCanBus(CANPort.CAN_S0, 60).withPowerFrom(PowerSource.PDH01).build();
-
Nested Class Summary
Nested Classes -
Constructor Summary
ConstructorsConstructorDescriptionCANLightControllerInfo(String name, LightControllerType type, CANBusId canBusId, int deviceId, CANLightControllerOutputConfig outputConfig, PowerSource powerFrom) Creates an instance of aCANLightControllerInforecord class. -
Method Summary
Modifier and TypeMethodDescriptionStarts a CANdle builder on CAN_S0 with the existing default light configuration and no power-source metadata.canBusId()Returns the value of thecanBusIdrecord component.intdeviceId()Returns the value of thedeviceIdrecord component.final booleanIndicates whether some other object is "equal to" this one.final inthashCode()Returns a hash code value for this object.name()Returns the value of thenamerecord component.Returns the value of theoutputConfigrecord component.Returns the value of thepowerFromrecord component.final StringtoString()Returns a string representation of this record class.type()Returns the value of thetyperecord component.
-
Constructor Details
-
CANLightControllerInfo
public CANLightControllerInfo(String name, LightControllerType type, CANBusId canBusId, int deviceId, CANLightControllerOutputConfig outputConfig, PowerSource powerFrom) Creates an instance of aCANLightControllerInforecord class.- Parameters:
name- the value for thenamerecord componenttype- the value for thetyperecord componentcanBusId- the value for thecanBusIdrecord componentdeviceId- the value for thedeviceIdrecord componentoutputConfig- the value for theoutputConfigrecord componentpowerFrom- the value for thepowerFromrecord component
-
-
Method Details
-
builder
Starts a CANdle builder on CAN_S0 with the existing default light configuration and no power-source metadata. Set the CAN address withCANLightControllerInfo.Builder.withCanBus(CANPort, int); an unspecified device ID is -1. -
toString
-
hashCode
-
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. Reference components are compared withObjects::equals(Object,Object); primitive components are compared with thecomparemethod from their corresponding wrapper classes. -
name
-
type
-
canBusId
-
deviceId
-
outputConfig
Returns the value of theoutputConfigrecord component.- Returns:
- the value of the
outputConfigrecord component
-
powerFrom
-