dk.deepthought.sidious.supportsystem
Interface Adjustable

All Known Implementing Classes:

CO2SetPoint, HeaterSetPoint, ScreenSetPoint, WindowSetPoint

public interface Adjustable

This interface represents an adjustable in the system.

Note that all timerelated calculations must adhere to the systemwide timestep property.

All Implementing classes MUST adhere to the following:

contain a field representing its current setting.

override hashCode and equals with respect to its setting.

be immutable.

Author:

Deepthought

See Also:

SystemSettings

Method Summary

State	consequence(State state) Calculates the consequense of applying this adjustable to the specified state.
SuperLinkID	getID() Returns the id of this Adjustable.
double	getSetting() Returns the setting of this Adjustable.
java.util.Collection<Adjustable>	possibleAdjustments() Returns the possible adjustments from the current setting of this Adjustable.

Method Detail

consequence

State consequence(State state)

Calculates the consequense of applying this adjustable to the specified state.

Returns a new State as the calculated consequence of applying this adjustable to the specified state.

Parameters:

state - the input state

Returns:

the resulting State from applying this adjustable to state

possibleAdjustments

java.util.Collection<Adjustable> possibleAdjustments()

Returns the possible adjustments from the current setting of this Adjustable.

The resulting adjustments represent all currently possible adjustments that can be applied to this adjustable.

Returns:

the new possible settings

getID

SuperLinkID getID()

Returns the id of this Adjustable.

Returns:

the id of this adjustable

getSetting

double getSetting()

Returns the setting of this Adjustable.

Returns:

the setting of this adjustable