burlap.oomdp.stateserialization

Class SerializableState

java.lang.Object

burlap.oomdp.stateserialization.SerializableState

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

SerializableCartPoleStateFactory.SerializableCartPoleState, SerializableFrostbiteStateFactory.SerializableFrostbiteState, SerializableGridWorldStateFactory.SerializableGridWorldState, SerializableInvertedPendulumStateFactory.SerializableInvertedPendulumState, SerializableLunarLanderStateFactory.SerializableLunarLanderState, SerializableMountainCarStateFactory.SerializableMountainCarState, SimpleSerializableState

public abstract class SerializableState
extends java.lang.Object
implements java.io.Serializable

A class for transforming State objects into an object that can be trivially serialized by using the serialize(burlap.oomdp.core.states.State) method. This class does not implement the State interface, because the serializable states do not have to reference specific Domain instances or ObjectClass for easy file portability. Instead, a SerializableState is deserialized into an actual State object by calling the deserialize(burlap.oomdp.core.Domain) method, which takes the Domain into which the state should be unpacked. There is also a static method deserializeStates(java.util.List, burlap.oomdp.core.Domain) which takes a List of SerializableState objects and turns it into a List of State objects by calling the deserialize(burlap.oomdp.core.Domain) method of each element.

In general, SerializableState objects should be constructed with a SerializableStateFactory.

A standard serializable representation that operates reading the ObjectInstance and Value objects returned by a State and explicitly representing their information is the SimpleSerializableState and its corresponding SimpleSerializableStateFactory.

Author:

James MacGlashan.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SerializableState()
SerializableState(State s) Constructs and serializes the input State by calling this object's serialize(burlap.oomdp.core.states.State) method.

Method Summary

Methods

Modifier and Type	Method and Description
abstract State	deserialize(Domain domain) Unpacks this SerializableState into an actual State in which the ObjectClass, Attribute and other Domain information refers to the provided Domain.
static java.util.List<State>	deserializeStates(java.util.List<SerializableState> serializableStates, Domain domain) Takes a List of SerializableState objects and calls the deserialize(burlap.oomdp.core.Domain) method on them to turn it into a List of State objects.
abstract void	serialize(State s) Causes this object to be a serializable representation of the input State

Methods inherited from class java.lang.Object

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

Constructor Detail

SerializableState

public SerializableState()

SerializableState

public SerializableState(State s)

Constructs and serializes the input State by calling this object's serialize(burlap.oomdp.core.states.State) method.

Parameters:

s - the input State to serialize.

Method Detail

serialize

public abstract void serialize(State s)

Causes this object to be a serializable representation of the input State

Parameters:

s - the State to be represented by this object.

deserialize

public abstract State deserialize(Domain domain)

Unpacks this SerializableState into an actual State in which the ObjectClass, Attribute and other Domain information refers to the provided Domain.

Parameters:

domain - The Domain specifying ObjectClass and Attribute information.

Returns:

a State corresponding to this SerializableState

deserializeStates

public static java.util.List<State> deserializeStates(java.util.List<SerializableState> serializableStates,
                                      Domain domain)

Takes a List of SerializableState objects and calls the deserialize(burlap.oomdp.core.Domain) method on them to turn it into a List of State objects.

Parameters:

serializableStates - the List of SerializableState instances to deserialize.

domain - the Domain to which all produced State objects will be associated.

Returns:

a List of State objects.