Package edu.ie3.datamodel.models.voltagelevels

Class CommonVoltageLevel

java.lang.Object
edu.ie3.datamodel.models.voltagelevels.VoltageLevel
edu.ie3.datamodel.models.voltagelevels.CommonVoltageLevel
All Implemented Interfaces:
Serializable
public class CommonVoltageLevel extends VoltageLevel
Class with extended information to describe common voltage levels in energy systems.
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final edu.ie3.util.interval.RightOpenInterval<tech.units.indriya.ComparableQuantity<javax.measure.quantity.ElectricPotential>>
    voltageRange
     

    Fields inherited from class edu.ie3.datamodel.models.voltagelevels.VoltageLevel

    id, nominalVoltage

  • Constructor Summary

    Constructors
    Constructor
    Description
    CommonVoltageLevel(String id, tech.units.indriya.ComparableQuantity<javax.measure.quantity.ElectricPotential> nominalVoltage, Set<String> synonymousIds, edu.ie3.util.interval.RightOpenInterval<tech.units.indriya.ComparableQuantity<javax.measure.quantity.ElectricPotential>> voltageRange)
    Constructs a concrete voltage level

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    covers(String id, tech.units.indriya.ComparableQuantity<javax.measure.quantity.ElectricPotential> vRated)
    Checks, whether the given tuple of identifier and rated voltage is covered
    boolean
    covers(tech.units.indriya.ComparableQuantity<javax.measure.quantity.ElectricPotential> vRated)
    Checks, whether the given rated voltage is covered
    String
    toString()
     

    Methods inherited from class edu.ie3.datamodel.models.voltagelevels.VoltageLevel

    getId, getNominalVoltage

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Field Details

    • voltageRange

      protected final edu.ie3.util.interval.RightOpenInterval<tech.units.indriya.ComparableQuantity<javax.measure.quantity.ElectricPotential>> voltageRange

  • Constructor Details

    • CommonVoltageLevel

      public CommonVoltageLevel(String id, tech.units.indriya.ComparableQuantity<javax.measure.quantity.ElectricPotential> nominalVoltage, Set<String> synonymousIds, edu.ie3.util.interval.RightOpenInterval<tech.units.indriya.ComparableQuantity<javax.measure.quantity.ElectricPotential>> voltageRange)
      Constructs a concrete voltage level
      Parameters:
      id - Identifier
      nominalVoltage - nominal voltage of the voltage level
      synonymousIds - Synonymously used identifiers
      voltageRange - Range of nominal voltage that is covered by this common voltage level

  • Method Details

    • covers

      public boolean covers(tech.units.indriya.ComparableQuantity<javax.measure.quantity.ElectricPotential> vRated)
      Checks, whether the given rated voltage is covered
      Parameters:
      vRated - Rated voltage of a node to test
      Returns:
      true, if it is covered

    • covers

      public boolean covers(String id, tech.units.indriya.ComparableQuantity<javax.measure.quantity.ElectricPotential> vRated) throws VoltageLevelException
      Checks, whether the given tuple of identifier and rated voltage is covered
      Parameters:
      id - Identifier
      vRated - Rated voltage of a node to test
      Returns:
      true, if it is covered
      Throws:
      VoltageLevelException - If the input is ambiguous

    • toString

      public String toString()
      Overrides:
      toString in class VoltageLevel