Package energy.trolie.client.model.ratingproposals

Interface RatingBuilder

All Known Subinterfaces:
ForecastPeriodBuilder
public interface RatingBuilder

A rating value builder that respects business rules and conventions configured with the client. Emits rating DTOs that may be passed to send proposals.

These are always used in concert with a StreamingUpdate. They are created by the update instance, and the call to complete() commits them back to the stream

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addUsedInput(InputValue input)
    Adds an input value used to compute this rating.
    void
    complete()
    Completes adding the rating to the proposal update.
    void
    setContinuousAmps(float amps)
    Sets the continuous rating in Amps
    void
    setContinuousMVA(float mva)
    Sets the continuous rating in MVA
    void
    setContinuousMWandPF(float mw, float pf)
    Sets the continuous rating in a MW and Power Factor combination
    void
    setEmergencyAmps(String durationName, float amps)
    Sets the rating value in Amps for a particular emergency duration.
    void
    setEmergencyMVA(String durationName, float mva)
    Sets the rating value in MVA for a particular emergency duration.
    void
    setEmergencyMWandPF(String durationName, float mw, float pf)
    Sets the rating value using a MW value and assumed power factor for a given emergency duration.

  • Method Details

    • setContinuousMVA

      void setContinuousMVA(float mva)
      Sets the continuous rating in MVA
      Parameters:
      mva - value for max apparent power

    • setContinuousAmps

      void setContinuousAmps(float amps)
      Sets the continuous rating in Amps
      Parameters:
      amps - value for max current

    • setContinuousMWandPF

      void setContinuousMWandPF(float mw, float pf)
      Sets the continuous rating in a MW and Power Factor combination
      Parameters:
      mw - value for max active power
      pf - value for assumed power factor

    • setEmergencyMVA

      void setEmergencyMVA(String durationName, float mva)
      Sets the rating value in MVA for a particular emergency duration.
      Parameters:
      durationName - duration name to use. This method assumes a duration name is predefined in the proposal header.
      mva - value for max apparent power

    • setEmergencyAmps

      void setEmergencyAmps(String durationName, float amps)
      Sets the rating value in Amps for a particular emergency duration.
      Parameters:
      durationName - duration name to use. This method assumes a duration name is predefined in the proposal header.
      amps - value for max current

    • setEmergencyMWandPF

      void setEmergencyMWandPF(String durationName, float mw, float pf)
      Sets the rating value using a MW value and assumed power factor for a given emergency duration.
      Parameters:
      durationName - duration name to use. This method assumes a duration name is predefined in the proposal header.
      mw - value for max active power
      pf - value for assumed power factor

    • addUsedInput

      void addUsedInput(InputValue input)
      Adds an input value used to compute this rating. Most TROLIE server implementations don't require this, but it may be stored in some cases for transparency purposes.
      Parameters:
      input - filled in input value

    • complete

      void complete()
      Completes adding the rating to the proposal update.