Package net.solarnetwork.node.domain.datum

Interface EnergyStorageDatum

All Superinterfaces:
Cloneable, net.solarnetwork.domain.datum.Datum, net.solarnetwork.domain.datum.EnergyStorageDatum, net.solarnetwork.domain.datum.MutableDatum, MutableNodeDatum, NodeDatum
All Known Implementing Classes:
SimpleEnergyStorageDatum
public interface EnergyStorageDatum extends net.solarnetwork.domain.datum.EnergyStorageDatum, MutableNodeDatum
Standardized API for energy storage system related datum to implement.
Version:
1.1
Author:
matt

  • Field Summary

    Fields inherited from interface net.solarnetwork.domain.datum.Datum

    DATUM_TYPE_PROPERTY, DATUM_TYPES_PROPERTY, OP_STATE, OP_STATES, REVERSE_ACCUMULATING_SUFFIX_KEY, SOURCE_ID, TIMESTAMP

    Fields inherited from interface net.solarnetwork.domain.datum.EnergyStorageDatum

    AVAILABLE_WATT_HOURS_KEY, CAPACITY_WATT_HOURS_KEY, PERCENTAGE_KEY, STATE_OF_CHARGE_PERCENTAGE_KEY, STATE_OF_HEALTH_PERCENTAGE_KEY

    Fields inherited from interface net.solarnetwork.node.domain.datum.NodeDatum

    TIMESTAMP_UPLOAD

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    getEnergyCapacity(Long value)
    Set the energy capacity of the storage system, in Wh.
    default void
    getStateOfHealthPercentage(Float value)
    Set a percentage of storage "health" in terms of practical total capacity right now versus theoretical total capacity when the storage was manufactured.
    default void
    setAvailableEnergy(Long value)
    Get the available energy of the storage system, in Wh.
    default void
    setAvailableEnergyPercentage(Float value)
    Set the percentage of energy capacity available in the storage.

    Methods inherited from interface net.solarnetwork.domain.datum.Datum

    asSampleOperations, asSimpleMap, getKind, getObjectId, getSampleData, getSourceId, getTimestamp

    Methods inherited from interface net.solarnetwork.domain.datum.EnergyStorageDatum

    getAvailableEnergy, getAvailableEnergyPercentage, getEnergyCapacity, getStateOfHealthPercentage

    Methods inherited from interface net.solarnetwork.domain.datum.MutableDatum

    asMutableSampleOperations

    Methods inherited from interface net.solarnetwork.node.domain.datum.MutableNodeDatum

    clone

    Methods inherited from interface net.solarnetwork.node.domain.datum.NodeDatum

    copyWithId, copyWithSamples, getUploaded

  • Method Details

    • setAvailableEnergyPercentage

      default void setAvailableEnergyPercentage(Float value)
      Set the percentage of energy capacity available in the storage.
      Parameters:
      value - the available energy as a percentage of the total capacity of the storage

    • getStateOfHealthPercentage

      default void getStateOfHealthPercentage(Float value)
      Set a percentage of storage "health" in terms of practical total capacity right now versus theoretical total capacity when the storage was manufactured.
      Parameters:
      value - the total energy capacity now as a percentage of the theoretical total capacity of the storage when manufactured
      Since:
      1.1

    • setAvailableEnergy

      default void setAvailableEnergy(Long value)
      Get the available energy of the storage system, in Wh.
      Parameters:
      value - the available energy of the storage

    • getEnergyCapacity

      default void getEnergyCapacity(Long value)
      Set the energy capacity of the storage system, in Wh.
      Parameters:
      value - the energy capacity of the storage
      Since:
      2.1