Added abstraction for power value sources. #1439
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| /* | ||
| * © 2025. TU Dortmund University, | ||
| * Institute of Energy Systems, Energy Efficiency and Energy Economics, | ||
| * Research group Distribution grid planning and operation | ||
| */ | ||
| package edu.ie3.datamodel.io.source; | ||
|
|
||
| import edu.ie3.datamodel.models.profile.LoadProfile; | ||
| import edu.ie3.datamodel.models.profile.PowerProfile; | ||
| import edu.ie3.datamodel.models.value.PValue; | ||
| import java.time.ZonedDateTime; | ||
| import java.util.Optional; | ||
| import java.util.function.Supplier; | ||
| import javax.measure.quantity.Energy; | ||
| import javax.measure.quantity.Power; | ||
| import tech.units.indriya.ComparableQuantity; | ||
|
|
||
| /** Interface defining base functionality for power value sources. */ | ||
| public sealed interface PowerValueSource< | ||
| P extends PowerProfile, ID extends PowerValueSource.InputData> | ||
|
Check notice on line 20 in src/main/java/edu/ie3/datamodel/io/source/PowerValueSource.java
|
||
|
There was a problem hiding this comment. Please check out the sonarqube issue |
||
| permits PowerValueSource.MarkovBased, PowerValueSource.TimeSeriesBased { | ||
|
|
||
| /** Returns the profile of this source. */ | ||
| P getProfile(); | ||
|
|
||
| /** | ||
| * Method to get the next power value based on the provided input data. | ||
| * | ||
| * @param data input data that is used to calculate the next power value. | ||
| * @return an option for the power value. | ||
| */ | ||
| Optional<PValue> getValue(ID data); | ||
|
Comment on lines
+26
to
+32
There was a problem hiding this comment. I think this method now becomes obsolete with the addition of |
||
|
|
||
| /** | ||
| * Method to get a supplier for the next power value based on the provided input data. Depending | ||
| * on the implementation the supplier will either always return the same value or each time a | ||
| * random value. To return one constant value please use {@link #getValue(InputData)}. | ||
| * | ||
| * @param data input data that is used to calculate the next power value. | ||
| * @return A supplier for an option on the value at the given time step. | ||
| */ | ||
| Supplier<Optional<PValue>> getValueSupplier(ID data); | ||
|
|
||
| /** | ||
| * Method to determine the next timestamp for which data is present. | ||
| * | ||
| * @param time current time | ||
| * @return an option for the next timestamp or {@link Optional#empty()} if no timestamp was found. | ||
| */ | ||
| Optional<ZonedDateTime> getNextTimeKey(ZonedDateTime time); | ||
|
|
||
| /** Returns the maximal power that can be returned by this source. */ | ||
| Optional<ComparableQuantity<Power>> getMaxPower(); | ||
|
|
||
| /** Returns the energy scaling of this power source. */ | ||
| Optional<ComparableQuantity<Energy>> getProfileEnergyScaling(); | ||
|
|
||
| // -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= | ||
| // non-sealed implementations | ||
|
|
||
| /** Interface for time-series-based power value sources. */ | ||
| non-sealed interface TimeSeriesBased | ||
| extends PowerValueSource<LoadProfile, TimeSeriesInputValue> {} | ||
|
|
||
| /** Interface for markov-chain-based power value sources. */ | ||
| non-sealed interface MarkovBased extends PowerValueSource<PowerProfile, InputData> {} | ||
|
|
||
| // -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= | ||
| // input data | ||
|
|
||
| /** | ||
| * Interface for the input data of {@link #getValue(InputData)}. The data is used to determine the | ||
| * next power. | ||
| */ | ||
| sealed interface InputData permits PowerValueSource.TimeSeriesInputValue { | ||
|
There was a problem hiding this comment. Maybe we can think about a different name for the interface here. |
||
| /** Returns the timestamp for which a power value is needed. */ | ||
| ZonedDateTime getTime(); | ||
| } | ||
|
|
||
| /** | ||
| * Input data for time-series-based power value sources. | ||
| * | ||
| * @param time | ||
| */ | ||
| record TimeSeriesInputValue(ZonedDateTime time) implements InputData { | ||
| @Override | ||
| public ZonedDateTime getTime() { | ||
| return time; | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wouldn't do this, especially because the equals method still relies on the super class