Package pal.algorithmics
Class GeneralObjectState
- java.lang.Object
-
- pal.algorithmics.GeneralObjectState
-
- All Implemented Interfaces:
ObjectState
public class GeneralObjectState extends java.lang.Object implements ObjectState
Title:
Description:
Copyright: Copyright (c) 2003
Company:
- Version:
- 1.0
- Author:
- not attributable
-
-
Constructor Summary
Constructors Constructor Description GeneralObjectState(UndoableAction action, StateProvider subject, boolean maximise)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description double
doAction(double currentScore, double desparationValue)
Perform an actionjava.lang.Object
getStateReference()
boolean
isMaximiseScore()
If true, than a bigger score is better, otherwise a smaller score is bettervoid
restoreState(java.lang.Object stateReference)
Used to restore the state of the this object to that of a previous time pointboolean
undoAction()
Undo the last action (if it was successful) Users of an ObjectState should accept that sometimes undoing an action isn't possible.
-
-
-
Constructor Detail
-
GeneralObjectState
public GeneralObjectState(UndoableAction action, StateProvider subject, boolean maximise)
-
-
Method Detail
-
doAction
public double doAction(double currentScore, double desparationValue)
Perform an action- Specified by:
doAction
in interfaceObjectState
- Parameters:
currentScore
- the current score before doing the actiondesparationValue
- An indication of how desparate we are, values closer to 1 mean more desparate while values towards 0 mean less desparate- Returns:
- the current score after doing the action
-
undoAction
public boolean undoAction()
Description copied from interface:ObjectState
Undo the last action (if it was successful) Users of an ObjectState should accept that sometimes undoing an action isn't possible. If an undo was not possible the object state should be in the same state as it was previous to the call to undoAction()- Specified by:
undoAction
in interfaceObjectState
- Returns:
- true if undo was successful
-
getStateReference
public java.lang.Object getStateReference()
- Specified by:
getStateReference
in interfaceObjectState
- Returns:
- An object that can be used to reconstruct the current state of this object
-
restoreState
public void restoreState(java.lang.Object stateReference)
Description copied from interface:ObjectState
Used to restore the state of the this object to that of a previous time point- Specified by:
restoreState
in interfaceObjectState
- Parameters:
stateReference
- An object returned by getStateReference()
-
isMaximiseScore
public boolean isMaximiseScore()
Description copied from interface:ObjectState
If true, than a bigger score is better, otherwise a smaller score is better- Specified by:
isMaximiseScore
in interfaceObjectState
- Returns:
- True if the aim is to maximise
-
-