org.flexiblepower.efi.buffer

Class ActuatorBehaviour

java.lang.Object

org.flexiblepower.efi.buffer.ActuatorBehaviour

public class ActuatorBehaviour
extends java.lang.Object

This class describes how an actuator can affect the buffer. It contains a collection of RunningModes that use a FillLevelFunction to describe each one. Each FillLevelFunction contains for every fill level of the buffer a RunningModeBehaviour. The RunningModeBehaviour describes the effect on the buffer when this RunningMode is selected and the consumed or produced commodities.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ActuatorBehaviour.Builder This helper class should be used to easily define a ActuatorBehaviour.

Constructor Summary

Constructors

Constructor and Description
ActuatorBehaviour(int id, java.util.Collection<RunningMode<FillLevelFunction<RunningModeBehaviour>>> runningModes) Construct an ActuatorBehaviour instance.

Method Summary

Methods

Modifier and Type	Method and Description
static ActuatorBehaviour.Builder	create(int id)
int	getId()
double	getLowerBound()
RunningMode<FillLevelFunction<RunningModeBehaviour>>	getRunningMode(int id)
java.util.Collection<RunningMode<FillLevelFunction<RunningModeBehaviour>>>	getRunningModes()
double	getUpperBound()

Methods inherited from class java.lang.Object

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

Constructor Detail

ActuatorBehaviour

public ActuatorBehaviour(int id,
                 java.util.Collection<RunningMode<FillLevelFunction<RunningModeBehaviour>>> runningModes)

Construct an ActuatorBehaviour instance.

Parameters:

id - Device unique identifier for this actuator

runningModes - Collection describing all the supported runningModes of this

Throws:

java.lang.IllegalArgumentException - Thrown when there are multiple RunningMode with the same identifier or when a Transition has an unknown RunningMode as target

Method Detail

create

public static ActuatorBehaviour.Builder create(int id)

Parameters:

id - Identifier of this Actuator

Returns:

a new ActuatorBehaviour.Builder object that can be used to easily create the ActuatorBehaviour

getId

public int getId()

Returns:

A unique identifier (within the context of this buffer) for this actuator. This should always respond to a Actuator that has been registered.

getRunningModes

public java.util.Collection<RunningMode<FillLevelFunction<RunningModeBehaviour>>> getRunningModes()

Returns:

A list of zero or more possible running modes for this actuator.

getRunningMode

public RunningMode<FillLevelFunction<RunningModeBehaviour>> getRunningMode(int id)

Parameters:

id - The identifier of the RunningMode

Returns:

The corresponding RunningMode

getLowerBound

public double getLowerBound()

Returns:

The minimum fill level for which this actuator can operate

getUpperBound

public double getUpperBound()

Returns:

The maximum fill level for which this actuator can operate