org.osid.mapping

Interface Heading

All Superinterfaces:

java.lang.Comparable<Heading>, Heading, OsidPrimitive, java.io.Serializable

public interface Heading
extends OsidPrimitive, Heading

A heading represents a direction.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	definesUncertainty() Tests if uncertainty is defined for this heading.
long	getDimensions() Gets the number of dimensions of motion.
Type	getHeadingType() Gets the Type of this Heading which indicates the format of the heading values.
java.math.BigDecimal[]	getUncertaintyMinus() Gets the uncertainty in the negtive direction for each value of this heading.
java.math.BigDecimal[]	getUncertaintyPlus() Gets the uncertainty in the positive direction for each value of this heading.
java.math.BigDecimal[]	getValues() Gets the values of this heading The size of the returned array is typically one less than getDimensions().

Methods inherited from interface org.osid.binding.java.Heading

compareTo, equals, getOuterBound, hashCode, isExclusive, isInclusive

Methods inherited from interface org.osid.binding.java.OsidPrimitive

toString

Method Detail

getHeadingType

Type getHeadingType()

Gets the Type of this Heading which indicates the format of the heading values.

Returns:

the coordinate type

Compliance:

mandatory - This method must be implemented.

getDimensions

long getDimensions()

Gets the number of dimensions of motion.

Returns:

the number of dimensions

Compliance:

mandatory - This method must be implemented.

getValues

java.math.BigDecimal[] getValues()

Gets the values of this heading The size of the returned array is typically one less than getDimensions().

Returns:

the heading values

Compliance:

mandatory - This method must be implemented.

definesUncertainty

boolean definesUncertainty()

Tests if uncertainty is defined for this heading.

Returns:

true if uncertainty is defined, false otherwise

Compliance:

mandatory - This method must be implemented.

getUncertaintyMinus

java.math.BigDecimal[] getUncertaintyMinus()

Gets the uncertainty in the negtive direction for each value of this heading. The size of the returned array is typically one less than getDimensions().

Returns:

the negative uncertainty values

Compliance:

mandatory - This method must be implemented.

getUncertaintyPlus

java.math.BigDecimal[] getUncertaintyPlus()

Gets the uncertainty in the positive direction for each value of this heading. The size of the returned array is typically one less than getDimensions().

Returns:

the positive uncertainty values

Compliance:

mandatory - This method must be implemented.