burlap.oomdp.stochasticgames.agentactions

Class GroundedSGAgentAction

java.lang.Object

burlap.oomdp.stochasticgames.agentactions.GroundedSGAgentAction

All Implemented Interfaces:

AbstractGroundedAction

Direct Known Subclasses:

ObParamSGAgentAction.GroundedObParamSGAgentAction, SimpleGroundedSGAgentAction

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

A GroundedSGAgentAction is a high-level implementation of the AbstractGroundedAction that is closely associated with the SGAgentAction definition of actions that can be taken by agents in a multi-agent stochastic game. The role of a GroundedSGAgentAction is to provide a reference to a corresponding SGAgentAction, a reference to the name of the agent who is taking the action, and any other parameter assignment information that is necessary for the agent to apply the action. The set of possible GroundedSGAgentAction instances specifying the set of possible parameter assignments an action can apply will be generated by the associated SGAgentAction method SGAgentAction.getAllApplicableGroundedActions(burlap.oomdp.core.states.State, String). See the SGAgentAction class documentation for more information on defining parameterized SGAgentActions.

This high-level abstract class requires implementing a few methods:
copy(),
AbstractGroundedAction.initParamsWithStringRep(String[]) and,
AbstractGroundedAction.getParametersAsString().
The copy() method should be override to return a new instance of your subclass with all parameter assignment information copied over. The latter two methods are necessary for supporting all of the BURLAP's tools with parameterized actions, but may not be needed for critical operations. The AbstractGroundedAction.initParamsWithStringRep(String[]) allows the parameters of an action to be initialized from a string representation. The AbstractGroundedAction.getParametersAsString() method gets a string representation of the parameters. If your action is not parameterized, then you can simply use the SimpleGroundedSGAgentAction implementation.

If you plan on making an SGAgentAction definition with OO-MDP object parameters, you can use the existing ObParamSGAgentAction, which is associated with the GroundedAction subclass ObParamSGAgentAction.GroundedObParamSGAgentAction.

Author:

James MacGlashan

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	actingAgent The name of the agent performing the action
SGAgentAction	action The single action the acting agent will be performing

Constructor Summary

Constructors

Constructor and Description
GroundedSGAgentAction(java.lang.String actingAgent, SGAgentAction a) Initializes this object with the name of the acting agent, the SingleAction reference, and the parameters used.

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) Returns whether this action is applicable (satisfies the preconditions) in the given input State
abstract GroundedSGAgentAction	copy() Returns a copy of this grounded action.
boolean	equals(java.lang.Object other)
int	hashCode()
boolean	isParameterized() Returns true if this action uses parameters
java.lang.String	justActionString() Returns a string specifying the action name and parameters used in this GroundedSingleAction.
java.lang.String	toString()

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

actingAgent

public java.lang.String actingAgent

The name of the agent performing the action

action

public SGAgentAction action

The single action the acting agent will be performing

Constructor Detail

GroundedSGAgentAction

public GroundedSGAgentAction(java.lang.String actingAgent,
                     SGAgentAction a)

Initializes this object with the name of the acting agent, the SingleAction reference, and the parameters used.

Parameters:

actingAgent - the acting agent.

a - the SGAgentAction.

Method Detail

applicableInState

public boolean applicableInState(State s)

Returns whether this action is applicable (satisfies the preconditions) in the given input State

Parameters:

s - the input state to check against

Returns:

true if this action is applicable (satisfies the preconditions) in the given input State; false otherwise

justActionString

public java.lang.String justActionString()

Returns a string specifying the action name and parameters used in this GroundedSingleAction.

Returns:

a string specifying the action name and parameters used in this GroundedSingleAction.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

actionName

public java.lang.String actionName()

Description copied from interface: AbstractGroundedAction

Returns the action name for this grounded action.

Specified by:

actionName in interface AbstractGroundedAction

Returns:

the action name for this grounded action.

copy

public abstract GroundedSGAgentAction 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.

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