burlap.oomdp.singleagent.common

Class SimpleAction

java.lang.Object

burlap.oomdp.singleagent.Action

burlap.oomdp.singleagent.common.SimpleAction

Direct Known Subclasses:

ExampleGridWorld.Movement, FrostbiteDomain.MovementAction, GraphDefinedDomain.GraphAction, GridWorldDomain.MovementAction, InvertedPendulum.ForceAction, RLGlueDomain.RLGlueActionSpecification, SimpleAction.SimpleDeterministicAction, TigerDomain.OpenAction

public abstract class SimpleAction
extends Action

An abstract subclass of Action for actions that are not parameterized, are primitive, and have no preconditions (applicable everywhere). Only the Action.performActionHelper(burlap.oomdp.core.states.State, burlap.oomdp.singleagent.GroundedAction) method needs to be implemented by a subclass and the FullActionModel.getTransitions(burlap.oomdp.core.states.State, burlap.oomdp.singleagent.GroundedAction) method if the subclass implements the FullActionModel interface. There is also an existing subclass for simple deterministic actions (SimpleAction.SimpleDeterministicAction) that fills in the FullActionModel.getTransitions(burlap.oomdp.core.states.State, burlap.oomdp.singleagent.GroundedAction) method using the implementation of Action.performActionHelper(burlap.oomdp.core.states.State, burlap.oomdp.singleagent.GroundedAction) method.

Author:

James MacGlashan.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimpleAction.SimpleDeterministicAction A abstract class for deterministic actions that are not parameterized, are primitive, and have no preconditions (applicable everywhere).

Field Summary

Fields inherited from class burlap.oomdp.singleagent.Action

actionObservers, domain, name

Constructor Summary

Constructors

Constructor and Description
SimpleAction()
SimpleAction(java.lang.String name, Domain domain)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	applicableInState(State s, GroundedAction groundedAction) Returns true if this action can be applied in this specified state with the parameters specified by the provided GroundedAction Default behavior is that an action can be applied in any state, but this will need be overridden if that is not the case.
java.util.List<GroundedAction>	getAllApplicableGroundedActions(State s) Returns all possible groundings of this action that can be applied in the provided State.
GroundedAction	getAssociatedGroundedAction() Returns a GroundedAction instance that points to this Action, but does not have any parameters--if any--set.
boolean	isParameterized() Returns true if this action is parameterized; false otherwise.
boolean	isPrimitive() Returns whether this action is a primitive action of the domain or not.

Methods inherited from class burlap.oomdp.singleagent.Action

addActionObserver, clearAllActionsObservers, deterministicTransition, equals, getAllApplicableGroundedActionsFromActionList, getDomain, getGroundedAction, getName, hashCode, performAction, performActionHelper, performInEnvironment

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleAction

public SimpleAction()

SimpleAction

public SimpleAction(java.lang.String name,
            Domain domain)

Method Detail

applicableInState

public boolean applicableInState(State s,
                        GroundedAction groundedAction)

Description copied from class: Action

Returns true if this action can be applied in this specified state with the parameters specified by the provided GroundedAction Default behavior is that an action can be applied in any state, but this will need be overridden if that is not the case.

Specified by:

applicableInState in class Action

Parameters:

s - the state to perform the action on

groundedAction - the GroundedAction specifying the parameters to use

Returns:

whether this action can be performed on the given state with the given parameters

isPrimitive

public boolean isPrimitive()

Description copied from class: Action

Returns whether this action is a primitive action of the domain or not. A primitive action is defined to be an action that always takes one time step.

Specified by:

isPrimitive in class Action

Returns:

true if the action is primitive; false otherwise.

isParameterized

public boolean isParameterized()

Description copied from class: Action

Returns true if this action is parameterized; false otherwise.

Specified by:

isParameterized in class Action

Returns:

true if this Action is parameterized; false if it is not.

getAssociatedGroundedAction

public GroundedAction getAssociatedGroundedAction()

Description copied from class: Action

Returns a GroundedAction instance that points to this Action, but does not have any parameters--if any--set.

Specified by:

getAssociatedGroundedAction in class Action

Returns:

a GroundedAction instance.

getAllApplicableGroundedActions

public java.util.List<GroundedAction> getAllApplicableGroundedActions(State s)

Description copied from class: Action

Returns all possible groundings of this action that can be applied in the provided State. To check if a grounded action is applicable in the state, the Action.applicableInState(State, burlap.oomdp.singleagent.GroundedAction) method is checked. The default behavior of this method is to treat the parameters as possible object bindings, finding all bindings that satisfy the object class typing specified and then checking them against the Action.applicableInState(State, burlap.oomdp.singleagent.GroundedAction) method. However, this class can also be overridden to provide custom grounding behavior or non-object based parametrization.

Specified by:

getAllApplicableGroundedActions in class Action

Parameters:

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

Returns:

a list of all applicable GroundedActions of this Action object in in the given State