Package io.openems.edge.common.statemachine

Class StateHandler<STATE extends State<STATE>,CONTEXT>

java.lang.Object

io.openems.edge.common.statemachine.StateHandler<STATE,CONTEXT>

Type Parameters:

STATE - the actual State type

CONTEXT - the context type

Direct Known Subclasses:

AboveReserveSocHandler, AboveTargetSocHandler, ActivateDebugMode1Handler, ActivateDebugMode2Handler, ActivateDebugMode3Handler, ActivateDebugMode4Handler, ActivateEconomicMode1Handler, ActivateEconomicMode2Handler, ActivateEconomicMode3Handler, ActivateEconomicMode4Handler, AtReserveSocHandler, AtTargetSocHandler, BelowReserveSocHandler, BelowTargetSocHandler, CompletedCycleHandler, ContinueWithChargeHandler, ContinueWithDischargeHandler, DischargeHandler, ErrorHandler, ErrorHandler, ErrorHandler, ErrorHandler, ErrorHandler, ErrorHandler, ErrorHandler, ErrorHandler, ErrorHandler, ErrorHandler, ErrorHandler, FastChargeHandler, FinalSocHandler, FinishedHandler, FinishedHandler, ForceChargeHandler, GoReadonlyModeHandler, GoRunningHandler, GoRunningHandler, GoRunningHandler, GoRunningHandler, GoRunningHandler, GoRunningHandler, GoRunningHandler, GoRunningHandler, GoRunningHandler, GoStoppedHandler, GoStoppedHandler, GoStoppedHandler, GoStoppedHandler, GoStoppedHandler, GoStoppedHandler, GoStoppedHandler, GoStoppedHandler, GoStoppedHandler, GoWriteModeHandler, GridSwitchHandler, IdleHander, NoLimitHandler, NotStartedHandler, ReadonlyModeHandler, RunningHandler, RunningHandler, RunningHandler, RunningHandler, RunningHandler, RunningHandler, RunningHandler, RunningHandler, RunningHandler, SlowCharge1Handler, SlowCharge2Handler, StartBatteryHandler, StartBatteryInOffGridHandler, StartBatteryInOnGridHandler, StartBatteryInverterHandler, StartBatteryInverterInOffGridHandler, StartBatteryInverterInOnGridHandler, StartChargeHandler, StartDischargeHandler, StartedHandler, StartedInOffGridHandler, StartedInOnGridHandler, StopBatteryHandler, StopBatteryHandler, StopBatteryInverterHandler, StopBatteryInverterHandler, StoppedHandler, StoppedHandler, StoppedHandler, StoppedHandler, StoppedHandler, StoppedHandler, StoppedHandler, StoppedHandler, StoppedHandler, StoppedHandler, UndefinedHandler, UndefinedHandler, UndefinedHandler, UndefinedHandler, UndefinedHandler, UndefinedHandler, UndefinedHandler, UndefinedHandler, UndefinedHandler, UndefinedHandler, UndefinedHandler, UndefinedHandler, UndefinedHandler, UndefinedHandler, WithinLowerTargetSocBoundariesHandler, WithinUpperTargetSocBoundariesHandler, WriteModeHandler

public abstract class StateHandler<STATE extends State<STATE>,CONTEXT>
extends Object

Defines a Handler for a State of a AbstractStateMachine.

Constructor Summary

Constructors

Constructor	Description
StateHandler()

Method Summary

Modifier and Type	Method	Description
protected void	onEntry(CONTEXT context)	Gets called before the StateMachine changes from another State to this State.
protected void	onExit(CONTEXT context)	Gets called after the StateMachine changes from this State to another State.
protected abstract STATE	runAndGetNextState(CONTEXT context)	Runs the main logic of StateMachine State and returns the next State.

Methods inherited from class java.lang.Object

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

Constructor Details

StateHandler

public StateHandler()

Method Details

runAndGetNextState

protected abstract STATE runAndGetNextState(CONTEXT context)
                                     throws OpenemsError.OpenemsNamedException

Runs the main logic of StateMachine State and returns the next State.

Parameters:

context - the StateHandler.

Returns:

the next State

Throws:

OpenemsError.OpenemsNamedException

onEntry

protected void onEntry(CONTEXT context)
                throws OpenemsError.OpenemsNamedException

Gets called before the StateMachine changes from another State to this State.

Parameters:

context - the Context object

Throws:

OpenemsError.OpenemsNamedException - on error

onExit

protected void onExit(CONTEXT context)
               throws OpenemsError.OpenemsNamedException

Gets called after the StateMachine changes from this State to another State.

Parameters:

context - the Context object

Throws:

OpenemsError.OpenemsNamedException - on error