planner.aStarPlan

Class Condition

java.lang.Object

planner.aStarPlan.Condition

All Implemented Interfaces:

Cloneable

public class Condition
extends Object
implements Cloneable

Class representing one characteristic of a world state

Version:

$Revision: 1.7 $

Author:

dtdavis

Contact: Don Brutzman (web.nps.navy.mil/~brutzman) brutzman@nps.navy.mil

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	Condition.ParameterPair Class representing a single condition parameter name/value pair Names and values are case-independent (e.g., "VALUE" == "value")

Constructor Summary

Constructors

Constructor and Description
Condition(String name, boolean value) Creates a new instance of Condition

Method Summary

Methods

Modifier and Type	Method and Description
void	addParameter(Condition.ParameterPair newParam) Adds a parameter pair to the list of parameters if it doesn't already exist
void	addParameter(String paramName, String paramValue) Adds a parameter pair to the list of parameters if it doesn't already exist
Object	clone() Generates a (deep) copy of the condition
String	getName() Returns the name of the condition
protected Condition.ParameterPair	getParameter(int index) Returns a parameter pair from the parameter list (specified by index)
String	getParameterValue(String name) Returns the value of a parameter specified by name
boolean	getValue() Returns the truth value of the condition
boolean	hasParameter(Condition.ParameterPair testParameter) Returns true if the condition contains a parameter with a name/value pair
boolean	hasParameter(String testName, String testValue) Returns true if the condition contains a parameter with a name/value pair
boolean	match(Condition testCondition) Returns true if this Condition object has all of the same values as the parameter
Condition	negation() Generates a negation of the condition
int	numParameters() Returns the number of parameters that apply to this condition
String	toString() Converts the condition to a String

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Condition

public Condition(String name,
         boolean value)

Creates a new instance of Condition

Parameters:

name - String identifier.

value - value of this condition.

Method Detail

getName

public String getName()

Returns the name of the condition

Returns:

the name of the condition.

getValue

public boolean getValue()

Returns the truth value of the condition

Returns:

the truth value of the condition.

numParameters

public int numParameters()

Returns the number of parameters that apply to this condition

Returns:

number of parameters

getParameter

protected Condition.ParameterPair getParameter(int index)

Returns a parameter pair from the parameter list (specified by index)

Parameters:

index -

Returns:

Condition.ParameterPair

getParameterValue

public String getParameterValue(String name)

Returns the value of a parameter specified by name

Parameters:

name - the specified name of the parameter whose value is sought

Returns:

String value of the parameter

addParameter

public void addParameter(String paramName,
                String paramValue)

Adds a parameter pair to the list of parameters if it doesn't already exist

Parameters:

paramName - the specified name of the parameter to be added

paramValue - the specified value of the parameter to be added

addParameter

public void addParameter(Condition.ParameterPair newParam)

Adds a parameter pair to the list of parameters if it doesn't already exist

Parameters:

newParam -

hasParameter

public boolean hasParameter(String testName,
                   String testValue)

Returns true if the condition contains a parameter with a name/value pair

Parameters:

testName - name of the parameter being tested for

testValue - value of the parameter being tested for

Returns:

whether condition contains the parameter

hasParameter

public boolean hasParameter(Condition.ParameterPair testParameter)

Returns true if the condition contains a parameter with a name/value pair

Parameters:

testParameter - name and value of the parameter being tested for

Returns:

whether this condition contains testParameter name=value pair

negation

public Condition negation()

Generates a negation of the condition

Returns:

the negation of the condition.

clone

public Object clone()

Generates a (deep) copy of the condition

Overrides:

clone in class Object

Returns:

the deep copy of the condition.

match

public boolean match(Condition testCondition)

Returns true if this Condition object has all of the same values as the parameter

Parameters:

testCondition -

Returns:

whether this Condition contains the same values as the testCondition

toString

public String toString()

Converts the condition to a String

Overrides:

toString in class Object

Returns:

the result of append.