burlap.behavior.stochasticgames.agents.interfacing.singleagent

Class SGToSADomain.SAActionWrapper

java.lang.Object

burlap.oomdp.singleagent.Action

burlap.behavior.stochasticgames.agents.interfacing.singleagent.SGToSADomain.SAActionWrapper

Enclosing class:

SGToSADomain

public static class SGToSADomain.SAActionWrapper
extends Action

A single agent action wrapper for a stochastic game action. Calling this action will cause it to call the corresponding single interface to inform it of the action selection. The constructed action will have the same name and object parametrization specification as the source stochastic game SGAgentAction object.

Author:

James MacGlashan

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	agentName
SGAgentAction	srcAction

Fields inherited from class burlap.oomdp.singleagent.Action

actionObservers, domain, name

Constructor Summary

Constructors

Constructor and Description
SGToSADomain.SAActionWrapper(SGAgentAction srcAction, Domain domainWrapper) Initializes for a given stochastic games action.

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.
protected State	performActionHelper(State s, GroundedAction groundedAction) This method determines what happens when an action is applied in the given state with the given parameters.

Methods inherited from class burlap.oomdp.singleagent.Action

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

Methods inherited from class java.lang.Object

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

Field Detail

agentName

public java.lang.String agentName

srcAction

public SGAgentAction srcAction

Constructor Detail

SGToSADomain.SAActionWrapper

public SGToSADomain.SAActionWrapper(SGAgentAction srcAction,
                            Domain domainWrapper)

Initializes for a given stochastic games action.

Parameters:

srcAction - the source stochastic games SGAgentAction object.

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

performActionHelper

protected State performActionHelper(State s,
                        GroundedAction groundedAction)

Description copied from class: Action

This method determines what happens when an action is applied in the given state with the given parameters. The State object s may be directly modified in this method since the parent method (Action.performAction(burlap.oomdp.core.states.State, GroundedAction) first copies the input state to pass to this helper method. The resulting state (which may be s) should then be returned.

Specified by:

performActionHelper in class Action

Parameters:

s - the state to perform the action on

groundedAction - the GroundedAction specifying the parameters to use

Returns:

the resulting State from performing this action

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

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.