burlap.oomdp.stochasticgames

Class GroundedSingleAction

java.lang.Object

burlap.oomdp.core.AbstractGroundedAction

burlap.oomdp.stochasticgames.GroundedSingleAction

public class GroundedSingleAction
extends AbstractGroundedAction

Provides a grounded version of a SingleAction. That is, since SingleAction objects may take parameters, this class provides a grounded version of the action that has specific objects bound to its parameters. Additionally, this class also specifies who the acting agent is.

Author:

James MacGlashan

Field Summary

Fields

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

Fields inherited from class burlap.oomdp.core.AbstractGroundedAction

params

Constructor Summary

Constructors

Constructor and Description
GroundedSingleAction(java.lang.String actingAgent, SingleAction a, java.lang.String p) Initializes this object with the name of the acting agent, the SingleAction reference, and the parameters used.
GroundedSingleAction(java.lang.String actingAgent, SingleAction a, java.lang.String[] p) 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
boolean	actionDomainIsObjectIdentifierDependent() Returns true if the domain to which this action belongs is object identifier dependent
java.lang.String	actionName() Returns the action name for this grounded action.
AbstractGroundedAction	copy() Returns a copy of this grounded action.
boolean	equals(java.lang.Object other)
State	executeIn(State s) Executes the grounded action on a given state
int	hashCode()
boolean	isExecutable() Returns true if this grounded action can be directly executed on a state with the AbstractGroundedAction.executeIn(State) method.
java.lang.String	justActionString() Returns a string specifying the action name and parameters used in this GroundedSingleAction.
boolean	parametersAreObjects() Returns true if all parameters (if any) for this action represent OO-MDP objects in a state; false otherwise.
java.lang.String	toString()

Methods inherited from class burlap.oomdp.core.AbstractGroundedAction

isParameterized, translateParameters

Methods inherited from class java.lang.Object

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

Field Detail

actingAgent

public java.lang.String actingAgent

The name of the agent performing the action

action

public SingleAction action

The single action the acting agent will be performing

Constructor Detail

GroundedSingleAction

public GroundedSingleAction(java.lang.String actingAgent,
                    SingleAction a,
                    java.lang.String[] p)

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

Parameters:

actingAgent - the acting agent.

a - the SingleAction.

p - a String array specifying the parameters bound to a.

GroundedSingleAction

public GroundedSingleAction(java.lang.String actingAgent,
                    SingleAction a,
                    java.lang.String p)

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

Parameters:

actingAgent - the acting agent.

a - the SingleAction.

p - a command delineated string specifying the parameters bound to a.

Method Detail

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 class: AbstractGroundedAction

Returns the action name for this grounded action.

Specified by:

actionName in class AbstractGroundedAction

Returns:

the action name for this grounded action.

isExecutable

public boolean isExecutable()

Description copied from class: AbstractGroundedAction

Returns true if this grounded action can be directly executed on a state with the AbstractGroundedAction.executeIn(State) method. For example, a single agent domain grounded action is executable; a stochastic games single grounded action is not, because the action of all other agents must also be known in order to get the next state.

Specified by:

isExecutable in class AbstractGroundedAction

Returns:

true if this grounded action can be directly executed on a state; false otherwise.

executeIn

public State executeIn(State s)

Description copied from class: AbstractGroundedAction

Executes the grounded action on a given state

Specified by:

executeIn in class AbstractGroundedAction

Parameters:

s - the state on which to execute the action

Returns:

The state after the action has been executed

actionDomainIsObjectIdentifierDependent

public boolean actionDomainIsObjectIdentifierDependent()

Description copied from class: AbstractGroundedAction

Returns true if the domain to which this action belongs is object identifier dependent

Specified by:

actionDomainIsObjectIdentifierDependent in class AbstractGroundedAction

Returns:

true if the domain to which this action belongs is object identifier dependent; false otherwise

copy

public AbstractGroundedAction copy()

Description copied from class: AbstractGroundedAction

Returns a copy of this grounded action.

Specified by:

copy in class AbstractGroundedAction

Returns:

a copy of this grounded action.

parametersAreObjects

public boolean parametersAreObjects()

Description copied from class: AbstractGroundedAction

Returns true if all parameters (if any) for this action represent OO-MDP objects in a state; false otherwise. This method will query the refenced action object to evaluate. (e.g., GroundedAction will query its referenced Action object; GroundedSingleAction will query its referenced SingleAction.

Specified by:

parametersAreObjects in class AbstractGroundedAction

Returns:

true if all parameters (if any) for this action represent OO-MDP objects in a state; false otherwise.