Package edu.ie3.datamodel.models.timeseries.repetitive

Class RepetitiveTimeSeries<E extends TimeSeriesEntry<V>,V extends Value>

java.lang.Object

edu.ie3.datamodel.models.UniqueEntity

edu.ie3.datamodel.models.timeseries.TimeSeries<E,V>

edu.ie3.datamodel.models.timeseries.repetitive.RepetitiveTimeSeries<E,V>

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

LoadProfileInput

public abstract class RepetitiveTimeSeries<E extends TimeSeriesEntry<V>,V extends Value>
extends TimeSeries<E,V>

Describes a TimeSeries with repetitive values that can be calculated from a pattern

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class edu.ie3.datamodel.models.UniqueEntity

UniqueEntity.UniqueEntityBuilder, UniqueEntity.UniqueEntityCopyBuilder<T extends UniqueEntity.UniqueEntityBuilder>

Field Summary

Fields inherited from class edu.ie3.datamodel.models.UniqueEntity

UUID_FIELD_NAME

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RepetitiveTimeSeries(Set<E> entries)
protected	RepetitiveTimeSeries(UUID uuid, Set<E> entries)

Method Summary

Modifier and Type	Method	Description
protected abstract V	calc(ZonedDateTime time)	Calculate the value at the given time step based on a pattern
Optional<V>	getValue(ZonedDateTime time)	If you prefer to keep the time with the value, please use TimeSeries.getTimeBasedValue(java.time.ZonedDateTime) instead

Methods inherited from class edu.ie3.datamodel.models.timeseries.TimeSeries

equals, getEntries, getNextDateTime, getNextTimeBasedValue, getPreviousDateTime, getPreviousTimeBasedValue, getTimeBasedValue, hashCode, toString

Methods inherited from class edu.ie3.datamodel.models.UniqueEntity

getUuid

Methods inherited from class java.lang.Object

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

Constructor Details

RepetitiveTimeSeries

protected RepetitiveTimeSeries(Set<E> entries)

RepetitiveTimeSeries

protected RepetitiveTimeSeries(UUID uuid,
 Set<E> entries)

Method Details

calc

protected abstract V calc(ZonedDateTime time)

Calculate the value at the given time step based on a pattern

Parameters:

time - Questioned time

Returns:

The value for the queried time

getValue

public Optional<V> getValue(ZonedDateTime time)

Description copied from class: TimeSeries

If you prefer to keep the time with the value, please use TimeSeries.getTimeBasedValue(java.time.ZonedDateTime) instead

Specified by:

getValue in class TimeSeries<E extends TimeSeriesEntry<V>,V extends Value>

Parameters:

time - Queried time

Returns:

An option on the raw value at the given time step