burlap.mdp.core.oo.state.generic

Class DeepOOState

java.lang.Object

burlap.mdp.core.oo.state.generic.GenericOOState

burlap.mdp.core.oo.state.generic.DeepOOState

All Implemented Interfaces:

MutableOOState, OOState, MutableState, State

public class DeepOOState
extends GenericOOState

An alternative implementation of GenericOOState in which the copy() operations performs a deep copy (DeepCopyState) of all ObjectInstance objects, thereby allows safe modification of any of its ObjectInstance objects without using the GenericOOState.touch(String) method. As a result, this implementation will cause greater memory overhead in your algorithms, but requires less management on a client that is manipulating the states (e.g., defining transition dynamics).

Author:

James MacGlashan.

Field Summary

Fields inherited from class burlap.mdp.core.oo.state.generic.GenericOOState

objectsByClass, objectsMap

Constructor Summary

Constructors

Constructor and Description
DeepOOState()
DeepOOState(ObjectInstance... objects)
DeepOOState(OOState srcOOState)

Method Summary

Modifier and Type	Method and Description
DeepOOState	copy() Returns a copy of this state suitable for creating state transitions.
MutableState	set(java.lang.Object variableKey, java.lang.Object value) Sets the value for the given variable key.

Methods inherited from class burlap.mdp.core.oo.state.generic.GenericOOState

addObject, get, getObjectsByClass, getObjectsMap, getOrGenerateObjectClassList, numObjects, object, objects, objectsOfClass, removeObject, renameObject, setObjectsByClass, setObjectsMap, toString, touch, variableKeys

Methods inherited from class java.lang.Object

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

Constructor Detail

DeepOOState

public DeepOOState()

DeepOOState

public DeepOOState(OOState srcOOState)

DeepOOState

public DeepOOState(ObjectInstance... objects)

Method Detail

set

public MutableState set(java.lang.Object variableKey,
                        java.lang.Object value)

Description copied from interface: MutableState

Sets the value for the given variable key.

Specified by:

set in interface MutableState

Overrides:

set in class GenericOOState

Parameters:

variableKey - the key identifier for the variable value to change

value - the variable value to which the variable should be set.

Returns:

this object to support method chaining

copy

public DeepOOState copy()

Description copied from interface: State

Returns a copy of this state suitable for creating state transitions. This copy may be a shallow copy or deep copy and is domain specific. The State implementation may indicate its copy level with the DeepCopyState or ShallowCopyState annotations. If it is a shallow copy, you should not *directly* modify any fields of a copied state without copying the fields first, or it could contaminate the state from which the copy was made. Alternatively, use the MutableState.set(Object, Object) method to modify ShallowCopyState copied states, which for ShallowCopyState instances should perform a safe copy-on-write operation.

Specified by:

copy in interface State

Overrides:

copy in class GenericOOState

Returns:

a copy of this state.