io.openems.edge.scheduler.api

Interface Scheduler

All Superinterfaces:

OpenemsComponent

All Known Subinterfaces:

AllAlphabeticallyScheduler, DailyScheduler, FixedOrderScheduler

All Known Implementing Classes:

AllAlphabeticallySchedulerImpl, DailySchedulerImpl, FixedOrderSchedulerImpl

@ProviderType
public interface Scheduler
extends OpenemsComponent

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Scheduler.ChannelId

Method Summary

Modifier and Type	Method and Description
default void	_setRunFailed(boolean value) Internal method to set the 'nextValue' on Scheduler.ChannelId.RUN_FAILED Channel.
java.util.LinkedHashSet<Controller>	getControllers() Returns Controllers ordered by their current execution priority.
default Value<java.lang.Boolean>	getRunFailed() Gets the Run-Failed State.
default StateChannel	getRunFailedChannel() Gets the Channel for Scheduler.ChannelId.RUN_FAILED.

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

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

Method Detail

getRunFailedChannel

default StateChannel getRunFailedChannel()

Gets the Channel for Scheduler.ChannelId.RUN_FAILED.

Returns:

the Channel

getRunFailed

default Value<java.lang.Boolean> getRunFailed()

Gets the Run-Failed State. See Scheduler.ChannelId.RUN_FAILED.

Returns:

the Channel Value

_setRunFailed

default void _setRunFailed(boolean value)

Internal method to set the 'nextValue' on Scheduler.ChannelId.RUN_FAILED Channel.

Parameters:

value - the next value

getControllers

java.util.LinkedHashSet<Controller> getControllers()
                                            throws OpenemsError.OpenemsNamedException

Returns Controllers ordered by their current execution priority.

This method is called once every Cycle, i.e. once per second. The LinkedHashSet is used, as it preserves insertion order

Returns:

a ordered set of Controllers

Throws:

OpenemsError.OpenemsNamedException - on error