Package io.openems.edge.scheduler.api

Interface Scheduler

All Superinterfaces:

OpenemsComponent

All Known Subinterfaces:

SchedulerAllAlphabetically, SchedulerDaily, SchedulerFixedOrder

All Known Implementing Classes:

SchedulerAllAlphabeticallyImpl, SchedulerDailyImpl, SchedulerFixedOrderImpl

@ProviderType
public interface Scheduler
extends OpenemsComponent

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	Scheduler.ChannelId

Method Summary

Modifier and Type	Method	Description
default void	_setControllerIsMissing(boolean value)	Internal method to set the 'nextValue' on Scheduler.ChannelId.CONTROLLER_IS_MISSING Channel.
default Value<Boolean>	getControllerIsMissing()	Gets the Run-Failed State.
default StateChannel	getControllerIsMissingChannel()	Gets the Channel for Scheduler.ChannelId.CONTROLLER_IS_MISSING.
LinkedHashSet<String>	getControllers()	Returns Component-IDs of Controllers ordered by their current execution priority.

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

Method Details

getControllerIsMissingChannel

default StateChannel getControllerIsMissingChannel()

Gets the Channel for Scheduler.ChannelId.CONTROLLER_IS_MISSING.

Returns:

the Channel

getControllerIsMissing

default Value<Boolean> getControllerIsMissing()

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

Returns:

the Channel Value

_setControllerIsMissing

default void _setControllerIsMissing(boolean value)

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

Parameters:

value - the next value

getControllers

LinkedHashSet<String> getControllers()

Returns Component-IDs of 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 Component-IDs of Controllers