burlap.domain.singleagent.gridworld.state

Class GridLocation

java.lang.Object

burlap.domain.singleagent.gridworld.state.GridLocation

All Implemented Interfaces:

ObjectInstance, State

public class GridLocation
extends java.lang.Object
implements ObjectInstance

ObjectInstance for locations in a GridWorldDomain. Variable keys are string "x", "y", and "loc" of type int.

Author:

James MacGlashan.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	name
int	type
int	x
int	y

Constructor Summary

Constructors

Constructor and Description
GridLocation()
GridLocation(int x, int y, int type, java.lang.String name)
GridLocation(int x, int y, java.lang.String name)

Method Summary

Modifier and Type	Method and Description
java.lang.String	className() Returns the name of this OO-MDP object class
GridLocation	copy() Returns a copy of this state suitable for creating state transitions.
GridLocation	copyWithName(java.lang.String objectName) Returns a copy of this ObjectInstance with the specified name
java.lang.Object	get(java.lang.Object variableKey) Returns the value for the given variable key.
java.lang.String	getName()
java.lang.String	name() Returns the name of this object instance
void	setName(java.lang.String name)
java.lang.String	toString()
java.util.List<java.lang.Object>	variableKeys() Returns the list of state variable keys.

Methods inherited from class java.lang.Object

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

Field Detail

x

public int x

y

public int y

type

public int type

name

protected java.lang.String name

Constructor Detail

GridLocation

public GridLocation()

GridLocation

public GridLocation(int x,
                    int y,
                    java.lang.String name)

GridLocation

public GridLocation(int x,
                    int y,
                    int type,
                    java.lang.String name)

Method Detail

className

public java.lang.String className()

Description copied from interface: ObjectInstance

Returns the name of this OO-MDP object class

Specified by:

className in interface ObjectInstance

Returns:

the name of this OO-MDP object class

name

public java.lang.String name()

Description copied from interface: ObjectInstance

Returns the name of this object instance

Specified by:

name in interface ObjectInstance

Returns:

the name of this object instance

copyWithName

public GridLocation copyWithName(java.lang.String objectName)

Description copied from interface: ObjectInstance

Returns a copy of this ObjectInstance with the specified name

Specified by:

copyWithName in interface ObjectInstance

Parameters:

objectName - the new name for the object

Returns:

a copy of this object

variableKeys

public java.util.List<java.lang.Object> variableKeys()

Description copied from interface: State

Returns the list of state variable keys.

Specified by:

variableKeys in interface State

Returns:

the list of state variable keys.

get

public java.lang.Object get(java.lang.Object variableKey)

Description copied from interface: State

Returns the value for the given variable key. Changes to the returned value are not guaranteed to modify the state.

Specified by:

get in interface State

Parameters:

variableKey - the variable key

Returns:

the value for the given variable key

copy

public GridLocation 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

Returns:

a copy of this state.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)