burlap.oomdp.singleagent

Class GroundedAction

java.lang.Object

burlap.oomdp.singleagent.GroundedAction

All Implemented Interfaces:

AbstractGroundedAction

Direct Known Subclasses:

BeliefMDPGenerator.GroundedBeliefAction, ObjectParameterizedAction.ObjectParameterizedGroundedAction, Policy.GroundedAnnotatedAction, SGToSADomain.GroundedSAAActionWrapper, SimpleGroundedAction

public abstract class GroundedAction
extends java.lang.Object
implements AbstractGroundedAction

A GroundedAction is a high-level abstract class implementation of a AbstractGroundedAction that is closely associated with single-agent Action definitions. The role of a GroundedAction is to provide a reference to its corresponding Action definition and also provide parameter assignments with which its Action should be applied. The set of possible GroundedAction instances specifying the different possible parameter assignments will be generated by the associated Action.getAllApplicableGroundedActions(burlap.oomdp.core.states.State) method. See the Action class documentation for more information on implementing parameterized Action definitions.

Implementing this class requires implementing three methods from AbstractGroundedAction that are not implemented by GroundedAction:
copy()
AbstractGroundedAction.initParamsWithStringRep(String[]) and
AbstractGroundedAction.getParametersAsString().
If the Action with which the GroundedAction is associated is not parameterized, then you can return the concrete class SimpleGroundedAction. Otherwise, you will need to make your own subclass of GroundedAction and implement those methods. Note that you can have your implementation store the parameter information anyway you like as long the copy() method creates a version instance of your GroundedAction implementation that copies over the parameter information. Additionally, for full support with all BURLAP tools, it should be possible to initialize the parameters with a String array using the AbstractGroundedAction.initParamsWithStringRep(String[]) and get a String array representation of them with the AbstractGroundedAction.getParametersAsString().

In addition to specifying parameter assignment information for a Action definition, this class also provides a number of useful shortcut methods for evaluating the GroundedAction. Specifically, see the
executeIn(burlap.oomdp.core.states.State)
executeIn(burlap.oomdp.singleagent.environment.Environment)
getTransitions(burlap.oomdp.core.states.State) and
applicableInState(burlap.oomdp.core.states.State)
methods, which call the associated Action methods providing this instance as the set of parameters to use. Note that the getTransitions(burlap.oomdp.core.states.State) method will throw a runtime exception if the associated Action definition does not implement the FullActionModel interface.

Author:

James MacGlashan

Field Summary

Fields

Modifier and Type	Field and Description
Action	action The action object for this grounded action

Constructor Summary

Constructors

Constructor and Description
GroundedAction(Action action) Initializes with the Action definition with which this GroundedAction is associated.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	actionName() Returns the action name for this grounded action.
boolean	applicableInState(State s)
abstract GroundedAction	copy() Returns a copy of this grounded action.
boolean	equals(java.lang.Object other)
EnvironmentOutcome	executeIn(Environment env) Executes this grounded action in the specified Environment.
State	executeIn(State s) Executes the grounded action on a given state
java.util.List<TransitionProbability>	getTransitions(State s) Returns the full set of possible state transitions when this GroundedAction is applied in the given state.
int	hashCode()
boolean	isParameterized() Returns true if this action uses parameters
java.lang.String	toString()
GroundedAction	translateParameters(State source, State target) A helper method that handles action translate in case this GroundedAction implements AbstractObjectParameterizedGroundedAction.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface burlap.oomdp.core.AbstractGroundedAction

getParametersAsString, initParamsWithStringRep

Field Detail

action

public Action action

The action object for this grounded action

Constructor Detail

GroundedAction

public GroundedAction(Action action)

Initializes with the Action definition with which this GroundedAction is associated.

Parameters:

action - the associated Action definition.

Method Detail

actionName

public java.lang.String actionName()

Returns the action name for this grounded action.

Specified by:

actionName in interface AbstractGroundedAction

Returns:

the action name for this grounded action.

isParameterized

public boolean isParameterized()

Description copied from interface: AbstractGroundedAction

Returns true if this action uses parameters

Specified by:

isParameterized in interface AbstractGroundedAction

Returns:

true if this action uses parameters; false otherwise

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

applicableInState

public boolean applicableInState(State s)

copy

public abstract GroundedAction copy()

Description copied from interface: AbstractGroundedAction

Returns a copy of this grounded action.

Specified by:

copy in interface AbstractGroundedAction

Returns:

a copy of this grounded action.

executeIn

public EnvironmentOutcome executeIn(Environment env)

Executes this grounded action in the specified Environment.

Parameters:

env - the Environment in which the action is to be executed.

Returns:

an EnvironmentOutcome specifying the outcome of this action.

executeIn

public State executeIn(State s)

Executes the grounded action on a given state

Parameters:

s - the state on which to execute the action

Returns:

The state after the action has been executed

getTransitions

public java.util.List<TransitionProbability> getTransitions(State s)

Returns the full set of possible state transitions when this GroundedAction is applied in the given state. If the underlying Action definition does not implement FullActionModel, then a runtime exception will be thrown instead.

Parameters:

s - the source state from which the transitions should be computed.

Returns:

a List of TransitionProbability objects specifying all state transitions from the input state that have non-zero probability.

translateParameters

public GroundedAction translateParameters(State source,
                                 State target)

A helper method that handles action translate in case this GroundedAction implements AbstractObjectParameterizedGroundedAction. Works by calling the AbstractObjectParameterizedGroundedAction.Helper.translateParameters(burlap.oomdp.core.AbstractGroundedAction, burlap.oomdp.core.states.State, burlap.oomdp.core.states.State) method with this object as the action to translate. If this is a AbstractObjectParameterizedGroundedAction, then a new GroundedAction with its object parameters mapped to the object names sin the target state is returned.

Parameters:

source - the source state in which this GroundedAction's parameters were bound.

target - the target state in which the returned GroundedAction will have its parameters bound.

Returns:

If this is a AbstractObjectParameterizedGroundedAction, then a new GroundedAction with its object parameters mapped to the object names sin the target state

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object