Package org.cha0scollective.wwpg.api

Record Class ElectricalModel.Resistor

java.lang.Object

java.lang.Record

org.cha0scollective.wwpg.api.ElectricalModel.Resistor

All Implemented Interfaces:

ElectricalModel

Enclosing interface:

ElectricalModel

public static record ElectricalModel.Resistor(double resistanceOhms)
extends Record
implements ElectricalModel

Passive resistor with strictly positive resistance in ohms.

Nested Class Summary

Nested classes/interfaces inherited from interface org.cha0scollective.wwpg.api.ElectricalModel

ElectricalModel.AcVoltageSource, ElectricalModel.Capacitor, ElectricalModel.ControlledCurrentSource, ElectricalModel.ControlledVoltageSource, ElectricalModel.CurrentSource, ElectricalModel.Diode, ElectricalModel.Inductor, ElectricalModel.Resistor, ElectricalModel.Switch, ElectricalModel.Transformer, ElectricalModel.VoltageSource

Constructor Summary

Constructors

Constructor	Description
Resistor(double resistanceOhms)	Creates an instance of a Resistor record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
double	resistanceOhms()	Returns the value of the resistanceOhms record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Resistor

public Resistor(double resistanceOhms)

Creates an instance of a Resistor record class.

Parameters:

resistanceOhms - the value for the resistanceOhms record component

Method Details

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.

resistanceOhms

public double resistanceOhms()

Returns the value of the resistanceOhms record component.

Returns:

the value of the resistanceOhms record component