burlap.oomdp.core.values

Class RelationalValue

java.lang.Object

burlap.oomdp.core.Value

burlap.oomdp.core.values.RelationalValue

public class RelationalValue
extends Value

A relational valued value subclass in which values are stored as a single String object for the name of the object instance to which it is linked. If the relational value is not linked to any object, then the String value is set to the empty String: "".

Author:

James MacGlashan

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	target A string representing the object target of this value.

Fields inherited from class burlap.oomdp.core.Value

attribute, isObservable

Constructor Summary

Constructors

Constructor and Description
RelationalValue(Attribute attribute) Initializes this value to be an assignment for Attribute attribute.
RelationalValue(Value v) Initializes this value as a copy from the source Value object v.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAllRelationalTargets(java.util.Collection<java.lang.String> targets)
void	addRelationalTarget(java.lang.String t) adds a relational target for the object instance named t
void	clearRelationTargets() Removes any relational targets for this attribute
Value	copy() Creates a deep copy of this value object.
boolean	equals(java.lang.Object obj)
java.util.Set<java.lang.String>	getAllRelationalTargets() Returns the ordered set of all relational targets of this object.
boolean	getBooleanValue() Returns the boolean value of this attibute.
int	getDiscVal() Returns the discrete integer value of this Value object
double[]	getDoubleArray() Returns a double array value
int[]	getIntArray() Returns an int array value
double	getNumericRepresentation() Returns a numeric double representation of this value.
double	getRealVal() Returns the real-valued double value of this Value object
java.lang.String	getStringVal() Returns the string value of this Value object
void	removeRelationalTarget(java.lang.String target) Removes a specific relational target from the relational value in relational attribute.
void	setValue(boolean v) Sets the internalvalue representation using a boolean value
void	setValue(double v) Sets the internal value representation using a double value
void	setValue(double[] doubleArray) Sets the double array value.
void	setValue(int v) Sets the internal value representation using an int value
void	setValue(int[] intArray) Sets the int array value.
void	setValue(java.lang.String v) Sets the internal value representation using a string value
boolean	valueHasBeenSet() Returns whether the value has been set to a meaningful value.

Methods inherited from class burlap.oomdp.core.Value

attName, getAttribute, isObservable, setObservability, toString

Methods inherited from class java.lang.Object

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

Field Detail

target

protected java.lang.String target

A string representing the object target of this value. Targets are specified by the object name identifier. If the relational target is unset, then this value will be set to the empty string "", which is the default value.

Constructor Detail

RelationalValue

public RelationalValue(Attribute attribute)

Initializes this value to be an assignment for Attribute attribute.

Parameters:

attribute -

RelationalValue

public RelationalValue(Value v)

Initializes this value as a copy from the source Value object v.

Parameters:

v - the source Value to make this object a copy of.

Method Detail

copy

public Value copy()

Description copied from class: Value

Creates a deep copy of this value object.

Specified by:

copy in class Value

Returns:

a deep copy of this value object.

valueHasBeenSet

public boolean valueHasBeenSet()

Description copied from class: Value

Returns whether the value has been set to a meaningful value. Unset values typically happen when a new object instance has been created by not had its values set. Leaving values unset will result in exceptions being thrown to prevent errors in underspecified states.

Specified by:

valueHasBeenSet in class Value

Returns:

true if the value has been set; false if not.

setValue

public void setValue(int v)

Description copied from class: Value

Sets the internal value representation using an int value

Specified by:

setValue in class Value

Parameters:

v - the int value assignment

setValue

public void setValue(double v)

Description copied from class: Value

Sets the internal value representation using a double value

Specified by:

setValue in class Value

Parameters:

v - the double value assignment

setValue

public void setValue(boolean v)

Description copied from class: Value

Sets the internalvalue representation using a boolean value

Specified by:

setValue in class Value

Parameters:

v - the boolean value

setValue

public void setValue(java.lang.String v)

Description copied from class: Value

Sets the internal value representation using a string value

Specified by:

setValue in class Value

Parameters:

v - the string value assignment

addRelationalTarget

public void addRelationalTarget(java.lang.String t)

Description copied from class: Value

adds a relational target for the object instance named t

Specified by:

addRelationalTarget in class Value

Parameters:

t - the name of the object instance target

addAllRelationalTargets

public void addAllRelationalTargets(java.util.Collection<java.lang.String> targets)

Specified by:

addAllRelationalTargets in class Value

clearRelationTargets

public void clearRelationTargets()

Description copied from class: Value

Removes any relational targets for this attribute

Specified by:

clearRelationTargets in class Value

removeRelationalTarget

public void removeRelationalTarget(java.lang.String target)

Description copied from class: Value

Removes a specific relational target from the relational value in relational attribute. If the relational attribute does not have this target specified, then nothing happens. This method is primarily useful for multi-target relational attributes, but if the attribute is a single-target relational attribute and its one currently set target is the one passed to this method, then this method will clear the attribute value.

Specified by:

removeRelationalTarget in class Value

Parameters:

target - the object name identifier to remove

getDiscVal

public int getDiscVal()

Description copied from class: Value

Returns the discrete integer value of this Value object

Specified by:

getDiscVal in class Value

Returns:

the discrete integer value of this Value object

getRealVal

public double getRealVal()

Description copied from class: Value

Returns the real-valued double value of this Value object

Specified by:

getRealVal in class Value

Returns:

the real-valued double value of this Value object

getAllRelationalTargets

public java.util.Set<java.lang.String> getAllRelationalTargets()

Description copied from class: Value

Returns the ordered set of all relational targets of this object. The set will be empty if the value is not set to any relational targets.

Specified by:

getAllRelationalTargets in class Value

Returns:

the ordered set of all relational targets of this object.

getStringVal

public java.lang.String getStringVal()

Description copied from class: Value

Returns the string value of this Value object

Specified by:

getStringVal in class Value

Returns:

the string value of this Value object

getNumericRepresentation

public double getNumericRepresentation()

Description copied from class: Value

Returns a numeric double representation of this value. If the value is discerete, the int will be type cast as a double.

Specified by:

getNumericRepresentation in class Value

Returns:

a numeric double representation of this value

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getBooleanValue

public boolean getBooleanValue()

Description copied from class: Value

Returns the boolean value of this attibute. For int values, this means 0 = false and all other values = true.

Specified by:

getBooleanValue in class Value

Returns:

the boolean value of this attribute.

setValue

public void setValue(int[] intArray)

Description copied from class: Value

Sets the int array value.

Specified by:

setValue in class Value

Parameters:

intArray - the int array value to set.

setValue

public void setValue(double[] doubleArray)

Description copied from class: Value

Sets the double array value.

Specified by:

setValue in class Value

Parameters:

doubleArray - the double array value to set.

getIntArray

public int[] getIntArray()

Description copied from class: Value

Returns an int array value

Specified by:

getIntArray in class Value

Returns:

an int array value

getDoubleArray

public double[] getDoubleArray()

Description copied from class: Value

Returns a double array value

Specified by:

getDoubleArray in class Value

Returns:

a double array value.