burlap.behavior.policy

Class Policy.GroundedAnnotatedAction

java.lang.Object

burlap.oomdp.singleagent.GroundedAction

burlap.behavior.policy.Policy.GroundedAnnotatedAction

All Implemented Interfaces:

AbstractGroundedAction

Enclosing class:

Policy

public static class Policy.GroundedAnnotatedAction
extends GroundedAction

A class for annotating an action selection, specified with a GroundedAction, with a string. The resulting toString() method will produce a string of the following form:
"*annotation--action.toString()" where annotation is the user input annotation and action.toString() is the result from the input GroundedAction that is being annotated. The leading * character indicates to GroundedAction serializers (such as the EpisodeAnalysis serialization) that this GroundedAction is an Policy.GroundedAnnotatedAction.

All other GroundedAction methods are delegated to the inputted GroundedAction.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	annotation The string annotation to return in the toString() method.
GroundedAction	delegate The GroundedAction delegate to be annotated that handles all methods except the toString() method.

Fields inherited from class burlap.oomdp.singleagent.GroundedAction

action

Constructor Summary

Constructors

Constructor and Description
Policy.GroundedAnnotatedAction(java.lang.String annotation, GroundedAction delegate) Initializes.

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)
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.lang.String[]	getParametersAsString() Returns an array of string representations of this AbstractGroundedAction's parameters
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()
void	initParamsWithStringRep(java.lang.String[] params) Initializes the parameter values of this AbstractGroundedAction according to the provided string representation of their values.
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

Field Detail

annotation

public java.lang.String annotation

The string annotation to return in the toString() method.

delegate

public GroundedAction delegate

The GroundedAction delegate to be annotated that handles all methods except the toString() method.

Constructor Detail

Policy.GroundedAnnotatedAction

public Policy.GroundedAnnotatedAction(java.lang.String annotation,
                              GroundedAction delegate)

Initializes.

Parameters:

annotation - the String annotation to be returned by the toString() method.

delegate - the GroundedAction delegate to be annotated.

Method Detail

actionName

public java.lang.String actionName()

Description copied from class: GroundedAction

Returns the action name for this grounded action.

Specified by:

actionName in interface AbstractGroundedAction

Overrides:

actionName in class GroundedAction

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

Overrides:

isParameterized in class GroundedAction

Returns:

true if this action uses parameters; false otherwise

initParamsWithStringRep

public void initParamsWithStringRep(java.lang.String[] params)

Description copied from interface: AbstractGroundedAction

Initializes the parameter values of this AbstractGroundedAction according to the provided string representation of their values.

Parameters:

params - an array in which each element is the string representation of one of this AbstractGroundedAction's values

getParametersAsString

public java.lang.String[] getParametersAsString()

Description copied from interface: AbstractGroundedAction

Returns an array of string representations of this AbstractGroundedAction's parameters

Returns:

an array of string representations of this AbstractGroundedAction's parameters

toString

public java.lang.String toString()

Overrides:

toString in class GroundedAction

applicableInState

public boolean applicableInState(State s)

Overrides:

applicableInState in class GroundedAction

copy

public GroundedAction copy()

Description copied from interface: AbstractGroundedAction

Returns a copy of this grounded action.

Specified by:

copy in interface AbstractGroundedAction

Specified by:

copy in class GroundedAction

Returns:

a copy of this grounded action.

executeIn

public EnvironmentOutcome executeIn(Environment env)

Description copied from class: GroundedAction

Executes this grounded action in the specified Environment.

Overrides:

executeIn in class GroundedAction

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)

Description copied from class: GroundedAction

Executes the grounded action on a given state

Overrides:

executeIn in class GroundedAction

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)

Description copied from class: GroundedAction

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.

Overrides:

getTransitions in class GroundedAction

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)

Description copied from class: GroundedAction

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.

Overrides:

translateParameters in class GroundedAction

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 GroundedAction

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class GroundedAction