Package net.solarnetwork.domain.datum

Interface DcEnergyDatum

All Superinterfaces:

Datum, EnergyDatum

All Known Subinterfaces:

AcDcEnergyDatum

public interface DcEnergyDatum
extends EnergyDatum

Standardized API for direct current related energy datum to implement.

Since:

2.0

Version:

1.1

Author:

matt

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DC_CURRENT_KEY	The instantaneous sample key for getDcCurrent() values.
static final String	DC_POWER_KEY	The instantaneous sample key for getDcPower() values.
static final String	DC_VOLTAGE_KEY	The instantaneous sample key for getDcVoltage() values.

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.EnergyDatum

TAG_CONSUMPTION, TAG_GENERATION, WATT_HOUR_READING_KEY, WATTS_KEY

Method Summary

Modifier and Type	Method	Description
default Float	getDcCurrent()	Get the instantaneous DC current, in amperes.
default Integer	getDcPower()	Get the instantaneous DC power output, in watts.
default Float	getDcVoltage()	Get the instantaneous DC voltage output, in volts.

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

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

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

getReverseWattHourReading, getWattHourReading, getWatts, isConsumption, isGeneration

Field Details

DC_CURRENT_KEY

static final String DC_CURRENT_KEY

The instantaneous sample key for getDcCurrent() values.

See Also:

• Constant Field Values

DC_POWER_KEY

static final String DC_POWER_KEY

The instantaneous sample key for getDcPower() values.

See Also:

• Constant Field Values

DC_VOLTAGE_KEY

static final String DC_VOLTAGE_KEY

The instantaneous sample key for getDcVoltage() values.

See Also:

• Constant Field Values

Method Details

getDcCurrent

default Float getDcCurrent()

Get the instantaneous DC current, in amperes.

Returns:

current, or null if not available

Since:

1.1

getDcPower

default Integer getDcPower()

Get the instantaneous DC power output, in watts.

Returns:

watts, or null if not available

getDcVoltage

default Float getDcVoltage()

Get the instantaneous DC voltage output, in volts.

Returns:

DC voltage, or null if not available