burlap.mdp.singleagent.oo

Class ObjectParameterizedActionType

java.lang.Object

burlap.mdp.singleagent.oo.ObjectParameterizedActionType

All Implemented Interfaces:

ActionType

Direct Known Subclasses:

BlocksWorld.StackActionType, BlocksWorld.UnstackActionType

public abstract class ObjectParameterizedActionType
extends java.lang.Object
implements ActionType

An action type for ObjectParameterizedAction, that is, an action that is parameterized to objects in an OOState that belong to certain OO-MDP classes. This class is abstract and requires implementing the applicableInState(State, ObjectParameterizedAction) method which defines whether a specific object parameterization can be applied in a given state.

Author:

James MacGlashan.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ObjectParameterizedActionType.SAObjectParameterizedAction An Action that has parameters specifying the name of ObjectInstances to which it is applied.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	name
protected java.lang.String[]	parameterClasses The object classes each parameter of this action can accept; empty list for a parameter-less action (which is the default)
protected java.lang.String[]	parameterOrderGroup Specifies the parameter order group each parameter.

Constructor Summary

Constructors

Constructor and Description
ObjectParameterizedActionType(java.lang.String name, java.lang.String[] parameterClasses) Initializes the action with the name of the action
ObjectParameterizedActionType(java.lang.String name, java.lang.String[] parameterClasses, java.lang.String[] parameterOrderGroups) Initializes the action with the name of the action type, the parameters it takes, and the parameter order groups.

Method Summary

Modifier and Type	Method and Description
java.util.List<Action>	allApplicableActions(State s) Returns all possible actions of this type that can be applied in the provided State.
protected abstract boolean	applicableInState(State s, ObjectParameterizedAction a) Indicates whether the input action can be applied in the state
Action	associatedAction(java.lang.String strRep) Returns an Action whose parameters are specified by the given String representation (if the ActionType manages multiple parameterizations)
protected ObjectParameterizedAction	generateAction(java.lang.String[] params)
java.lang.String[]	getParameterClasses() Returns a String array of the names of of the object classes to which bound parameters must belong
java.lang.String[]	getParameterOrderGroups() Returns the a String array specifying the parameter order group of each parameter.
java.lang.String	typeName() The unique name of this ActionType

Methods inherited from class java.lang.Object

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

Field Detail

name

public java.lang.String name

parameterClasses

protected java.lang.String[] parameterClasses

The object classes each parameter of this action can accept; empty list for a parameter-less action (which is the default)

parameterOrderGroup

protected java.lang.String[] parameterOrderGroup

Specifies the parameter order group each parameter. Parameters in the same order group are order invariant; that is, if you swapped the parameter assignments for for parameters in the same group, the action would have the same effect. However, if you swapped the parameter assignments of two parameters in different order groups, the action would have a different effect.

Constructor Detail

ObjectParameterizedActionType

public ObjectParameterizedActionType(java.lang.String name,
                                     java.lang.String[] parameterClasses)

Initializes the action with the name of the action

Parameters:

name - the name of the action

parameterClasses - a String array of the names of the object classes to which bound parameters must belong

ObjectParameterizedActionType

public ObjectParameterizedActionType(java.lang.String name,
                                     java.lang.String[] parameterClasses,
                                     java.lang.String[] parameterOrderGroups)

Initializes the action with the name of the action type, the parameters it takes, and the parameter order groups.

Parameters:

name - the name of the action type

parameterClasses - a String array of the names of the object classes to which bound parameters must belong

parameterOrderGroups - the order group assignments for each of the parameters. If two parameters are in the same order group, then shuffling the their parameters is the same action; that is, the transition probability distributions will be the same

Method Detail

getParameterClasses

public final java.lang.String[] getParameterClasses()

Returns a String array of the names of of the object classes to which bound parameters must belong

Returns:

a String array of the names of of the object classes to which bound parameters must belong. The array is empty if this action does not require parameters.

getParameterOrderGroups

public final java.lang.String[] getParameterOrderGroups()

Returns the a String array specifying the parameter order group of each parameter.

Returns:

the a String array specifying the parameter order group of each parameter. The array is empty if this action does not require parameters.

typeName

public java.lang.String typeName()

Description copied from interface: ActionType

The unique name of this ActionType

Specified by:

typeName in interface ActionType

Returns:

unique String name of this ActionType

associatedAction

public Action associatedAction(java.lang.String strRep)

Description copied from interface: ActionType

Returns an Action whose parameters are specified by the given String representation (if the ActionType manages multiple parameterizations)

Specified by:

associatedAction in interface ActionType

Parameters:

strRep - the String representation of the Action parameters, if any, or null if there are no parameters.

Returns:

the corresponding Action

allApplicableActions

public java.util.List<Action> allApplicableActions(State s)

Description copied from interface: ActionType

Returns all possible actions of this type that can be applied in the provided State.

Specified by:

allApplicableActions in interface ActionType

Parameters:

s - the State in which all applicable actions of this ActionType object should be returned.

Returns:

a list of all applicable Actions of this ActionType object in in the given State

generateAction

protected ObjectParameterizedAction generateAction(java.lang.String[] params)

applicableInState

protected abstract boolean applicableInState(State s,
                                             ObjectParameterizedAction a)

Indicates whether the input action can be applied in the state

Parameters:

s - the input state

a - the action under consideration

Returns:

true if a can be applied in s; false if it cannot be applied.