From f3c906b7eced5b2ab09bed6789938e829ff8af2d Mon Sep 17 00:00:00 2001 From: danielfeismann Date: Mon, 4 Aug 2025 16:30:24 +0200 Subject: [PATCH 1/2] Change spotless to use googleJavaFormat('1.28.0') --- CHANGELOG.md | 1 + gradle/scripts/spotless.gradle | 2 +- .../exceptions/FailedValidationException.java | 4 +- .../edu/ie3/datamodel/graph/SubGridGate.java | 15 +-- .../edu/ie3/datamodel/io/DbGridMetadata.java | 4 +- .../java/edu/ie3/datamodel/io/SqlUtils.java | 4 +- .../io/connectors/CouchbaseConnector.java | 4 +- .../timeseries/BdewLoadProfileFactory.java | 6 +- .../timeseries/IdCoordinateFactory.java | 12 +- .../EntityPersistenceNamingStrategy.java | 1 + .../ie3/datamodel/io/processor/Processor.java | 118 +++++++++--------- .../ie3/datamodel/io/sink/InfluxDbSink.java | 2 + .../edu/ie3/datamodel/io/sink/SqlSink.java | 4 +- .../ie3/datamodel/io/source/EntitySource.java | 4 +- .../couchbase/CouchbaseWeatherSource.java | 1 + .../io/source/sql/SqlTimeSeriesSource.java | 1 + .../ie3/datamodel/models/OperationTime.java | 18 ++- .../ie3/datamodel/models/StandardUnits.java | 51 ++++++++ .../datamodel/models/input/AssetInput.java | 2 + .../ie3/datamodel/models/input/NodeInput.java | 3 + .../input/connector/ConnectorInput.java | 2 + .../models/input/connector/LineInput.java | 3 + .../input/connector/Transformer3WInput.java | 18 ++- .../input/connector/TransformerInput.java | 1 + .../input/connector/type/LineTypeInput.java | 5 + .../type/Transformer2WTypeInput.java | 12 ++ .../type/Transformer3WTypeInput.java | 18 +++ .../input/container/GraphicElements.java | 8 +- .../models/input/container/GridContainer.java | 3 + .../input/container/InputContainer.java | 4 +- .../input/container/RawGridElements.java | 29 ++++- .../input/container/SubGridContainer.java | 1 + .../input/container/SystemParticipants.java | 40 ++++-- .../models/input/graphics/GraphicInput.java | 1 + .../input/graphics/NodeGraphicInput.java | 1 + .../models/input/system/BmInput.java | 3 + .../models/input/system/ChpInput.java | 3 + .../models/input/system/EvcsInput.java | 1 + .../models/input/system/FixedFeedInInput.java | 1 + .../models/input/system/HpInput.java | 1 + .../models/input/system/LoadInput.java | 3 + .../models/input/system/PvInput.java | 8 ++ .../input/system/SystemParticipantInput.java | 4 +- .../models/input/system/WecInput.java | 1 + .../characteristic/CharacteristicPoint.java | 8 +- .../models/input/system/type/BmTypeInput.java | 1 + .../input/system/type/ChpTypeInput.java | 3 + .../models/input/system/type/EvTypeInput.java | 2 + .../input/system/type/StorageTypeInput.java | 3 + .../type/SystemParticipantTypeInput.java | 3 + .../input/system/type/WecTypeInput.java | 3 + .../input/thermal/AbstractStorageInput.java | 4 + .../input/thermal/ThermalHouseInput.java | 6 + .../datamodel/models/profile/LoadProfile.java | 4 +- .../models/result/CongestionResult.java | 4 +- .../datamodel/models/result/ResultEntity.java | 1 + .../models/value/EnergyPriceValue.java | 4 +- .../ie3/datamodel/models/value/PValue.java | 4 +- .../models/value/SolarIrradianceValue.java | 1 + .../models/value/TemperatureValue.java | 4 +- .../datamodel/models/value/VoltageValue.java | 1 + .../datamodel/models/value/WeatherValue.java | 2 + .../ie3/datamodel/models/value/WindValue.java | 1 + .../models/value/load/BdewLoadValues.java | 31 ++--- .../validation/ThermalValidationUtils.java | 1 + .../utils/validation/ValidationUtils.java | 1 + 66 files changed, 393 insertions(+), 127 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index cce4d596b..5741cfa52 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Fixed ### Changed +- Change spotless to use googleJavaFormat('1.28.0') [#1408](https://github.com/ie3-institute/PowerSystemDataModel/issues/1408) ## [8.1.0] - 2025-07-25 diff --git a/gradle/scripts/spotless.gradle b/gradle/scripts/spotless.gradle index e0871f80b..e5ef0bd0b 100644 --- a/gradle/scripts/spotless.gradle +++ b/gradle/scripts/spotless.gradle @@ -10,7 +10,7 @@ spotless { //sets a license header, removes unused imports and formats conforming to the google java format java { removeUnusedImports() // removes any unused imports - googleJavaFormat('1.13.0') + googleJavaFormat('1.28.0') licenseHeader ie3LicHead } diff --git a/src/main/java/edu/ie3/datamodel/exceptions/FailedValidationException.java b/src/main/java/edu/ie3/datamodel/exceptions/FailedValidationException.java index 25e1aa4de..19a64162e 100644 --- a/src/main/java/edu/ie3/datamodel/exceptions/FailedValidationException.java +++ b/src/main/java/edu/ie3/datamodel/exceptions/FailedValidationException.java @@ -21,7 +21,9 @@ public FailedValidationException(String message) { super(message); } - /** @param exceptions List of exceptions, which must not be empty */ + /** + * @param exceptions List of exceptions, which must not be empty + */ public FailedValidationException(List exceptions) { super("Validation failed due to:\n " + ExceptionUtils.combineExceptions(exceptions)); } diff --git a/src/main/java/edu/ie3/datamodel/graph/SubGridGate.java b/src/main/java/edu/ie3/datamodel/graph/SubGridGate.java index 53b22a205..814a7aa80 100644 --- a/src/main/java/edu/ie3/datamodel/graph/SubGridGate.java +++ b/src/main/java/edu/ie3/datamodel/graph/SubGridGate.java @@ -43,13 +43,14 @@ public static SubGridGate fromTransformer3W( return switch (inferiorPort) { case B -> new SubGridGate(transformer, transformer.getNodeA(), transformer.getNodeB()); case C -> new SubGridGate(transformer, transformer.getNodeA(), transformer.getNodeC()); - default -> throw new IllegalArgumentException( - "Only port " - + ConnectorPort.B - + " or " - + ConnectorPort.C - + " can be " - + "chosen as inferior port."); + default -> + throw new IllegalArgumentException( + "Only port " + + ConnectorPort.B + + " or " + + ConnectorPort.C + + " can be " + + "chosen as inferior port."); }; } diff --git a/src/main/java/edu/ie3/datamodel/io/DbGridMetadata.java b/src/main/java/edu/ie3/datamodel/io/DbGridMetadata.java index b613f0894..8d42669af 100644 --- a/src/main/java/edu/ie3/datamodel/io/DbGridMetadata.java +++ b/src/main/java/edu/ie3/datamodel/io/DbGridMetadata.java @@ -21,7 +21,9 @@ public String toString() { return GRID_NAME_COLUMN + "=" + gridName + ", " + GRID_UUID_COLUMN + "=" + uuid.toString(); } - /** @return Stream with grid uuid */ + /** + * @return Stream with grid uuid + */ public Stream getStreamForQuery() { return Stream.of(quote(uuid.toString(), "'")); } diff --git a/src/main/java/edu/ie3/datamodel/io/SqlUtils.java b/src/main/java/edu/ie3/datamodel/io/SqlUtils.java index 501c8c6aa..cfb195d96 100644 --- a/src/main/java/edu/ie3/datamodel/io/SqlUtils.java +++ b/src/main/java/edu/ie3/datamodel/io/SqlUtils.java @@ -23,7 +23,9 @@ private static String beginQueryCreateTable(String schemaName, String tableName) return "CREATE TABLE " + schemaName + "." + tableName + "\n(\n"; } - /** @return query to create a SQL table for a grid */ + /** + * @return query to create a SQL table for a grid + */ public static String queryCreateGridTable(String schemaName) { return beginQueryCreateTable(schemaName, DbGridMetadata.GRID_TABLE_COLUMN) + "\tuuid uuid PRIMARY KEY,\n\tname TEXT NOT NULL\n" diff --git a/src/main/java/edu/ie3/datamodel/io/connectors/CouchbaseConnector.java b/src/main/java/edu/ie3/datamodel/io/connectors/CouchbaseConnector.java index ffeaf86fb..3dc769d71 100644 --- a/src/main/java/edu/ie3/datamodel/io/connectors/CouchbaseConnector.java +++ b/src/main/java/edu/ie3/datamodel/io/connectors/CouchbaseConnector.java @@ -137,7 +137,9 @@ public void shutdown() { cluster.disconnect(); } - /** @return the bucket name */ + /** + * @return the bucket name + */ public String getBucketName() { return bucketName; } diff --git a/src/main/java/edu/ie3/datamodel/io/factory/timeseries/BdewLoadProfileFactory.java b/src/main/java/edu/ie3/datamodel/io/factory/timeseries/BdewLoadProfileFactory.java index 826ceb030..32f3e4780 100644 --- a/src/main/java/edu/ie3/datamodel/io/factory/timeseries/BdewLoadProfileFactory.java +++ b/src/main/java/edu/ie3/datamodel/io/factory/timeseries/BdewLoadProfileFactory.java @@ -95,9 +95,9 @@ public ComparableQuantity calculateMaxPower( Function valueExtractor = switch (loadProfile) { case H0, H25, P25, S25 -> - // maximum dynamization factor is on day 366 (leap year) or day 365 (regular year). - // The difference between day 365 and day 366 is negligible, thus pick 366 - v -> BdewLoadValues.dynamization(v.getMaxValue(true), 366); + // maximum dynamization factor is on day 366 (leap year) or day 365 (regular year). + // The difference between day 365 and day 366 is negligible, thus pick 366 + v -> BdewLoadValues.dynamization(v.getMaxValue(true), 366); default -> v -> v.getMaxValue(false); }; diff --git a/src/main/java/edu/ie3/datamodel/io/factory/timeseries/IdCoordinateFactory.java b/src/main/java/edu/ie3/datamodel/io/factory/timeseries/IdCoordinateFactory.java index 4a8aadddc..c983e65c2 100644 --- a/src/main/java/edu/ie3/datamodel/io/factory/timeseries/IdCoordinateFactory.java +++ b/src/main/java/edu/ie3/datamodel/io/factory/timeseries/IdCoordinateFactory.java @@ -19,12 +19,18 @@ protected IdCoordinateFactory() { super(IdCoordinateInput.class); } - /** @return the field id for the coordinate id */ + /** + * @return the field id for the coordinate id + */ public abstract String getIdField(); - /** @return the field id for the coordinate latitude */ + /** + * @return the field id for the coordinate latitude + */ public abstract String getLatField(); - /** @return the field id for the coordinate longitude */ + /** + * @return the field id for the coordinate longitude + */ public abstract String getLonField(); } diff --git a/src/main/java/edu/ie3/datamodel/io/naming/EntityPersistenceNamingStrategy.java b/src/main/java/edu/ie3/datamodel/io/naming/EntityPersistenceNamingStrategy.java index da19edf2f..0c6f5ca2a 100644 --- a/src/main/java/edu/ie3/datamodel/io/naming/EntityPersistenceNamingStrategy.java +++ b/src/main/java/edu/ie3/datamodel/io/naming/EntityPersistenceNamingStrategy.java @@ -41,6 +41,7 @@ public class EntityPersistenceNamingStrategy { private static final String UUID_STRING = "[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12}"; + /** * Regex to match the naming convention of a source for an individual time series. The column * scheme is accessible via the named capturing group "columnScheme". The time series' UUID is diff --git a/src/main/java/edu/ie3/datamodel/io/processor/Processor.java b/src/main/java/edu/ie3/datamodel/io/processor/Processor.java index 0c83b0f26..d232dbf27 100644 --- a/src/main/java/edu/ie3/datamodel/io/processor/Processor.java +++ b/src/main/java/edu/ie3/datamodel/io/processor/Processor.java @@ -221,7 +221,7 @@ protected String processMethodResult( StringBuilder resultStringBuilder = new StringBuilder(); switch (method.returnType()) { - // primitives (Boolean, Character, Byte, Short, Integer, Long, Float, Double, String, + // primitives (Boolean, Character, Byte, Short, Integer, Long, Float, Double, String, case "UUID", "boolean", "int", @@ -230,43 +230,46 @@ protected String processMethodResult( "DayOfWeek", "Season", "ChargingPointType", - "EvcsLocationType" -> resultStringBuilder.append(methodReturnObject.toString()); - case "Quantity", "ComparableQuantity" -> resultStringBuilder.append( - handleQuantity((Quantity) methodReturnObject, fieldName)); + "EvcsLocationType" -> + resultStringBuilder.append(methodReturnObject.toString()); + case "Quantity", "ComparableQuantity" -> + resultStringBuilder.append(handleQuantity((Quantity) methodReturnObject, fieldName)); case "Optional" -> - // only quantity optionals are expected here! - // if optional and present, unpack value and call this method again, if not present return - // an empty string as by convention null == missing value == "" when persisting data - resultStringBuilder.append( - ((Optional) methodReturnObject) - .map( - o -> { - if (o instanceof Quantity quantity) { - return Try.of( - () -> handleQuantity(quantity, fieldName), - EntityProcessorException.class); - } else if (o instanceof UniqueEntity entity) { - return Try.of(entity::getUuid, EntityProcessorException.class); - } else { - return Failure.of( - new EntityProcessorException( - "Handling of " - + o.getClass().getSimpleName() - + ".class instance wrapped into Optional is currently not supported by entity processors!")); - } - }) - .orElse(Success.of("")) // (in case of empty optional) - .getOrThrow()); - case "ZonedDateTime" -> resultStringBuilder.append( - processZonedDateTime((ZonedDateTime) methodReturnObject)); - case "OperationTime" -> resultStringBuilder.append( - processOperationTime((OperationTime) methodReturnObject, fieldName)); - case "VoltageLevel" -> resultStringBuilder.append( - processVoltageLevel((VoltageLevel) methodReturnObject, fieldName)); - case "Point", "LineString" -> resultStringBuilder.append( - geoJsonWriter.write((Geometry) methodReturnObject)); - case "LoadProfile", "BdewStandardLoadProfile", "RandomLoadProfile" -> resultStringBuilder - .append(((LoadProfile) methodReturnObject).getKey()); + // only quantity optionals are expected here! + // if optional and present, unpack value and call this method again, if not present return + // an empty string as by convention null == missing value == "" when persisting data + resultStringBuilder.append( + ((Optional) methodReturnObject) + .map( + o -> { + if (o instanceof Quantity quantity) { + return Try.of( + () -> handleQuantity(quantity, fieldName), + EntityProcessorException.class); + } else if (o instanceof UniqueEntity entity) { + return Try.of(entity::getUuid, EntityProcessorException.class); + } else { + return Failure.of( + new EntityProcessorException( + "Handling of " + + o.getClass().getSimpleName() + + ".class instance wrapped into Optional is currently not supported by entity processors!")); + } + }) + .orElse(Success.of("")) // (in case of empty optional) + .getOrThrow()); + case "ZonedDateTime" -> + resultStringBuilder.append(processZonedDateTime((ZonedDateTime) methodReturnObject)); + case "OperationTime" -> + resultStringBuilder.append( + processOperationTime((OperationTime) methodReturnObject, fieldName)); + case "VoltageLevel" -> + resultStringBuilder.append( + processVoltageLevel((VoltageLevel) methodReturnObject, fieldName)); + case "Point", "LineString" -> + resultStringBuilder.append(geoJsonWriter.write((Geometry) methodReturnObject)); + case "LoadProfile", "BdewStandardLoadProfile", "RandomLoadProfile" -> + resultStringBuilder.append(((LoadProfile) methodReturnObject).getKey()); case "AssetTypeInput", "BmTypeInput", "ChpTypeInput", @@ -283,11 +286,13 @@ protected String processMethodResult( "Transformer2WTypeInput", "Transformer3WTypeInput", "WecTypeInput", - "EmInput" -> resultStringBuilder.append(((UniqueEntity) methodReturnObject).getUuid()); - case "OperatorInput" -> resultStringBuilder.append( - ((OperatorInput) methodReturnObject).getId().equalsIgnoreCase("NO_OPERATOR_ASSIGNED") - ? "" - : ((OperatorInput) methodReturnObject).getUuid()); + "EmInput" -> + resultStringBuilder.append(((UniqueEntity) methodReturnObject).getUuid()); + case "OperatorInput" -> + resultStringBuilder.append( + ((OperatorInput) methodReturnObject).getId().equalsIgnoreCase("NO_OPERATOR_ASSIGNED") + ? "" + : ((OperatorInput) methodReturnObject).getUuid()); case "EvCharacteristicInput", "OlmCharacteristicInput", "WecCharacteristicInput", @@ -295,20 +300,21 @@ protected String processMethodResult( "CosPhiP", "QV", "ReactivePowerCharacteristic", - "CharacteristicInput" -> resultStringBuilder.append( - ((CharacteristicInput) methodReturnObject).serialize()); - case "InputModelType" -> resultStringBuilder.append( - ((CongestionResult.InputModelType) methodReturnObject).type); - default -> throw new EntityProcessorException( - "Unable to process value for attribute/field '" - + fieldName - + "' and method return type '" - + method.returnType() - + "' for method with name '" - + method.name() - + "' in in entity model " - + getRegisteredClass().getSimpleName() - + ".class."); + "CharacteristicInput" -> + resultStringBuilder.append(((CharacteristicInput) methodReturnObject).serialize()); + case "InputModelType" -> + resultStringBuilder.append(((CongestionResult.InputModelType) methodReturnObject).type); + default -> + throw new EntityProcessorException( + "Unable to process value for attribute/field '" + + fieldName + + "' and method return type '" + + method.returnType() + + "' for method with name '" + + method.name() + + "' in in entity model " + + getRegisteredClass().getSimpleName() + + ".class."); } return resultStringBuilder.toString(); diff --git a/src/main/java/edu/ie3/datamodel/io/sink/InfluxDbSink.java b/src/main/java/edu/ie3/datamodel/io/sink/InfluxDbSink.java index 80d0795d5..275d549aa 100644 --- a/src/main/java/edu/ie3/datamodel/io/sink/InfluxDbSink.java +++ b/src/main/java/edu/ie3/datamodel/io/sink/InfluxDbSink.java @@ -26,8 +26,10 @@ /** InfluxDB Sink for result and time series data */ public class InfluxDbSink implements OutputDataSink { public static final Logger log = LoggerFactory.getLogger(InfluxDbSink.class); + /** Field name for time */ private static final String FIELD_NAME_TIME = "time"; + /** Field name for input model uuid field in result entities */ private static final String FIELD_NAME_INPUT = "inputModel"; diff --git a/src/main/java/edu/ie3/datamodel/io/sink/SqlSink.java b/src/main/java/edu/ie3/datamodel/io/sink/SqlSink.java index ea99d17a3..438f88fd7 100644 --- a/src/main/java/edu/ie3/datamodel/io/sink/SqlSink.java +++ b/src/main/java/edu/ie3/datamodel/io/sink/SqlSink.java @@ -447,7 +447,9 @@ private String writeOneLine(String[] entries, String[] addParams) { // -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=- - /** @return insertion order for unique entities */ + /** + * @return insertion order for unique entities + */ private static List> hierarchicInsert() { List> sortedInsert = new ArrayList<>(); sortedInsert.add(AssetTypeInput.class); // 1. Types diff --git a/src/main/java/edu/ie3/datamodel/io/source/EntitySource.java b/src/main/java/edu/ie3/datamodel/io/source/EntitySource.java index 0c4d9c1d6..149ec52ac 100644 --- a/src/main/java/edu/ie3/datamodel/io/source/EntitySource.java +++ b/src/main/java/edu/ie3/datamodel/io/source/EntitySource.java @@ -138,8 +138,8 @@ protected static CsvDataSource getBuildInSource(Class clazz, String subdirect connector = new CsvFileConnector(jarFileSystem.getPath(array[1]), clazz::getResourceAsStream); } - default -> throw new SourceException( - "Protocol " + url.getProtocol() + " is nor supported!"); + default -> + throw new SourceException("Protocol " + url.getProtocol() + " is nor supported!"); } return new CsvDataSource(",", connector, new FileNamingStrategy()); diff --git a/src/main/java/edu/ie3/datamodel/io/source/couchbase/CouchbaseWeatherSource.java b/src/main/java/edu/ie3/datamodel/io/source/couchbase/CouchbaseWeatherSource.java index 8dc56cafe..e8a2d1583 100644 --- a/src/main/java/edu/ie3/datamodel/io/source/couchbase/CouchbaseWeatherSource.java +++ b/src/main/java/edu/ie3/datamodel/io/source/couchbase/CouchbaseWeatherSource.java @@ -34,6 +34,7 @@ public class CouchbaseWeatherSource extends WeatherSource { private static final Logger logger = LoggerFactory.getLogger(CouchbaseWeatherSource.class); private static final String DEFAULT_TIMESTAMP_PATTERN = "yyyy-MM-dd'T'HH:mm:ssxxx"; + /** The start of the document key, comparable to a table name in relational databases */ private static final String DEFAULT_KEY_PREFIX = "weather"; diff --git a/src/main/java/edu/ie3/datamodel/io/source/sql/SqlTimeSeriesSource.java b/src/main/java/edu/ie3/datamodel/io/source/sql/SqlTimeSeriesSource.java index 7145b60ea..e61d98ef2 100644 --- a/src/main/java/edu/ie3/datamodel/io/source/sql/SqlTimeSeriesSource.java +++ b/src/main/java/edu/ie3/datamodel/io/source/sql/SqlTimeSeriesSource.java @@ -318,6 +318,7 @@ private String createQueryForValueBefore( + " < ?" + "ORDER BY time DESC LIMIT 1;"; } + /** * Creates a base query to retrieve all time keys before a given time for given time series with * the following pattern:
diff --git a/src/main/java/edu/ie3/datamodel/models/OperationTime.java b/src/main/java/edu/ie3/datamodel/models/OperationTime.java index 65e1acd53..df4287686 100644 --- a/src/main/java/edu/ie3/datamodel/models/OperationTime.java +++ b/src/main/java/edu/ie3/datamodel/models/OperationTime.java @@ -21,8 +21,10 @@ public class OperationTime implements Serializable { /** Date of operation start */ private ZonedDateTime startDate; + /** Date of operation end */ private ZonedDateTime endDate; + /** Is the operation time frame limited? */ private boolean isLimited; @@ -42,17 +44,23 @@ protected OperationTime(ZonedDateTime startDate, ZonedDateTime endDate, boolean /** Constructor for OperationTime without limitations (= always on) */ private OperationTime() {} - /** @return an OperationTime without time limitations (= always on) */ + /** + * @return an OperationTime without time limitations (= always on) + */ public static OperationTime notLimited() { return new OperationTime(); } - /** @return date of operation start, if present */ + /** + * @return date of operation start, if present + */ public Optional getStartDate() { return Optional.ofNullable(startDate); } - /** @return date of operation end, if present */ + /** + * @return date of operation end, if present + */ public Optional getEndDate() { return Optional.ofNullable(endDate); } @@ -119,7 +127,9 @@ public String toString() { + '}'; } - /** @return OperationTimeBuilder instance */ + /** + * @return OperationTimeBuilder instance + */ public static OperationTimeBuilder builder() { return new OperationTimeBuilder(); } diff --git a/src/main/java/edu/ie3/datamodel/models/StandardUnits.java b/src/main/java/edu/ie3/datamodel/models/StandardUnits.java index ff0763dad..d3a91c0e9 100644 --- a/src/main/java/edu/ie3/datamodel/models/StandardUnits.java +++ b/src/main/java/edu/ie3/datamodel/models/StandardUnits.java @@ -17,119 +17,170 @@ public class StandardUnits { /* Electrical units */ /** Rated apparent power (mainly for input purposes) in kVA */ public static final Unit S_RATED = KILOVOLTAMPERE; + /** Active power for input purposes in kW */ public static final Unit ACTIVE_POWER_IN = KILOWATT; + /** Reactive power for input purposes in kVAr */ public static final Unit REACTIVE_POWER_IN = KILOVAR; + /** Active power for result purposes in MW */ public static final Unit ACTIVE_POWER_RESULT = MEGAWATT; + /** Reactive power for result purposes in MVAr */ public static final Unit REACTIVE_POWER_RESULT = MEGAVAR; + /** Heat demand (power) for result purposes in MW */ public static final Unit Q_DOT_RESULT = MEGAWATT; + /** Energy for input purposes in kWh */ public static final Unit ENERGY_IN = KILOWATTHOUR; + /** Energy for result purposes in MWh */ public static final Unit ENERGY_RESULT = MEGAWATTHOUR; + /** Rated voltage magnitude (mainly for input purposes) in kV */ public static final Unit RATED_VOLTAGE_MAGNITUDE = KILOVOLT; + /** Magnitude of an electric current in A */ public static final Unit ELECTRIC_CURRENT_MAGNITUDE = AMPERE; + /** Angle of an electric current in ° (arc degree) */ public static final Unit ELECTRIC_CURRENT_ANGLE = DEGREE_GEOM; + /** Impedance in Ω */ public static final Unit IMPEDANCE = OHM; + /** Resistance in Ω */ public static final Unit RESISTANCE = OHM; + /** Reactance in Ω */ public static final Unit REACTANCE = OHM; + /** Impedance per length (mainly for lines) in Ω/km */ public static final Unit IMPEDANCE_PER_LENGTH = OHM_PER_KILOMETRE; + /** Resistance per length (mainly for lines) in Ω/km */ public static final Unit RESISTANCE_PER_LENGTH = OHM_PER_KILOMETRE; + /** Reactance per length (mainly for lines) in Ω/km */ public static final Unit REACTANCE_PER_LENGTH = OHM_PER_KILOMETRE; + /** Admittance in nS */ public static final Unit CONDUCTANCE = NANOSIEMENS; + /** Conductance in nS */ public static final Unit SUSCEPTANCE = NANOSIEMENS; + /** Susceptance in nS */ public static final Unit ADMITTANCE = NANOSIEMENS; + /** Admittance per length (mainly for lines) in µS/km */ public static final Unit ADMITTANCE_PER_LENGTH = MICRO_SIEMENS_PER_KILOMETRE; + /** Conductance per length (mainly for lines) in µS/km */ public static final Unit CONDUCTANCE_PER_LENGTH = MICRO_SIEMENS_PER_KILOMETRE; + /** Susceptance per length (mainly for lines) in µS/km */ public static final Unit SUSCEPTANCE_PER_LENGTH = MICRO_SIEMENS_PER_KILOMETRE; + /** Target voltage magnitude in p.U. */ public static final Unit TARGET_VOLTAGE_MAGNITUDE = PU; + /** Voltage magnitude (mainly for result purposes) in p.U. */ public static final Unit VOLTAGE_MAGNITUDE = PU; + /** Voltage angle (mainly for result purposes) in ° (arc degree) */ public static final Unit VOLTAGE_ANGLE = DEGREE_GEOM; + /** Electric energy per driven distance in kWh/km */ public static final Unit ENERGY_PER_DISTANCE = KILOWATTHOUR_PER_KILOMETRE; /* Other Units */ /** Voltage magnitude variation per tap (for transformers) in % */ public static final Unit DV_TAP = PERCENT; + /** Voltage angle variation per tap (for transformers) in ° (arc degree) */ public static final Unit DPHI_TAP = DEGREE_GEOM; + /** * Gradient, with which a system participant can change its set point (with regard to rated active * power = rated apparent power * rated power factor) in %/h */ public static final Unit ACTIVE_POWER_GRADIENT = PERCENT_PER_HOUR; + /** Efficiency of a process in % */ public static final Unit EFFICIENCY = PERCENT; + /** Volume in m³ */ public static final Unit VOLUME = CUBIC_METRE; + /** Fill level of a storage in % */ public static final Unit FILL_LEVEL = PERCENT; + /** Temperature in °C */ public static final Unit TEMPERATURE = CELSIUS; + /** Heat demand of a thermal sink in MW */ public static final Unit HEAT_DEMAND = MEGAWATT; + /** Heat demand, that is delivered via a profile in kW */ public static final Unit HEAT_DEMAND_PROFILE = KILOWATT; + /** Thermal capacity of a given mass in kWh/K */ public static final Unit HEAT_CAPACITY = KILOWATTHOUR_PER_KELVIN; + /** Thermal capacity per mass kWh*m³/K */ public static final Unit SPECIFIC_HEAT_CAPACITY = KILOWATTHOUR_PER_KELVIN_TIMES_CUBICMETRE; + /** Thermal transmission through an insulation in kW/K */ public static final Unit THERMAL_TRANSMISSION = KILOWATT_PER_KELVIN; + /** State of charge in % */ public static final Unit SOC = PERCENT; + /** Area covered by the rotor of a wind energy converter in m² */ public static final Unit ROTOR_AREA = SQUARE_METRE; + /** Height of the hub of an wind energy converter in metre */ public static final Unit HUB_HEIGHT = METRE; + /** Price per energy in euro per megawatt hour */ public static final Unit ENERGY_PRICE = EURO_PER_MEGAWATTHOUR; + /** Orientation of a pv panel with regard to the north-south line in degree_geom */ public static final Unit AZIMUTH = DEGREE_GEOM; + /** Elevation of a pv panel with regard to the plane in degree_geom */ public static final Unit SOLAR_ELEVATION_ANGLE = DEGREE_GEOM; + /** Direction of the wind in degree geom */ public static final Unit WIND_DIRECTION = DEGREE_GEOM; + /** Velocity of the wind in metre per second */ public static final Unit WIND_VELOCITY = METRE_PER_SECOND; + /** Standard unit for the Betz' coefficient curve of wind energy converters in p.U. */ public static final Unit CP_CHARACTERISTIC = PU; + /** Standard unit for the ev charging curve in p.U. */ public static final Unit EV_CHARACTERISTIC = PU; + /** Standard unit for the overhead line monitoring characteristic in p.U. */ public static final Unit OLM_CHARACTERISTIC = PU; + /** Standard unit for reactive power characteristics in p.U. */ public static final Unit Q_CHARACTERISTIC = PU; + /** Solar irradiance on a flat surface as power per area in W/m² */ public static final Unit SOLAR_IRRADIANCE = WATT_PER_SQUAREMETRE; /** Capex (capital expenditure) in € */ public static final Unit CAPEX = EURO; + /** Length of a line in km */ public static final Unit LINE_LENGTH = KILOMETRE; diff --git a/src/main/java/edu/ie3/datamodel/models/input/AssetInput.java b/src/main/java/edu/ie3/datamodel/models/input/AssetInput.java index f9323ebc2..3904c31f4 100644 --- a/src/main/java/edu/ie3/datamodel/models/input/AssetInput.java +++ b/src/main/java/edu/ie3/datamodel/models/input/AssetInput.java @@ -14,8 +14,10 @@ public abstract class AssetInput extends UniqueInputEntity implements Operable { /** Time for which the entity is operated */ private final OperationTime operationTime; + /** The operator of this asset */ private final OperatorInput operator; + /** Name or ID of the asset */ private final String id; diff --git a/src/main/java/edu/ie3/datamodel/models/input/NodeInput.java b/src/main/java/edu/ie3/datamodel/models/input/NodeInput.java index d5e8e5dbc..b4bc55aec 100644 --- a/src/main/java/edu/ie3/datamodel/models/input/NodeInput.java +++ b/src/main/java/edu/ie3/datamodel/models/input/NodeInput.java @@ -19,8 +19,10 @@ public class NodeInput extends AssetInput { /** Target voltage magnitude of the node with regard to its rated voltage (typically in p.u.) */ private final ComparableQuantity vTarget; + /** Is this node a slack node? */ private final boolean slack; + /** * The coordinates of this node, especially relevant for geo-dependant systems, that are connected * to this node @@ -32,6 +34,7 @@ public class NodeInput extends AssetInput { /** Voltage level of this node */ private final VoltageLevel voltLvl; + /** Subnet of this node */ private final int subnet; diff --git a/src/main/java/edu/ie3/datamodel/models/input/connector/ConnectorInput.java b/src/main/java/edu/ie3/datamodel/models/input/connector/ConnectorInput.java index cc5965af3..576c7ed3b 100644 --- a/src/main/java/edu/ie3/datamodel/models/input/connector/ConnectorInput.java +++ b/src/main/java/edu/ie3/datamodel/models/input/connector/ConnectorInput.java @@ -16,8 +16,10 @@ public abstract class ConnectorInput extends AssetInput implements HasNodes { /** Grid node at one side of the connector */ private final NodeInput nodeA; + /** Grid node at the other side of the connector */ private final NodeInput nodeB; + /** Amount of parallelDevices */ private final int parallelDevices; diff --git a/src/main/java/edu/ie3/datamodel/models/input/connector/LineInput.java b/src/main/java/edu/ie3/datamodel/models/input/connector/LineInput.java index 9bbef37a5..a4c1ce924 100644 --- a/src/main/java/edu/ie3/datamodel/models/input/connector/LineInput.java +++ b/src/main/java/edu/ie3/datamodel/models/input/connector/LineInput.java @@ -27,10 +27,13 @@ public class LineInput extends ConnectorInput implements HasType { /** Type of this line, containing default values for lines of this kind */ private final LineTypeInput type; + /** Length of this line */ private final ComparableQuantity length; + /** Coordinates of this line */ private final LineString geoPosition; + /** Description of an optional weather dependent operation curve */ private final OlmCharacteristicInput olmCharacteristic; diff --git a/src/main/java/edu/ie3/datamodel/models/input/connector/Transformer3WInput.java b/src/main/java/edu/ie3/datamodel/models/input/connector/Transformer3WInput.java index 897304370..a0fcf54cd 100644 --- a/src/main/java/edu/ie3/datamodel/models/input/connector/Transformer3WInput.java +++ b/src/main/java/edu/ie3/datamodel/models/input/connector/Transformer3WInput.java @@ -23,8 +23,10 @@ public class Transformer3WInput extends TransformerInput implements HasType { /** Type of this 3W transformer, containing default values for transformers of this kind */ private final Transformer3WTypeInput type; + /** The lower voltage node */ private final NodeInput nodeC; + /** Internal node of the transformers T equivalent circuit */ private final NodeInput nodeInternal; @@ -215,24 +217,32 @@ public Transformer3WTypeInput getType() { return type; } - /** @return the node with the highest voltage level */ + /** + * @return the node with the highest voltage level + */ @Override public NodeInput getNodeA() { return super.getNodeA(); } - /** @return the node with the "medium" voltage level */ + /** + * @return the node with the "medium" voltage level + */ @Override public NodeInput getNodeB() { return super.getNodeB(); } - /** @return the node with the lowest voltage level */ + /** + * @return the node with the lowest voltage level + */ public NodeInput getNodeC() { return nodeC; } - /** @return The internal node of the T equivalent circuit */ + /** + * @return The internal node of the T equivalent circuit + */ public NodeInput getNodeInternal() { return nodeInternal; } diff --git a/src/main/java/edu/ie3/datamodel/models/input/connector/TransformerInput.java b/src/main/java/edu/ie3/datamodel/models/input/connector/TransformerInput.java index 903bcf94d..2acd38143 100644 --- a/src/main/java/edu/ie3/datamodel/models/input/connector/TransformerInput.java +++ b/src/main/java/edu/ie3/datamodel/models/input/connector/TransformerInput.java @@ -15,6 +15,7 @@ public abstract class TransformerInput extends ConnectorInput { /** Tap position of this transformer */ private final int tapPos; + /** True, if the tap position of the transformer is adapted automatically */ private final boolean autoTap; diff --git a/src/main/java/edu/ie3/datamodel/models/input/connector/type/LineTypeInput.java b/src/main/java/edu/ie3/datamodel/models/input/connector/type/LineTypeInput.java index 9e18c980b..18c7374cf 100644 --- a/src/main/java/edu/ie3/datamodel/models/input/connector/type/LineTypeInput.java +++ b/src/main/java/edu/ie3/datamodel/models/input/connector/type/LineTypeInput.java @@ -19,14 +19,19 @@ public class LineTypeInput extends AssetTypeInput { /** Specific phase-to-ground susceptance for this type of line (typically in µS/km) */ private final ComparableQuantity b; + /** Specific phase-to-ground conductance for this type of line (typically in µS/km) */ private final ComparableQuantity g; + /** Specific resistance for this type of line (typically in Ohm/km) */ private final ComparableQuantity r; + /** Specific reactance for this type of line (typically in Ohm/km) */ private final ComparableQuantity x; + /** Maximum thermal current for this type of line (typically in A) */ private final ComparableQuantity iMax; + /** Rated voltage for this type of line (typically in V) */ private final ComparableQuantity vRated; diff --git a/src/main/java/edu/ie3/datamodel/models/input/connector/type/Transformer2WTypeInput.java b/src/main/java/edu/ie3/datamodel/models/input/connector/type/Transformer2WTypeInput.java index b5a81b6aa..072d5fb85 100644 --- a/src/main/java/edu/ie3/datamodel/models/input/connector/type/Transformer2WTypeInput.java +++ b/src/main/java/edu/ie3/datamodel/models/input/connector/type/Transformer2WTypeInput.java @@ -16,28 +16,40 @@ public class Transformer2WTypeInput extends AssetTypeInput { /** Short circuit resistance (typically in Ohm) */ private final ComparableQuantity rSc; + /** Short circuit reactance (typically in Ohm) */ private final ComparableQuantity xSc; + /** Rated apparent power (typically in kVA) */ private final ComparableQuantity sRated; + /** Rated voltage of the high voltage winding (typically in kV) */ private final ComparableQuantity vRatedA; + /** Rated voltage of the low voltage winding (typically in kV) */ private final ComparableQuantity vRatedB; + /** Phase-to-ground conductance (typically in nS) */ private final ComparableQuantity gM; + /** Phase-to-ground susceptance (typically in nS) */ private final ComparableQuantity bM; + /** Voltage magnitude deviation per tap position (typically in %) */ private final ComparableQuantity dV; + /** Voltage angle deviation per tap position (typically in °) */ private final ComparableQuantity dPhi; + /** Selection of winding, where the tap changer is installed. Low voltage, if true */ private final boolean tapSide; + /** Neutral tap position */ private final int tapNeutr; + /** Minimum available tap position */ private final int tapMin; + /** Maximum available tap position */ private final int tapMax; diff --git a/src/main/java/edu/ie3/datamodel/models/input/connector/type/Transformer3WTypeInput.java b/src/main/java/edu/ie3/datamodel/models/input/connector/type/Transformer3WTypeInput.java index 6b2013300..f08daf255 100644 --- a/src/main/java/edu/ie3/datamodel/models/input/connector/type/Transformer3WTypeInput.java +++ b/src/main/java/edu/ie3/datamodel/models/input/connector/type/Transformer3WTypeInput.java @@ -16,40 +16,58 @@ public class Transformer3WTypeInput extends AssetTypeInput { /** Rated apparent power of the high voltage winding (typically in kVA) */ private final ComparableQuantity sRatedA; // Hv + /** Rated apparent power of the medium voltage winding (typically in kVA) */ private final ComparableQuantity sRatedB; // Mv + /** Rated apparent power of the low voltage windings (typically in kVA) */ private final ComparableQuantity sRatedC; // Lv + /** Rated voltage magnitude of the high voltage winding (typically in kV) */ private final ComparableQuantity vRatedA; // Hv + /** Rated voltage magnitude of the medium voltage winding (typically in kV) */ private final ComparableQuantity vRatedB; // Mv + /** Rated voltage magnitude of the low voltage winding (typically in kV) */ private final ComparableQuantity vRatedC; // Lv + /** Short-circuit resistance of the high voltage winding (typically in Ohm) */ private final ComparableQuantity rScA; // Hv + /** Short-circuit resistance of the medium voltage winding (typically in Ohm) */ private final ComparableQuantity rScB; // Mv + /** Short-circuit resistance of the low voltage winding (typically in Ohm) */ private final ComparableQuantity rScC; // Lv + /** Short-circuit reactance of the high voltage winding (typically in Ohm) */ private final ComparableQuantity xScA; // Hv + /** Short-circuit reactance of the medium voltage winding (typically in Ohm) */ private final ComparableQuantity xScB; // Mv + /** Short-circuit reactance of the low voltage winding (typically in Ohm) */ private final ComparableQuantity xScC; // Lv + /** Phase-to-ground conductance (typically in nS) */ private final ComparableQuantity gM; + /** Phase-to-ground susceptance (typically in nS) */ private final ComparableQuantity bM; + /** Voltage magnitude deviation per tap position (typically in %) */ private final ComparableQuantity dV; + /** Voltage angle deviation per tap position (typically in °) */ private final ComparableQuantity dPhi; + /** Neutral tap position */ private final int tapNeutr; + /** Minimum available tap position */ private final int tapMin; + /** Maximum available tap position */ private final int tapMax; diff --git a/src/main/java/edu/ie3/datamodel/models/input/container/GraphicElements.java b/src/main/java/edu/ie3/datamodel/models/input/container/GraphicElements.java index 4863745c5..658744c09 100644 --- a/src/main/java/edu/ie3/datamodel/models/input/container/GraphicElements.java +++ b/src/main/java/edu/ie3/datamodel/models/input/container/GraphicElements.java @@ -72,12 +72,16 @@ public GraphicElementsCopyBuilder copy() { return new GraphicElementsCopyBuilder(this); } - /** @return unmodifiable Set of all node graphic data for this grid */ + /** + * @return unmodifiable Set of all node graphic data for this grid + */ public Set getNodeGraphics() { return Collections.unmodifiableSet(nodeGraphics); } - /** @return unmodifiable Set of all line graphic data for this grid */ + /** + * @return unmodifiable Set of all line graphic data for this grid + */ public Set getLineGraphics() { return Collections.unmodifiableSet(lineGraphics); } diff --git a/src/main/java/edu/ie3/datamodel/models/input/container/GridContainer.java b/src/main/java/edu/ie3/datamodel/models/input/container/GridContainer.java index 26b8793e8..46f50ae97 100644 --- a/src/main/java/edu/ie3/datamodel/models/input/container/GridContainer.java +++ b/src/main/java/edu/ie3/datamodel/models/input/container/GridContainer.java @@ -11,10 +11,13 @@ public abstract class GridContainer implements InputContainer { /** Name of this grid */ protected final String gridName; + /** Accumulated raw grid elements (lines, nodes, transformers, switches) */ protected final RawGridElements rawGrid; + /** Accumulated system participant elements */ protected final SystemParticipants systemParticipants; + /** Accumulated graphic data entities (node graphics, line graphics) */ protected final GraphicElements graphics; diff --git a/src/main/java/edu/ie3/datamodel/models/input/container/InputContainer.java b/src/main/java/edu/ie3/datamodel/models/input/container/InputContainer.java index ca162fc4c..dfaae5bc1 100644 --- a/src/main/java/edu/ie3/datamodel/models/input/container/InputContainer.java +++ b/src/main/java/edu/ie3/datamodel/models/input/container/InputContainer.java @@ -13,7 +13,9 @@ /** Represents an aggregation of different entities */ public interface InputContainer extends Serializable { - /** @return unmodifiable List of all entities */ + /** + * @return unmodifiable List of all entities + */ List allEntitiesAsList(); /** Returns an input container copy builder */ diff --git a/src/main/java/edu/ie3/datamodel/models/input/container/RawGridElements.java b/src/main/java/edu/ie3/datamodel/models/input/container/RawGridElements.java index 18dadd1d2..afd2fc532 100644 --- a/src/main/java/edu/ie3/datamodel/models/input/container/RawGridElements.java +++ b/src/main/java/edu/ie3/datamodel/models/input/container/RawGridElements.java @@ -16,14 +16,19 @@ public class RawGridElements implements InputContainer { /** Set of nodes in this grid */ private final Set nodes; + /** Set of lines in this grid */ private final Set lines; + /** Set of two winding transformers in this grid */ private final Set transformer2Ws; + /** Set of three winding in this grid */ private final Set transformer3Ws; + /** Set of switches in this grid */ private final Set switches; + /** Measurement units in this grid */ private final Set measurementUnits; @@ -132,32 +137,44 @@ public RawGridElementsCopyBuilder copy() { return new RawGridElementsCopyBuilder(this); } - /** @return unmodifiable ; of all three winding transformers in this grid */ + /** + * @return unmodifiable ; of all three winding transformers in this grid + */ public Set getNodes() { return Collections.unmodifiableSet(nodes); } - /** @return unmodifiable Set of all lines in this grid */ + /** + * @return unmodifiable Set of all lines in this grid + */ public Set getLines() { return Collections.unmodifiableSet(lines); } - /** @return unmodifiable Set of all two winding transformers in this grid */ + /** + * @return unmodifiable Set of all two winding transformers in this grid + */ public Set getTransformer2Ws() { return Collections.unmodifiableSet(transformer2Ws); } - /** @return unmodifiable Set of all three winding transformers in this grid */ + /** + * @return unmodifiable Set of all three winding transformers in this grid + */ public Set getTransformer3Ws() { return Collections.unmodifiableSet(transformer3Ws); } - /** @return unmodifiable Set of all switches in this grid */ + /** + * @return unmodifiable Set of all switches in this grid + */ public Set getSwitches() { return Collections.unmodifiableSet(switches); } - /** @return unmodifiable Set of all measurement units in this grid */ + /** + * @return unmodifiable Set of all measurement units in this grid + */ public Set getMeasurementUnits() { return Collections.unmodifiableSet(measurementUnits); } diff --git a/src/main/java/edu/ie3/datamodel/models/input/container/SubGridContainer.java b/src/main/java/edu/ie3/datamodel/models/input/container/SubGridContainer.java index 2c05b187f..f20ee9d4e 100644 --- a/src/main/java/edu/ie3/datamodel/models/input/container/SubGridContainer.java +++ b/src/main/java/edu/ie3/datamodel/models/input/container/SubGridContainer.java @@ -16,6 +16,7 @@ public class SubGridContainer extends GridContainer { /** subnet number of this grid */ private final int subnet; + /** Predominantly apparent voltage level in this single grid */ private final VoltageLevel predominantVoltageLevel; diff --git a/src/main/java/edu/ie3/datamodel/models/input/container/SystemParticipants.java b/src/main/java/edu/ie3/datamodel/models/input/container/SystemParticipants.java index db1ef39b3..fa81ea0fd 100644 --- a/src/main/java/edu/ie3/datamodel/models/input/container/SystemParticipants.java +++ b/src/main/java/edu/ie3/datamodel/models/input/container/SystemParticipants.java @@ -177,52 +177,72 @@ public SystemParticipantsCopyBuilder copy() { return new SystemParticipantsCopyBuilder(this); } - /** @return unmodifiable Set of all biomass plants in this grid */ + /** + * @return unmodifiable Set of all biomass plants in this grid + */ public Set getBmPlants() { return Collections.unmodifiableSet(bmPlants); } - /** @return unmodifiable Set of all CHP plants in this grid */ + /** + * @return unmodifiable Set of all CHP plants in this grid + */ public Set getChpPlants() { return Collections.unmodifiableSet(chpPlants); } - /** @return unmodifiable Set of all ev charging stations in this grid */ + /** + * @return unmodifiable Set of all ev charging stations in this grid + */ public Set getEvcs() { return Collections.unmodifiableSet(evcs); } - /** @return unmodifiable Set of all electric vehicles in this grid */ + /** + * @return unmodifiable Set of all electric vehicles in this grid + */ public Set getEvs() { return evs; } - /** @return unmodifiable Set of all fixed feed in this grid */ + /** + * @return unmodifiable Set of all fixed feed in this grid + */ public Set getFixedFeedIns() { return Collections.unmodifiableSet(fixedFeedIns); } - /** @return unmodifiable Set of all heat pumps in this grid */ + /** + * @return unmodifiable Set of all heat pumps in this grid + */ public Set getHeatPumps() { return Collections.unmodifiableSet(heatPumps); } - /** @return unmodifiable Set of all loads in this grid */ + /** + * @return unmodifiable Set of all loads in this grid + */ public Set getLoads() { return Collections.unmodifiableSet(loads); } - /** @return unmodifiable Set of all PV plants in this grid */ + /** + * @return unmodifiable Set of all PV plants in this grid + */ public Set getPvPlants() { return Collections.unmodifiableSet(pvPlants); } - /** @return unmodifiable Set of all storages in this grid */ + /** + * @return unmodifiable Set of all storages in this grid + */ public Set getStorages() { return Collections.unmodifiableSet(storages); } - /** @return unmodifiable Set of all WECs in this grid */ + /** + * @return unmodifiable Set of all WECs in this grid + */ public Set getWecPlants() { return Collections.unmodifiableSet(wecPlants); } diff --git a/src/main/java/edu/ie3/datamodel/models/input/graphics/GraphicInput.java b/src/main/java/edu/ie3/datamodel/models/input/graphics/GraphicInput.java index b9b69947a..c0cc6a78c 100644 --- a/src/main/java/edu/ie3/datamodel/models/input/graphics/GraphicInput.java +++ b/src/main/java/edu/ie3/datamodel/models/input/graphics/GraphicInput.java @@ -15,6 +15,7 @@ public abstract class GraphicInput extends UniqueInputEntity { /** Description of the graphic layer, this graphic is located on */ private final String graphicLayer; + /** A graphic representation as path */ private final LineString path; diff --git a/src/main/java/edu/ie3/datamodel/models/input/graphics/NodeGraphicInput.java b/src/main/java/edu/ie3/datamodel/models/input/graphics/NodeGraphicInput.java index 6da3c97c2..ef8582b0a 100644 --- a/src/main/java/edu/ie3/datamodel/models/input/graphics/NodeGraphicInput.java +++ b/src/main/java/edu/ie3/datamodel/models/input/graphics/NodeGraphicInput.java @@ -15,6 +15,7 @@ public class NodeGraphicInput extends GraphicInput implements HasNodes { /** The NodeInput to this graphic data */ private final NodeInput node; + /** The geometric point of this node */ private final Point point; diff --git a/src/main/java/edu/ie3/datamodel/models/input/system/BmInput.java b/src/main/java/edu/ie3/datamodel/models/input/system/BmInput.java index cec5e8a89..f5a51d64e 100644 --- a/src/main/java/edu/ie3/datamodel/models/input/system/BmInput.java +++ b/src/main/java/edu/ie3/datamodel/models/input/system/BmInput.java @@ -22,12 +22,15 @@ public class BmInput extends SystemParticipantInput implements HasType { /** Type of this BM plant, containing default values for BM plants of this kind */ private final BmTypeInput type; + /** Is this asset market oriented? */ private final boolean marketReaction; + /** * Does this plant increase the output power if the revenues exceed the energy generation costs? */ private final boolean costControlled; + /** Granted feed in tariff (typically in €/MWh) */ private final ComparableQuantity feedInTariff; diff --git a/src/main/java/edu/ie3/datamodel/models/input/system/ChpInput.java b/src/main/java/edu/ie3/datamodel/models/input/system/ChpInput.java index f5dcd6bc1..024e8f36e 100644 --- a/src/main/java/edu/ie3/datamodel/models/input/system/ChpInput.java +++ b/src/main/java/edu/ie3/datamodel/models/input/system/ChpInput.java @@ -24,10 +24,13 @@ public class ChpInput extends SystemParticipantInput implements HasType, HasThermalBus, HasThermalStorage { /** The thermal bus, this model is connected to */ private final ThermalBusInput thermalBus; + /** Type of this CHP plant, containing default values for CHP plants of this kind */ private final ChpTypeInput type; + /** Thermal storage model */ private final ThermalStorageInput thermalStorage; + /** Is this asset market oriented? */ private final boolean marketReaction; diff --git a/src/main/java/edu/ie3/datamodel/models/input/system/EvcsInput.java b/src/main/java/edu/ie3/datamodel/models/input/system/EvcsInput.java index 7f1dcb1a0..7c41cf70b 100644 --- a/src/main/java/edu/ie3/datamodel/models/input/system/EvcsInput.java +++ b/src/main/java/edu/ie3/datamodel/models/input/system/EvcsInput.java @@ -106,6 +106,7 @@ public EvcsInput( locationType, v2gSupport); } + /** * @param uuid Unique identifier * @param id Human readable identifier diff --git a/src/main/java/edu/ie3/datamodel/models/input/system/FixedFeedInInput.java b/src/main/java/edu/ie3/datamodel/models/input/system/FixedFeedInInput.java index 23d3edeb6..c9676a97e 100644 --- a/src/main/java/edu/ie3/datamodel/models/input/system/FixedFeedInInput.java +++ b/src/main/java/edu/ie3/datamodel/models/input/system/FixedFeedInInput.java @@ -20,6 +20,7 @@ public class FixedFeedInInput extends SystemParticipantInput { /** Rated apparent power (typically in kVA) */ private final ComparableQuantity sRated; + /** Rated power factor */ private final double cosPhiRated; diff --git a/src/main/java/edu/ie3/datamodel/models/input/system/HpInput.java b/src/main/java/edu/ie3/datamodel/models/input/system/HpInput.java index a02ac1a7a..e9eca6403 100644 --- a/src/main/java/edu/ie3/datamodel/models/input/system/HpInput.java +++ b/src/main/java/edu/ie3/datamodel/models/input/system/HpInput.java @@ -21,6 +21,7 @@ public class HpInput extends SystemParticipantInput implements HasType, HasThermalBus { /** Type of this heat pump, containing default values for heat pump of this kind */ private final HpTypeInput type; + /** The thermal bus, this model is connected to */ private final ThermalBusInput thermalBus; diff --git a/src/main/java/edu/ie3/datamodel/models/input/system/LoadInput.java b/src/main/java/edu/ie3/datamodel/models/input/system/LoadInput.java index 9eea5c5ae..c1fe0014f 100644 --- a/src/main/java/edu/ie3/datamodel/models/input/system/LoadInput.java +++ b/src/main/java/edu/ie3/datamodel/models/input/system/LoadInput.java @@ -30,10 +30,13 @@ public class LoadInput extends SystemParticipantInput { * model */ private final LoadProfile loadProfile; + /** Annually consumed energy (typically in kWh) */ private final ComparableQuantity eConsAnnual; + /** Active Power (typically in kVA) */ private final ComparableQuantity sRated; + /** Rated power factor */ private final double cosPhiRated; diff --git a/src/main/java/edu/ie3/datamodel/models/input/system/PvInput.java b/src/main/java/edu/ie3/datamodel/models/input/system/PvInput.java index 2301adbe0..d3ddcc490 100644 --- a/src/main/java/edu/ie3/datamodel/models/input/system/PvInput.java +++ b/src/main/java/edu/ie3/datamodel/models/input/system/PvInput.java @@ -23,20 +23,28 @@ public class PvInput extends SystemParticipantInput { /** Albedo value (typically a value between 0 and 1) */ private final double albedo; + /** Inclination in a compass direction (typically °: South 0◦; West 90◦; East -90◦) */ private final ComparableQuantity azimuth; + /** Efficiency of converter (typically in %) */ private final ComparableQuantity etaConv; + /** Tilted inclination from horizontal (typically in °) */ private final ComparableQuantity elevationAngle; + /** Generator correction factor merging different technical influences */ private final double kG; + /** Temperature correction factor */ private final double kT; + /** Is this asset market oriented? */ private final boolean marketReaction; + /** Rated apparent power (typically in kVA) */ private final ComparableQuantity sRated; + /** Rated power factor */ private final double cosPhiRated; diff --git a/src/main/java/edu/ie3/datamodel/models/input/system/SystemParticipantInput.java b/src/main/java/edu/ie3/datamodel/models/input/system/SystemParticipantInput.java index 9f35346e2..f27e5053b 100644 --- a/src/main/java/edu/ie3/datamodel/models/input/system/SystemParticipantInput.java +++ b/src/main/java/edu/ie3/datamodel/models/input/system/SystemParticipantInput.java @@ -178,7 +178,9 @@ protected ReactivePowerCharacteristic getqCharacteristics() { return qCharacteristics; } - /** @return The {@link EmInput} controlling this system participant. CAN BE NULL. */ + /** + * @return The {@link EmInput} controlling this system participant. CAN BE NULL. + */ public EmInput getEm() { return em; } diff --git a/src/main/java/edu/ie3/datamodel/models/input/system/WecInput.java b/src/main/java/edu/ie3/datamodel/models/input/system/WecInput.java index 87f89ff77..099d4c9ce 100644 --- a/src/main/java/edu/ie3/datamodel/models/input/system/WecInput.java +++ b/src/main/java/edu/ie3/datamodel/models/input/system/WecInput.java @@ -20,6 +20,7 @@ public class WecInput extends SystemParticipantInput implements HasType { /** Type of this WEC, containing default values for WEC assets of this kind */ private final WecTypeInput type; + /** Is this asset market oriented? */ private final boolean marketReaction; diff --git a/src/main/java/edu/ie3/datamodel/models/input/system/characteristic/CharacteristicPoint.java b/src/main/java/edu/ie3/datamodel/models/input/system/characteristic/CharacteristicPoint.java index a2ddc8ed1..3cb2c4d06 100644 --- a/src/main/java/edu/ie3/datamodel/models/input/system/characteristic/CharacteristicPoint.java +++ b/src/main/java/edu/ie3/datamodel/models/input/system/characteristic/CharacteristicPoint.java @@ -85,12 +85,16 @@ private static String buildExceptionMessage(String input, String message) { return "Cannot parse " + input + " to CharacteristicCoordinate. " + message; } - /** @return the position on the abscissa */ + /** + * @return the position on the abscissa + */ public ComparableQuantity getX() { return x; } - /** @return the position on the ordinate */ + /** + * @return the position on the ordinate + */ public ComparableQuantity getY() { return y; } diff --git a/src/main/java/edu/ie3/datamodel/models/input/system/type/BmTypeInput.java b/src/main/java/edu/ie3/datamodel/models/input/system/type/BmTypeInput.java index 42857cf38..2f3b5b451 100644 --- a/src/main/java/edu/ie3/datamodel/models/input/system/type/BmTypeInput.java +++ b/src/main/java/edu/ie3/datamodel/models/input/system/type/BmTypeInput.java @@ -20,6 +20,7 @@ public class BmTypeInput extends SystemParticipantTypeInput { /** Permissible load gradient (typically in %/h) */ private final ComparableQuantity activePowerGradient; + /** Efficiency of converter for this type of BM (typically in %) */ private final ComparableQuantity etaConv; diff --git a/src/main/java/edu/ie3/datamodel/models/input/system/type/ChpTypeInput.java b/src/main/java/edu/ie3/datamodel/models/input/system/type/ChpTypeInput.java index 46f6456fc..7a67e08ff 100644 --- a/src/main/java/edu/ie3/datamodel/models/input/system/type/ChpTypeInput.java +++ b/src/main/java/edu/ie3/datamodel/models/input/system/type/ChpTypeInput.java @@ -18,10 +18,13 @@ public class ChpTypeInput extends SystemParticipantTypeInput { /** Electrical efficiency (typically in %) */ private final ComparableQuantity etaEl; + /** Thermal efficiency (typically in %) */ private final ComparableQuantity etaThermal; + /** Rated thermal power (typically in kW) */ private final ComparableQuantity pThermal; + /** Internal consumption (typically in kW) */ private final ComparableQuantity pOwn; diff --git a/src/main/java/edu/ie3/datamodel/models/input/system/type/EvTypeInput.java b/src/main/java/edu/ie3/datamodel/models/input/system/type/EvTypeInput.java index 335a3577f..0da3e0e63 100644 --- a/src/main/java/edu/ie3/datamodel/models/input/system/type/EvTypeInput.java +++ b/src/main/java/edu/ie3/datamodel/models/input/system/type/EvTypeInput.java @@ -19,8 +19,10 @@ public class EvTypeInput extends SystemParticipantTypeInput { /** Energy capacity of the storage (typically in kWh) */ private final ComparableQuantity eStorage; + /** Consumed electric energy per driven distance (typically in kWh/km) */ private final ComparableQuantity eCons; + /** power for DC (typically in kW) */ private final ComparableQuantity sRatedDC; diff --git a/src/main/java/edu/ie3/datamodel/models/input/system/type/StorageTypeInput.java b/src/main/java/edu/ie3/datamodel/models/input/system/type/StorageTypeInput.java index fea673886..664df15e1 100644 --- a/src/main/java/edu/ie3/datamodel/models/input/system/type/StorageTypeInput.java +++ b/src/main/java/edu/ie3/datamodel/models/input/system/type/StorageTypeInput.java @@ -21,10 +21,13 @@ public class StorageTypeInput extends SystemParticipantTypeInput { /** Energy capacity (typically in kWh) */ private final ComparableQuantity eStorage; + /** Maximum permissible active power (typically in kW) */ private final ComparableQuantity pMax; + /** Maximum permissible gradient of active power change (typically % / h) */ private final ComparableQuantity activePowerGradient; + /** Efficiency of the charging and discharging process (typically in %) */ private final ComparableQuantity eta; diff --git a/src/main/java/edu/ie3/datamodel/models/input/system/type/SystemParticipantTypeInput.java b/src/main/java/edu/ie3/datamodel/models/input/system/type/SystemParticipantTypeInput.java index c287c55ab..66c3ebba5 100644 --- a/src/main/java/edu/ie3/datamodel/models/input/system/type/SystemParticipantTypeInput.java +++ b/src/main/java/edu/ie3/datamodel/models/input/system/type/SystemParticipantTypeInput.java @@ -17,10 +17,13 @@ public abstract class SystemParticipantTypeInput extends AssetTypeInput { /** Capital expense for this type of system participant (typically in €) */ private final ComparableQuantity capex; + /** Operating expense for this type of system participant (typically in €/MWh) */ private final ComparableQuantity opex; + /** Rated apparent power of the type (in kVA) */ private final ComparableQuantity sRated; + /** Power factor for this type of system participant */ private final double cosPhiRated; diff --git a/src/main/java/edu/ie3/datamodel/models/input/system/type/WecTypeInput.java b/src/main/java/edu/ie3/datamodel/models/input/system/type/WecTypeInput.java index 219525eaf..6758d03c9 100644 --- a/src/main/java/edu/ie3/datamodel/models/input/system/type/WecTypeInput.java +++ b/src/main/java/edu/ie3/datamodel/models/input/system/type/WecTypeInput.java @@ -21,10 +21,13 @@ public class WecTypeInput extends SystemParticipantTypeInput { /** Betz curve of this type */ private final WecCharacteristicInput cpCharacteristic; + /** Efficiency of converter for this type of WEC (typically in %) */ private final ComparableQuantity etaConv; + /** Swept Area of blades for this type of WEC (typically in m²) */ private final ComparableQuantity rotorArea; + /** Height from ground to center of rotor for this type of WEC (typically in m) */ private final ComparableQuantity hubHeight; diff --git a/src/main/java/edu/ie3/datamodel/models/input/thermal/AbstractStorageInput.java b/src/main/java/edu/ie3/datamodel/models/input/thermal/AbstractStorageInput.java index a7d495c45..9c1c1eea0 100644 --- a/src/main/java/edu/ie3/datamodel/models/input/thermal/AbstractStorageInput.java +++ b/src/main/java/edu/ie3/datamodel/models/input/thermal/AbstractStorageInput.java @@ -20,12 +20,16 @@ public abstract class AbstractStorageInput extends ThermalStorageInput { /** Available storage volume (typically in m³) */ private final ComparableQuantity storageVolumeLvl; + /** Temperature of the inlet (typically in C) */ private final ComparableQuantity inletTemp; + /** Temperature of the outlet (typically in C) */ private final ComparableQuantity returnTemp; + /** Specific heat capacity of the storage medium (typically in kWh/K*m³) */ private final ComparableQuantity c; + /** Maximum permissible thermal power (typically in kW) */ private final ComparableQuantity pThermalMax; diff --git a/src/main/java/edu/ie3/datamodel/models/input/thermal/ThermalHouseInput.java b/src/main/java/edu/ie3/datamodel/models/input/thermal/ThermalHouseInput.java index 33ff8be74..d119a42c2 100644 --- a/src/main/java/edu/ie3/datamodel/models/input/thermal/ThermalHouseInput.java +++ b/src/main/java/edu/ie3/datamodel/models/input/thermal/ThermalHouseInput.java @@ -19,16 +19,22 @@ public class ThermalHouseInput extends ThermalSinkInput { /** Thermal, transitional losses of the included thermal house model (typically in kW/K) */ private final ComparableQuantity ethLosses; + /** Thermal capacity of the included thermal house model (typically in kWh/K) */ private final ComparableQuantity ethCapa; + /** Desired target temperature of the thermal house model (typically in °C) */ private final ComparableQuantity targetTemperature; + /** Upper boundary temperature of the thermal house model (typically in °C) */ private final ComparableQuantity upperTemperatureLimit; + /** Lower boundary temperature of the thermal house model (typically in °C) */ private final ComparableQuantity lowerTemperatureLimit; + /** Type of the building, e.g. house or flat */ private final String housingType; + /** Number of people living in the building, double to allow proper scaling */ private final double numberInhabitants; diff --git a/src/main/java/edu/ie3/datamodel/models/profile/LoadProfile.java b/src/main/java/edu/ie3/datamodel/models/profile/LoadProfile.java index c68ba3435..116d3389e 100644 --- a/src/main/java/edu/ie3/datamodel/models/profile/LoadProfile.java +++ b/src/main/java/edu/ie3/datamodel/models/profile/LoadProfile.java @@ -12,7 +12,9 @@ import java.util.stream.Stream; public interface LoadProfile extends Serializable { - /** @return The identifying String */ + /** + * @return The identifying String + */ String getKey(); /** diff --git a/src/main/java/edu/ie3/datamodel/models/result/CongestionResult.java b/src/main/java/edu/ie3/datamodel/models/result/CongestionResult.java index cada19c7f..a083ef22f 100644 --- a/src/main/java/edu/ie3/datamodel/models/result/CongestionResult.java +++ b/src/main/java/edu/ie3/datamodel/models/result/CongestionResult.java @@ -124,8 +124,8 @@ public static InputModelType parse(String inputModelType) throws ParsingExceptio case "line" -> LINE; case "transformer_2w" -> TRANSFORMER_2W; case "transformer_3w" -> TRANSFORMER_3W; - default -> throw new ParsingException( - "InputModelType '" + inputModelType + "' cannot be parsed!"); + default -> + throw new ParsingException("InputModelType '" + inputModelType + "' cannot be parsed!"); }; } } diff --git a/src/main/java/edu/ie3/datamodel/models/result/ResultEntity.java b/src/main/java/edu/ie3/datamodel/models/result/ResultEntity.java index 0d8b229bf..f1ba351d7 100644 --- a/src/main/java/edu/ie3/datamodel/models/result/ResultEntity.java +++ b/src/main/java/edu/ie3/datamodel/models/result/ResultEntity.java @@ -15,6 +15,7 @@ public abstract class ResultEntity implements Entity { /** date and time of the produced result */ private ZonedDateTime time; + /** uuid of the input model that produces the result */ private UUID inputModel; diff --git a/src/main/java/edu/ie3/datamodel/models/value/EnergyPriceValue.java b/src/main/java/edu/ie3/datamodel/models/value/EnergyPriceValue.java index f9bb64371..3cf8dafd8 100644 --- a/src/main/java/edu/ie3/datamodel/models/value/EnergyPriceValue.java +++ b/src/main/java/edu/ie3/datamodel/models/value/EnergyPriceValue.java @@ -16,7 +16,9 @@ public class EnergyPriceValue implements Value { /** Price of energy (typically in €/MWh) */ private final ComparableQuantity price; - /** @param price per MWh */ + /** + * @param price per MWh + */ public EnergyPriceValue(ComparableQuantity price) { this.price = price == null ? null : price.to(StandardUnits.ENERGY_PRICE); } diff --git a/src/main/java/edu/ie3/datamodel/models/value/PValue.java b/src/main/java/edu/ie3/datamodel/models/value/PValue.java index 61b770588..978265907 100644 --- a/src/main/java/edu/ie3/datamodel/models/value/PValue.java +++ b/src/main/java/edu/ie3/datamodel/models/value/PValue.java @@ -17,7 +17,9 @@ public class PValue implements Value { /** Active power */ private final ComparableQuantity p; - /** @param p Active power */ + /** + * @param p Active power + */ public PValue(ComparableQuantity p) { this.p = p == null ? null : p.to(StandardUnits.ACTIVE_POWER_IN); } diff --git a/src/main/java/edu/ie3/datamodel/models/value/SolarIrradianceValue.java b/src/main/java/edu/ie3/datamodel/models/value/SolarIrradianceValue.java index 361234173..45ee1a05a 100644 --- a/src/main/java/edu/ie3/datamodel/models/value/SolarIrradianceValue.java +++ b/src/main/java/edu/ie3/datamodel/models/value/SolarIrradianceValue.java @@ -15,6 +15,7 @@ public class SolarIrradianceValue implements Value { /** Direct sun irradiance (typically in W/m²) */ private final ComparableQuantity directIrradiance; + /** Diffuse sun irradiance (typically in W/m²) */ private final ComparableQuantity diffuseIrradiance; diff --git a/src/main/java/edu/ie3/datamodel/models/value/TemperatureValue.java b/src/main/java/edu/ie3/datamodel/models/value/TemperatureValue.java index cdd532bd4..6c3a052ae 100644 --- a/src/main/java/edu/ie3/datamodel/models/value/TemperatureValue.java +++ b/src/main/java/edu/ie3/datamodel/models/value/TemperatureValue.java @@ -16,7 +16,9 @@ public class TemperatureValue implements Value { /** Temperature (typically in K) */ private final ComparableQuantity temperature; - /** @param temperature (typically in K) */ + /** + * @param temperature (typically in K) + */ public TemperatureValue(ComparableQuantity temperature) { this.temperature = temperature == null ? null : temperature.to(StandardUnits.TEMPERATURE); } diff --git a/src/main/java/edu/ie3/datamodel/models/value/VoltageValue.java b/src/main/java/edu/ie3/datamodel/models/value/VoltageValue.java index d66420756..0f8cafb7e 100644 --- a/src/main/java/edu/ie3/datamodel/models/value/VoltageValue.java +++ b/src/main/java/edu/ie3/datamodel/models/value/VoltageValue.java @@ -22,6 +22,7 @@ public class VoltageValue implements Value { /** Magnitude of the voltage in p.u. */ private final ComparableQuantity magnitude; + /** Angle of the voltage in degree */ private final ComparableQuantity angle; diff --git a/src/main/java/edu/ie3/datamodel/models/value/WeatherValue.java b/src/main/java/edu/ie3/datamodel/models/value/WeatherValue.java index 09ec1787f..e34bfcc63 100644 --- a/src/main/java/edu/ie3/datamodel/models/value/WeatherValue.java +++ b/src/main/java/edu/ie3/datamodel/models/value/WeatherValue.java @@ -17,11 +17,13 @@ public class WeatherValue implements Value { /** The coordinate of this weather value set */ private final Point coordinate; + /** solar irradiance values for this coordinate */ private final SolarIrradianceValue solarIrradiance; /** Temperature value for this coordinate */ private final TemperatureValue temperature; + /** Wind values for this coordinate */ private final WindValue wind; diff --git a/src/main/java/edu/ie3/datamodel/models/value/WindValue.java b/src/main/java/edu/ie3/datamodel/models/value/WindValue.java index ec40890ce..a27839cb5 100644 --- a/src/main/java/edu/ie3/datamodel/models/value/WindValue.java +++ b/src/main/java/edu/ie3/datamodel/models/value/WindValue.java @@ -16,6 +16,7 @@ public class WindValue implements Value { /** Wind direction as an angle from north (typically in rad) */ private final ComparableQuantity direction; + /** Wind velocity (typically in m/s) */ private final ComparableQuantity velocity; diff --git a/src/main/java/edu/ie3/datamodel/models/value/load/BdewLoadValues.java b/src/main/java/edu/ie3/datamodel/models/value/load/BdewLoadValues.java index 953ce1556..bd6f5bb73 100644 --- a/src/main/java/edu/ie3/datamodel/models/value/load/BdewLoadValues.java +++ b/src/main/java/edu/ie3/datamodel/models/value/load/BdewLoadValues.java @@ -83,14 +83,16 @@ public double getMaxValue(boolean lastDayOfYear) { if (lastDayOfYear) { Stream keys = switch (scheme) { - case BDEW1999 -> Stream.of( - new Bdew1999Key(WINTER, DayType.SATURDAY), - new Bdew1999Key(WINTER, DayType.SUNDAY), - new Bdew1999Key(WINTER, DayType.WEEKDAY)); - case BDEW2025 -> Stream.of( - new Bdew2025Key(DECEMBER, DayType.SATURDAY), - new Bdew2025Key(DECEMBER, DayType.SUNDAY), - new Bdew2025Key(DECEMBER, DayType.WEEKDAY)); + case BDEW1999 -> + Stream.of( + new Bdew1999Key(WINTER, DayType.SATURDAY), + new Bdew1999Key(WINTER, DayType.SUNDAY), + new Bdew1999Key(WINTER, DayType.WEEKDAY)); + case BDEW2025 -> + Stream.of( + new Bdew2025Key(DECEMBER, DayType.SATURDAY), + new Bdew2025Key(DECEMBER, DayType.SUNDAY), + new Bdew2025Key(DECEMBER, DayType.WEEKDAY)); }; stream = keys.map(values::get); @@ -106,8 +108,8 @@ public PValue getValue(ZonedDateTime time, BdewStandardLoadProfile loadProfile) double power = switch (loadProfile) { case H0, H25, P25, S25 -> - /* For the residential average profile, a dynamization has to be taken into account */ - dynamization(getPower(time), time.getDayOfYear()); // leap years are ignored + /* For the residential average profile, a dynamization has to be taken into account */ + dynamization(getPower(time), time.getDayOfYear()); // leap years are ignored default -> getPower(time); }; @@ -263,10 +265,11 @@ public static BdewSeason parse(String key) throws ParsingException { case "Wi", "Winter" -> WINTER; case "Su", "Summer" -> SUMMER; case "Tr", "Intermediate" -> TRANSITION; - default -> throw new ParsingException( - "There is no season for key:" - + key - + ". Permissible keys: 'Wi', 'Winter', 'Su', 'Summer', 'Tr', 'Intermediate'"); + default -> + throw new ParsingException( + "There is no season for key:" + + key + + ". Permissible keys: 'Wi', 'Winter', 'Su', 'Summer', 'Tr', 'Intermediate'"); }; } diff --git a/src/main/java/edu/ie3/datamodel/utils/validation/ThermalValidationUtils.java b/src/main/java/edu/ie3/datamodel/utils/validation/ThermalValidationUtils.java index 72ddf489f..6b76b1fac 100644 --- a/src/main/java/edu/ie3/datamodel/utils/validation/ThermalValidationUtils.java +++ b/src/main/java/edu/ie3/datamodel/utils/validation/ThermalValidationUtils.java @@ -298,6 +298,7 @@ private static List> checkCylindricalStorage( return exceptions; } + /** * Validates a domcesticHotWaterStorageInput if: * diff --git a/src/main/java/edu/ie3/datamodel/utils/validation/ValidationUtils.java b/src/main/java/edu/ie3/datamodel/utils/validation/ValidationUtils.java index 80006953b..28c2eee2a 100644 --- a/src/main/java/edu/ie3/datamodel/utils/validation/ValidationUtils.java +++ b/src/main/java/edu/ie3/datamodel/utils/validation/ValidationUtils.java @@ -264,6 +264,7 @@ protected static void detectZeroOrNegativeQuantities( detectMalformedQuantities( quantities, entity, predicate, "The following quantities have to be positive"); } + /** * Goes through the provided quantities and reports those, that have positive value via * From 3ae13d10454047705556263c2f73f4e1f8d92bcb Mon Sep 17 00:00:00 2001 From: danielfeismann Date: Mon, 4 Aug 2025 16:37:46 +0200 Subject: [PATCH 2/2] fix changelog --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index eeadae06d..31e881e88 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -14,7 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Changed - Updated CI-Pipeline to run task `Deploy` and `Staging` only for `Main` [#1403](https://github.com/ie3-institute/PowerSystemDataModel/issues/1403) -- Change spotless to use googleJavaFormat('1.28.0') [#1408](https://github.com/ie3-institute/PowerSystemDataModel/issues/1408) +- Change spotless to use googleJavaFormat('1.28.0') [#1409](https://github.com/ie3-institute/PowerSystemDataModel/issues/1409) ## [8.1.0] - 2025-07-25