Interface Heading

All Superinterfaces:
Comparable<Heading>, Heading, OsidPrimitive, OsidPrimitive, Serializable
public interface Heading extends OsidPrimitive, Heading

A heading represents a direction.

  • Method Summary

    Modifier and Type
    Method
    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.
    BigDecimal[]
    getUncertaintyMinus()
    Gets the uncertainty in the negtive direction for each value of this heading.
    BigDecimal[]
    getUncertaintyPlus()
    Gets the uncertainty in the positive direction for each value of this heading.
    BigDecimal[]
    getValues()
    Gets the values of this heading The size of the returned array is typically one less than getDimensions() .

    Methods inherited from interface Heading

    compareTo, equals, getOuterBound, hashCode, isExclusive, isInclusive
    Modifier and Type
    Method
    Description
    int
    compareTo(Heading heading)
    Compares this heading with the specified Heading to determine the natural order.
    boolean
    equals(Object obj)
    Determines if the given Heading is equal to this one.
    Heading[]
    getOuterBound()
    Gets the outer bounds of the heading.
    int
    hashCode()
    Returns a hash code value for this Heading.
    boolean
    isExclusive(Heading heading)
    Tests if this Heading, as specified by its uncertainty, does not overlap the given Heading.
    boolean
    isInclusive(Heading heading)
    Tests if this Heading, as specified by its uncertainty, completely includes the given Heading ranged by its uncertainty.

    Methods inherited from interface OsidPrimitive

    toString
    Modifier and Type
    Method
    Description
    String
    toString()
    Returns a string representation of this OsidPrimitive.

  • Method Details

    • 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

      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

      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

      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.