Package energy.trolie.client.model.ratingproposals

Interface ForecastPeriodBuilder

All Superinterfaces:

RatingBuilder

public interface ForecastPeriodBuilder
extends RatingBuilder

Rating value builder for specific forecast periods, emitting ForecastRatingPeriods. Intended to be used in concert with ForecastRatingProposalUpdate.

Method Summary

Modifier and Type	Method	Description
void	setPeriod(int periodIndex)	Convenience method to set the period as an offset from the forecast window begin.
void	setPeriodEnd(Instant periodEnd)	Sets an absolute period end.
void	setPeriodStart(Instant periodStart)	Sets an absolute period start.

Methods inherited from interface energy.trolie.client.model.ratingproposals.RatingBuilder

addUsedInput, complete, setContinuousAmps, setContinuousMVA, setContinuousMWandPF, setEmergencyAmps, setEmergencyMVA, setEmergencyMWandPF

Method Details

setPeriod

void setPeriod(int periodIndex)

Convenience method to set the period as an offset from the forecast window begin. For example, assume the typical convention of hour-long periods. If the forecast window were to begin at 2025-07-12T00:00-07:00, then period 0 would start at 2025-07-12T00:00-07:00, period 1 would start at 2025-07-12T01:00-07:00, and so on.

Use of this method supersedes, and is assumed to be mutually exclusive with any invocations of setPeriodStart(Instant) and setPeriodEnd(Instant)

Parameters:

periodIndex - 0-based index of the period number within the snapshot. Uses the client configuration to determine the length of the period

setPeriodStart

void setPeriodStart(Instant periodStart)

Sets an absolute period start.

Parameters:

periodStart - new period start value

setPeriodEnd

void setPeriodEnd(Instant periodEnd)

Sets an absolute period end. If not used, assumes the default as configured through TrolieClientBuilder.periodLength(int)

Parameters:

periodEnd - absolute period end.