Package 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 Description static class
Scheduler.ChannelId
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default void
_setControllerIsMissing(boolean value)
Internal method to set the 'nextValue' onScheduler.ChannelId.CONTROLLER_IS_MISSING
Channel.default Value<java.lang.Boolean>
getControllerIsMissing()
Gets the Run-Failed State.default StateChannel
getControllerIsMissingChannel()
Gets the Channel forScheduler.ChannelId.CONTROLLER_IS_MISSING
.java.util.LinkedHashSet<java.lang.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 Detail
-
getControllerIsMissingChannel
default StateChannel getControllerIsMissingChannel()
Gets the Channel forScheduler.ChannelId.CONTROLLER_IS_MISSING
.- Returns:
- the Channel
-
getControllerIsMissing
default Value<java.lang.Boolean> getControllerIsMissing()
Gets the Run-Failed State. SeeScheduler.ChannelId.CONTROLLER_IS_MISSING
.- Returns:
- the Channel
Value
-
_setControllerIsMissing
default void _setControllerIsMissing(boolean value)
Internal method to set the 'nextValue' onScheduler.ChannelId.CONTROLLER_IS_MISSING
Channel.- Parameters:
value
- the next value
-
getControllers
java.util.LinkedHashSet<java.lang.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
-
-