Package io.openems.edge.predictor.api.prediction

Class AbstractPredictor

java.lang.Object

io.openems.edge.common.component.AbstractOpenemsComponent

io.openems.edge.predictor.api.prediction.AbstractPredictor

All Implemented Interfaces:

OpenemsComponent, Predictor

Direct Known Subclasses:

DummyPredictor, PredictorPersistenceModelImpl, PredictorSimilardayModelImpl

public abstract class AbstractPredictor
extends AbstractOpenemsComponent
implements Predictor, OpenemsComponent

Nested Class Summary

Nested classes/interfaces inherited from interface io.openems.edge.common.component.OpenemsComponent

OpenemsComponent.ChannelId

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractPredictor(ChannelId[] firstInitialChannelIds, ChannelId[]... furtherInitialChannelIds)

Method Summary

Modifier and Type	Method	Description
protected final void	activate(org.osgi.service.component.ComponentContext context, String id, String alias, boolean enabled)	Handles @Activate of implementations.
protected void	activate(org.osgi.service.component.ComponentContext context, String id, String alias, boolean enabled, String[] channelAddresses, LogVerbosity logVerbosity)
protected abstract Prediction	createNewPrediction(ChannelAddress channelAddress)
ChannelAddress[]	getChannelAddresses()	Gets the Channel-Addresses for which this Predictor can provide a prediction.
protected abstract ClockProvider	getClockProvider()
Prediction	getPrediction(ChannelAddress channelAddress)	Gets a Prediction for the given ChannelAddress.

Methods inherited from class io.openems.edge.common.component.AbstractOpenemsComponent

_channel, activate, addChannel, addChannels, addChannels, alias, channels, deactivate, getComponentContext, id, isEnabled, logDebug, logError, logInfo, logWarn, modified, removeChannel

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.openems.edge.common.component.OpenemsComponent

_channel, _getChannelAs, alias, channel, channel, channels, debugLog, getComponentContext, getState, getStateChannel, hasFaults, id, isEnabled, serviceFactoryPid, servicePid

Constructor Details

AbstractPredictor

protected AbstractPredictor(ChannelId[] firstInitialChannelIds,
 ChannelId[]... furtherInitialChannelIds)

Method Details

getClockProvider

protected abstract ClockProvider getClockProvider()

createNewPrediction

protected abstract Prediction createNewPrediction(ChannelAddress channelAddress)

activate

protected final void activate(org.osgi.service.component.ComponentContext context,
 String id,
 String alias,
 boolean enabled)

Description copied from class: AbstractOpenemsComponent

Handles @Activate of implementations. Prints log output.

Overrides:

activate in class AbstractOpenemsComponent

Parameters:

context - the OSGi ComponentContext

id - the unique OpenEMS Component ID

alias - Human-readable name of this Component. Typically 'config.alias()'. Defaults to 'id' if empty

enabled - is the Component enabled?

activate

protected void activate(org.osgi.service.component.ComponentContext context,
 String id,
 String alias,
 boolean enabled,
 String[] channelAddresses,
 LogVerbosity logVerbosity)
                 throws OpenemsError.OpenemsNamedException

Throws:

OpenemsError.OpenemsNamedException

getChannelAddresses

public ChannelAddress[] getChannelAddresses()

Description copied from interface: Predictor

Gets the Channel-Addresses for which this Predictor can provide a prediction.

The entries can contain wildcards to match multiple actual ChannelAddresses.

Specified by:

getChannelAddresses in interface Predictor

Returns:

an array of ChannelAddresses

getPrediction

public Prediction getPrediction(ChannelAddress channelAddress)

Description copied from interface: Predictor

Gets a Prediction for the given ChannelAddress.

Specified by:

getPrediction in interface Predictor

Parameters:

channelAddress - the ChannelAddress

Returns:

the Prediction