burlap.oomdp.stochasticgames.agentactions

Class ObParamSGAgentAction

java.lang.Object

burlap.oomdp.stochasticgames.agentactions.SGAgentAction

burlap.oomdp.stochasticgames.agentactions.ObParamSGAgentAction

public abstract class ObParamSGAgentAction
extends SGAgentAction

If your SGAgentAction implementation is paramerterized to OO-MDP ObjectInstance references, you can subclass this SGAgentAction subclass to easily provide that functionality. The GroundedSGAgentAction instance associated with this action is ObParamSGAgentAction.GroundedObParamSGAgentAction, which implements the AbstractObjectParameterizedGroundedAction, since its parameters refer to OO-MDP ObjectInstance references.

The string array in the ObParamSGAgentAction(burlap.oomdp.stochasticgames.SGDomain, String, String[]) constructor specifies the valid type of ObjectClass to which the parameters must belong.

It may also be the case that the order of parameters for an ObjectParameterizedAction is unimportant. In this case, you can specify parameter order groups to indicate for which parameters the order is unimportant. See the ObjectParameterizedAction class documentation for more information of parameter order groups.

Author:

James MacGlashan.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ObParamSGAgentAction.GroundedObParamSGAgentAction

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String[]	parameterOrderGroups
java.lang.String[]	parameterTypes

Fields inherited from class burlap.oomdp.stochasticgames.agentactions.SGAgentAction

actionName, domain

Constructor Summary

Constructors

Constructor and Description
ObParamSGAgentAction(SGDomain d, java.lang.String name, java.lang.String[] parameterTypes) Initializes this single action to be for the given domain, with the given name, and with the given parameter class types.
ObParamSGAgentAction(SGDomain d, java.lang.String name, java.lang.String[] types, java.lang.String[] parameterOrderGroups) Initializes this single action to be for the given domain, with the given name, with the given parameter class types, and with the given parameter order groups.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<GroundedSGAgentAction>	getAllApplicableGroundedActions(State s, java.lang.String actingAgent) Returns all possible grounded versions of this single action for a given state and acting agent.
GroundedSGAgentAction	getAssociatedGroundedAction(java.lang.String actingAgent) Returns a GroundedSGAgentAction instance that is associated with this SGAgentAction for the provided acting agent, without any parameters set (if there are parameters to set).
boolean	isParameterized() Returns true if this action is parameterized.
abstract boolean	parametersAreObjectIdentifierIndependent()

Methods inherited from class burlap.oomdp.stochasticgames.agentactions.SGAgentAction

applicableInState, equals, getAllApplicableGroundedActionsFromActionList, hashCode

Methods inherited from class java.lang.Object

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

Field Detail

parameterTypes

public java.lang.String[] parameterTypes

parameterOrderGroups

public java.lang.String[] parameterOrderGroups

Constructor Detail

ObParamSGAgentAction

public ObParamSGAgentAction(SGDomain d,
                    java.lang.String name,
                    java.lang.String[] parameterTypes)

Initializes this single action to be for the given domain, with the given name, and with the given parameter class types. This action is automatically added to the given domain

Parameters:

d - the domain to which this action belongs

name - the name of this action

parameterTypes - the object class names for the possible parameters of this action.

ObParamSGAgentAction

public ObParamSGAgentAction(SGDomain d,
                    java.lang.String name,
                    java.lang.String[] types,
                    java.lang.String[] parameterOrderGroups)

Initializes this single action to be for the given domain, with the given name, with the given parameter class types, and with the given parameter order groups. This action is automatically added to the given domain

Parameters:

d - the domain to which this action belongs

name - the name of this action

types - the object class names for the possible parameters of this action.

parameterOrderGroups - the parameter order groups to use

Method Detail

isParameterized

public boolean isParameterized()

Description copied from class: SGAgentAction

Returns true if this action is parameterized.

Specified by:

isParameterized in class SGAgentAction

Returns:

true if this action is parameterized; false otherwise.

parametersAreObjectIdentifierIndependent

public abstract boolean parametersAreObjectIdentifierIndependent()

getAssociatedGroundedAction

public GroundedSGAgentAction getAssociatedGroundedAction(java.lang.String actingAgent)

Description copied from class: SGAgentAction

Returns a GroundedSGAgentAction instance that is associated with this SGAgentAction for the provided acting agent, without any parameters set (if there are parameters to set).

Specified by:

getAssociatedGroundedAction in class SGAgentAction

Parameters:

actingAgent - the name of the acting agent

Returns:

the GroundedSGAgentAction associated with this SGAgentAction.

getAllApplicableGroundedActions

public java.util.List<GroundedSGAgentAction> getAllApplicableGroundedActions(State s,
                                                                    java.lang.String actingAgent)

Description copied from class: SGAgentAction

Returns all possible grounded versions of this single action for a given state and acting agent.

Specified by:

getAllApplicableGroundedActions in class SGAgentAction

Parameters:

s - the state in which the agent would execute this action

actingAgent - the agent who would execute the action

Returns:

all possible grounded versions of this single action for a given state and acting agent.