Package edu.ie3.datamodel.models.input.container

Record Class ThermalGrid

java.lang.Object

java.lang.Record

edu.ie3.datamodel.models.input.container.ThermalGrid

All Implemented Interfaces:

InputContainer<ThermalInput>, Serializable

public record ThermalGrid(ThermalBusInput bus, Set<ThermalHouseInput> houses, Set<ThermalStorageInput> storages)
extends Record
implements InputContainer<ThermalInput>

Container object to denote a fully connected thermal "grid". As there are currently no branch elements, a grid always only consists of one ThermalBusInput and all its connected ThermalUnitInputs

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ThermalGrid(ThermalBusInput bus, Collection<ThermalHouseInput> houses, Collection<ThermalStorageInput> storages)
ThermalGrid(ThermalBusInput bus, Set<ThermalHouseInput> houses, Set<ThermalStorageInput> storages)	Creates an instance of a ThermalGrid record class.

Method Summary

Modifier and Type	Method	Description
List<ThermalInput>	allEntitiesAsList()
ThermalBusInput	bus()	Returns the value of the bus record component.
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.
Set<ThermalHouseInput>	houses()	Returns the value of the houses record component.
Set<ThermalStorageInput>	storages()	Returns the value of the storages record component.
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

ThermalGrid

public ThermalGrid(ThermalBusInput bus,
 Collection<ThermalHouseInput> houses,
 Collection<ThermalStorageInput> storages)

ThermalGrid

public ThermalGrid(ThermalBusInput bus,
 Set<ThermalHouseInput> houses,
 Set<ThermalStorageInput> storages)

Creates an instance of a ThermalGrid record class.

Parameters:

bus - the value for the bus record component

houses - the value for the houses record component

storages - the value for the storages record component

Method Details

allEntitiesAsList

public List<ThermalInput> allEntitiesAsList()

Specified by:

allEntitiesAsList in interface InputContainer<ThermalInput>

Returns:

unmodifiable List of all entities

toString

public 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 Objects::equals(Object,Object).

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.

bus

public ThermalBusInput bus()

Returns the value of the bus record component.

Returns:

the value of the bus record component

houses

public Set<ThermalHouseInput> houses()

Returns the value of the houses record component.

Returns:

the value of the houses record component

storages

public Set<ThermalStorageInput> storages()

Returns the value of the storages record component.

Returns:

the value of the storages record component