burlap.oomdp.core.values

Class OOMDPValue

java.lang.Object

burlap.oomdp.core.values.OOMDPValue

All Implemented Interfaces:

Value

Direct Known Subclasses:

DiscreteValue, DoubleArrayValue, IntArrayValue, IntValue, MultiTargetRelationalValue, RealValue, RelationalValue, StringValue

public abstract class OOMDPValue
extends java.lang.Object
implements Value

Field Summary

Fields

Modifier and Type	Field and Description
protected Attribute	attribute

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
Value	addAllRelationalTargets(java.util.Collection<java.lang.String> targets)
Value	addRelationalTarget(java.lang.String t) adds a relational target for the object instance named t
java.lang.String	attName() The name of the Attribute object for which this is a value assignment.
Value	clearRelationTargets() Removes any relational targets for this attribute
java.util.Set<java.lang.String>	getAllRelationalTargets() Returns the ordered set of all relational targets of this object.
Attribute	getAttribute() Returns the Attribute object for which this is a value assignment.
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 representation
double	getRealVal() Returns the real-valued double value of this Value object
java.lang.String	getStringVal() Returns the string value of this Value object
Value	removeRelationalTarget(java.lang.String target) Removes a specific relational target from the relational value in relational attribute.
Value	setValue(boolean v) Sets the internalvalue representation using a boolean value
Value	setValue(double v) Sets the internal value representation using a double value
Value	setValue(double[] doubleArray) Sets the double array value.
Value	setValue(int v) Sets the internal value representation using an int value
Value	setValue(int[] intArray) Sets the int array value.
Value	setValue(java.lang.String v) Sets the internal value representation using a string value
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface burlap.oomdp.core.values.Value

buildStringVal, copy, valueHasBeenSet

Field Detail

attribute

protected Attribute attribute

Constructor Detail

OOMDPValue

public OOMDPValue(Attribute attribute)

Initializes this value to be an assignment for Attribute attribute.

Parameters:

attribute -

OOMDPValue

public OOMDPValue(OOMDPValue v)

Initializes this value as a copy from the source Value object v. Should be overridden by subclasses for full copy support.

Parameters:

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

Method Detail

getAttribute

public Attribute getAttribute()

Returns the Attribute object for which this is a value assignment.

Specified by:

getAttribute in interface Value

Returns:

the Attribute object for which this is a value assignment.

attName

public java.lang.String attName()

The name of the Attribute object for which this is a value assignment.

Specified by:

attName in interface Value

Returns:

name of the Attribute object for which this is a value assignment.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getStringVal

public java.lang.String getStringVal()

Description copied from interface: Value

Returns the string value of this Value object

Specified by:

getStringVal in interface Value

Returns:

the string value of this Value object

getDiscVal

public int getDiscVal()

Returns the discrete integer value of this Value object

Specified by:

getDiscVal in interface Value

Returns:

the discrete integer value of this Value object

getRealVal

public double getRealVal()

Returns the real-valued double value of this Value object

Specified by:

getRealVal in interface Value

Returns:

the real-valued double value of this Value object

getAllRelationalTargets

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

Description copied from interface: 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 interface Value

Returns:

the ordered set of all relational targets of this object.

getBooleanValue

public boolean getBooleanValue()

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

Specified by:

getBooleanValue in interface Value

Returns:

the boolean value of this attribute.

getIntArray

public int[] getIntArray()

Returns an int array value

Specified by:

getIntArray in interface Value

Returns:

an int array value

getDoubleArray

public double[] getDoubleArray()

Returns a double array value

Specified by:

getDoubleArray in interface Value

Returns:

a double array value.

getNumericRepresentation

public double getNumericRepresentation()

Returns a numeric representation

Specified by:

getNumericRepresentation in interface Value

Returns:

a double value.

setValue

public Value setValue(int v)

Sets the internal value representation using an int value

Specified by:

setValue in interface Value

Parameters:

v - the int value assignment

setValue

public Value setValue(double v)

Sets the internal value representation using a double value

Specified by:

setValue in interface Value

Parameters:

v - the double value assignment

setValue

public Value setValue(java.lang.String v)

Sets the internal value representation using a string value

Specified by:

setValue in interface Value

Parameters:

v - the string value assignment

addRelationalTarget

public Value addRelationalTarget(java.lang.String t)

adds a relational target for the object instance named t

Specified by:

addRelationalTarget in interface Value

Parameters:

t - the name of the object instance target

addAllRelationalTargets

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

Specified by:

addAllRelationalTargets in interface Value

clearRelationTargets

public Value clearRelationTargets()

Removes any relational targets for this attribute

Specified by:

clearRelationTargets in interface Value

removeRelationalTarget

public Value removeRelationalTarget(java.lang.String target)

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 interface Value

Parameters:

target - the object name identifier to remove

setValue

public Value setValue(boolean v)

Sets the internalvalue representation using a boolean value

Specified by:

setValue in interface Value

Parameters:

v - the boolean value

setValue

public Value setValue(int[] intArray)

Sets the int array value.

Specified by:

setValue in interface Value

Parameters:

intArray - the int array value to set.

setValue

public Value setValue(double[] doubleArray)

Sets the double array value.

Specified by:

setValue in interface Value

Parameters:

doubleArray - the double array value to set.